Custom Logs Package

Version	2.3.3 (View all)
Compatible Kibana version(s)	8.8.0 or higher
Supported Serverless project types What’s this?	Security Observability
Subscription level What’s this?	Basic
Level of support What’s this?	Elastic

The Custom Logs package is used to ingest arbitrary log files and parse their contents using Ingest Pipelines. Follow the steps below to set up and use this package.

Get started

edit

Install Elastic Agent Install an Elastic Agent on the machine from which you want to collect logs.
Identify the Log Location Identify the log location on that machine, for example, /tmp/custom.log.
- If you need to include multiple log files or an entire directory, consider using wildcard patterns such as /tmp/*.log to capture all .log files, or /tmp/* to include all file types.
- Note that the System integration ingests /var/log/*.log. You do not need to add this path if the System integration is in use.
Enroll the Custom Logs Integration
- Add the Custom Logs integration to your installed Elastic Agent.
- Provide an Integration name. A descriptive name will make managing this integration in the Kibana UI more intuitive.
- Configure the path to match the location(s) identified in the previous step.
- Provide a dataset name that reflects the purpose of your logs (for example, python for Python application logs).
Verify Data in Discover
- Open Discover in Kibana and filter the logs-* indices to your dataset name (e.g., logs-python) to confirm that the raw log data is being ingested.
Configure Parsing Rules
- Use Ingest Pipelines to define parsing rules.
- See Parse and route logs for examples of how to extract structured fields and reroute log data to specific data streams.
Create a Custom Dashboard
- Use Kibana to build a dashboard for analyzing incoming log data based on your specific needs.

ECS Field Mapping

edit

This integration includes an ECS Dynamic Template, so any fields following the ECS schema will automatically receive the correct index field mappings without additional manual configuration.

Changelog

edit

Changelog

Version	Details	Kibana version(s)
2.3.3	Enhancement (View pull request) Update documentation	8.8.0 or higher
2.3.2	Enhancement (View pull request) Update package spec to V3	8.8.0 or higher
2.3.1	Enhancement (View pull request) Enhance description of custom option	8.8.0 or higher
2.3.0	Enhancement (View pull request) Expose exclude_files option	8.8.0 or higher
2.2.0	Enhancement (View pull request) Expose ignore_older option	8.8.0 or higher
2.1.0	Enhancement (View pull request) Add mapping for message field	8.8.0 or higher
2.0.0	Enhancement (View pull request) Change from type "integration" to "input"	8.8.0 or higher
1.1.2	Enhancement (View pull request) Added categories and/or subcategories.	—
1.1.1	Enhancement (View pull request) Improve documentation	—
1.1.0	Enhancement (View pull request) Add custom logs and processors	—
1.0.0	Enhancement (View pull request) Release Custom Logs as GA	—
0.5.1	Enhancement (View pull request) Uniform with guidelines	—
0.5.0	Enhancement (View pull request) Update integration description	—
0.4.6	Enhancement (View pull request) Updating package owner	—
0.1.0	Enhancement (View pull request) initial release	—

« Living off the Land Attack Detection Lumos Integration »