Consolidate documentation around fingerprint file identity in the Filestream output #42264
Labels
docs
Filebeat
Filebeat
Team:Docs
Label for the Observability docs team
Team:Elastic-Agent-Data-Plane
Label for the Agent Data Plane team
Describe the enhancement:
We switched to the fingerprint-based file identity in Filestream by default (see #40197) we now should improve the documentation around it.
Prior the new default, due to the nature of the implementation, it required to set multiple parameters in 2 separate config sections to enable the fingerprint-based file identity:
prospector.scanner.fingerprint
https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-filestream.html#filebeat-input-filestream-scan-fingerprintfile_identity
https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-filestream.html#_file_identity_2Currently the documentation is scattered between these 2 sections, which is far from ideal.
A consolidated documentation section would be a better solution, it should cover:
length
of the fingerprint header is1024 bytes
and the defaultoffset
is0
– both are configurablelength
makes the identity less reliable (more likelihood of a collision)offset+length
in size will not be ingested until it grows larger in size to cross this threshold.The text was updated successfully, but these errors were encountered: