Skip to content

Commit 096c12c

Browse files
committed
[WIP] Document Journald on docker
1 parent 25b9fb3 commit 096c12c

File tree

6 files changed

+27
-2
lines changed

6 files changed

+27
-2
lines changed

packages/journald/changelog.yml

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# newer versions go on top
22
- version: "1.1.2"
3+
changes:
4+
- description: Update documentation to mention the requirements for reading Journald logs.
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/99999
37
changes:
48
- description: Update Kibana requirement to support 9.x.
59
type: enhancement

packages/journald/docs/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ The journald input reads the log data and the metadata associated with it.
55

66
The journald input is available on Linux systems with `systemd` installed.
77

8+
To read Journald logs from within a container, you need to use the
9+
[`elastic-agent-complete`](https://www.elastic.co/docs/reference/fleet/install-elastic-agents#elastic-agent-complete-flavor)
10+
Docker image that contains the `jouranlctl` binary. Journal files can have breaking changes making it
11+
impossible to read files generated by a newer versions of
12+
Journald. Ensure the jounral files you are reading were generated by
13+
a version equal or older than the `journalctl` shipped with the Docker
14+
image.x
15+
816
An example event looks as follows:
917

1018
```json

packages/journald/manifest.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
format_version: 3.3.0
22
name: journald
33
title: "Custom Journald logs"
4-
version: 1.1.2
4+
version: 1.1.3
55
description: Collect logs from journald with Elastic Agent.
66
type: input
77
categories:

packages/system/changelog.yml

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# newer versions go on top
2+
- version: "1.68.2"
3+
changes:
4+
- description: Update documentation to mention the requirements for reading Journald logs.
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/99999
27
- version: "1.68.1"
38
changes:
49
- description: Change security pipeline to be defensive against different data types.

packages/system/docs/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Each data stream collects different kinds of metric data, which may require dedi
3838
to be fetched and which may vary across operating systems.
3939
Details on the permissions needed for each data stream are available in the [Metrics reference](#metrics-reference).
4040

41+
To read Journald logs from within a container, you need to use the
42+
[`elastic-agent-complete`](https://www.elastic.co/docs/reference/fleet/install-elastic-agents#elastic-agent-complete-flavor)
43+
Docker image that contains the `jouranlctl` binary. Journal files can have breaking changes making it
44+
impossible to read files generated by a newer versions of
45+
Journald. Ensure the jounral files you are reading were generated by
46+
a version equal or older than the `journalctl` shipped with the Docker
47+
image.
48+
4149
## Setup
4250

4351
For step-by-step instructions on how to set up an integration, see the

packages/system/manifest.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
format_version: 3.0.2
22
name: system
33
title: System
4-
version: "1.68.1"
4+
version: "1.68.2"
55
description: Collect system logs and metrics from your servers with Elastic Agent.
66
type: integration
77
categories:

0 commit comments

Comments
 (0)