Type to search.

Custom Logs (Filestream) Package

Serverless Observability

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Serverless Security

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Stack 9.4+

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available since 9.4

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Version 2.5.1 (View all)
Subscription level
What's this?
Basic
Developed by
What's this?
Elastic
Minimum Kibana version(s) 9.4.0
Warning

Migrating from the "Custom Logs (Deprecated)" to "Custom Logs (Filestream)" will cause files to be re-ingested because the state is not migrated.

Important

The Filestream integration will only start ingesting files when they are 1024 bytes in size or larger. This can be adjusted by setting "Fingerprint length", however it will influence how files are identified. Refer to the fingerprint documentation for more details.

In future releases it's expected to have an automated way to migrate the state. However, this is not possible at the moment.

The current best option for minimizing the data duplication while migrating to "Custom Logs (Filestream)" is to use the 'Ignore Older' or 'Exclude Files' options.

The filestream custom input is used to read lines from active log files. It is the new, improved alternative to the log input. It comes with various improvements to the existing input:

  1. Checking of close_* options happens out of band. Thus, if an output is blocked, Elastic Agent can close the reader and avoid keeping too many files open.

  2. The order of parsers is configurable. So it is possible to parse JSON lines and then aggregate the contents into a multiline event.

  3. Some position updates and metadata changes no longer depend on the publishing pipeline. If the pipeline is blocked some changes are still applied to the registry.

  4. Only the most recent updates are serialized to the registry. In contrast, the log input has to serialize the complete registry on each ACK from the outputs. This makes the registry updates much quicker with this input.

  5. The input ensures that only offsets updates are written to the registry append only log. The log writes the complete file state.

  6. Stale entries can be removed from the registry, even if there is no active input.

  7. The fingerprint file identity is used by default.

More information can be found on the Filestream documentation page

As Filestream configures a new input, configuring it to collect data from a file that was previously collected by Custom Logs integration will result in duplicate data. You may wish to configure ignore_older or temporarily set ignore_inactive: since_first_start to limit the amount of duplicate data collected.

If the Custom Logs integration is removed and the Custom Filestream Logs is added in the same policy change, there risk of data being missed between the last entry ingested by the Custom Logs and the first one ingested by the Custom Filestream Logs.

Changelog
Version Details Minimum Kibana version
2.5.1 Bug fix (View pull request)
Render filestream boolean options with true defaults.
9.4.0
2.5.0 Bug fix (View pull request)
Map log.offset as long.
9.4.0
2.4.0 Enhancement (View pull request)
Use the logs.ecs index instead of logs when "Use logs data stream" is enabled.
9.4.0
2.3.3 Bug fix (View pull request)
Remove duplicated ECS mappings from package template
9.2.0
2.3.2 Enhancement (View pull request)
Include on "Decompress GZIP files" description it's GA on 9.3.0.
9.2.0
2.3.1 Enhancement (View pull request)
Adjust GZIP decompression docs
9.2.0
2.3.0 Enhancement (View pull request)
Promote GZIP decompression to GA
9.2.0
2.2.0 Enhancement (View pull request)
Add support for removing files after ingestion
9.2.0
2.1.2 Bug fix (View pull request)
Ignore "Ingest Pipeline" when "Use Logs Stream" is set
9.2.0
2.1.1 Enhancement (View pull request)
Improve documentation for the "Use the logs data stream" option.
9.2.0
2.1.0 Enhancement (View pull request)
Allow filestream to be configured to ingest GZIP files
9.2.0
2.0.1 Bug fix (View pull request)
Remove hard-coded dataset field
9.2.0
2.0.0 Enhancement (View pull request)
Migrate to input package type
—
1.3.0 Enhancement (View pull request)
Add logs stream support
9.2.0
1.2.0 Bug fix (View pull request)
Add the native file identity
9.0.0
8.15.0
1.1.5 Bug fix (View pull request)
Fix file identity options not getting applied correctly
9.0.0
8.15.0
1.1.4 Enhancement (View pull request)
Add warning about only ingesting files >= 1024 bytes
9.0.0
8.15.0
1.1.3 Enhancement (View pull request)
Correct the readme
9.0.0
8.15.0
1.1.2 Enhancement (View pull request)
Add warning about migration from "Custom Logs (Legacy)" to
"Custom Logs (Filestream"
9.0.0
8.15.0
1.1.1 Enhancement (View pull request)
Rename the package
9.0.0
8.15.0
1.1.0 Enhancement (View pull request)
Add support for defining Conditions
9.0.0
8.15.0
1.0.1 Bug fix (View pull request)
Resolving conflicts with past integration versions.
9.0.0
8.15.0
1.0.0 Enhancement (View pull request)
Make it GA
—
0.1.0 Enhancement (View pull request)
Make it available in 9.0
9.0.0
8.15.0
0.0.1 Enhancement (View pull request)
Initial Release
8.15.0