Skip to content

Commit 49b00c9

Browse files
authored
Improve Custom Logs documentation (#5153)
Now it describes detailed steps how to set it up.
1 parent bf445ef commit 49b00c9

File tree

3 files changed

+17
-3
lines changed

3 files changed

+17
-3
lines changed

packages/log/changelog.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# newer versions go on top
2+
- version: "1.1.1"
3+
changes:
4+
- description: Improve documentation
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/5153
27
- version: "1.1.0"
38
changes:
49
- description: Add custom logs and processors

packages/log/docs/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1-
# Log Package
1+
# Custom Logs Package
22

3-
The log package is used as a generic package based on which any log file can be tailed by adjusting the ingest pipeline.
3+
The Custom Logs package is used for ingesting arbitrary log files and manipulating their content/lines by using Ingest Pipelines configuration.
4+
5+
In order to use the package, please follow these steps:
6+
7+
1. [Setup / Install Elastic Agent](https://www.elastic.co/guide/en/fleet/current/install-fleet-managed-elastic-agent.html) at the machine where the logs should be collected from
8+
2. Identify the log location at that machine e.g. `/tmp/custom.log`. Note that `/var/log/*.log` is fully ingested by the [System](https://docs.elastic.co/en/integrations/system), no need to add this path if the [System](https://docs.elastic.co/en/integrations/system) integration is already used
9+
3. Enroll Custom Logs integration and add it to the installed agent. Give the dataset a name that fits to the log purpose, e.g. `python` for logs from a Python app. Make sure to configure the path from the step 2
10+
4. Check that the raw log data is coming in via [Discover](https://www.elastic.co/guide/en/kibana/current/discover.html) by filtering the `logs-*` indices to the dataset name given in step 3, e.g. `logs-python`
11+
5. Configure the parsing rules via [Ingest Pipelines](https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html), e.g. JSON Parsing or [grok](https://www.elastic.co/blog/slow-and-steady-how-to-build-custom-grok-patterns-incrementally) parsing
12+
6. Create a [custom dashboard](https://www.elastic.co/guide/en/kibana/current/create-a-dashboard-of-panels-with-web-server-data.html) that analyzes the incoming log data for your needs

packages/log/manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Custom Logs
44
description: >-
55
Collect custom logs with Elastic Agent.
66
type: integration
7-
version: 1.1.0
7+
version: 1.1.1
88
release: ga
99
license: basic
1010
categories:

0 commit comments

Comments
 (0)