Fix systemd-journal.plugin README and prepare it for Learn (#16096)
Fotis Voutsas committed
Oct 3, 2023 at 13:16 UTC
20767d9cd26b48c4187695b7d4ed5dee97628401
1 file changed
+4
-13
collectors/systemd-journal.plugin/README.md
+4
-13
@@ -1,18 +1,9 @@
1
-<!--
2
-title: "SystemD-Journal"
3
-description: "View and analyze logs available in systemd journal"
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/systemd-journal.plugin/README.md"
5
-sidebar_label: "SystemD-Journal"
6
-learn_status: "Published"
7
-learn_rel_path: "Integrations/Logs"
8
--->
1
+# SystemD Journal
2
3
[KEY FEATURES](#key-features) | [JOURNAL SOURCES](#journal-sources) | [JOURNAL FIELDS](#journal-fields) |
4
[PLAY MODE](#play-mode) | [FULL TEXT SEARCH](#full-text-search) | [PERFORMANCE](#query-performance) |
5
[CONFIGURATION](#configuration-and-maintenance) | [FAQ](#faq)
6
14
-# SystemD Journal
15
-
7
The SystemD Journal plugin by Netdata makes viewing, exploring and analyzing systemd journal logs simple and efficient.
8
It automatically discovers available journal sources, allows advanced filtering, offers interactive visual
9
representations and supports exploring the logs of both individual servers and the logs on infrastructure wide
@@ -20,7 +11,7 @@ journal centralization servers.
11
12
13
23
-## Key features:
14
+## Key features
15
16
- Works on both **individual servers** and **journal centralization servers**.
17
- Supports `persistent` and `volatile` journals.
@@ -38,7 +29,7 @@ journal centralization servers.
29
30
To protect your privacy, as with all Netdata Functions, a free Netdata Cloud user account is required to access it.
31
41
-### Limitations:
32
+### Limitations
33
34
- This plugin is not available when Netdata is installed in a container. The problem is that `libsystemd` is not available in Alpine Linux (there is a `libsystemd`, but it is a dummy that returns failure on all calls). We plan to change this, by shipping Netdata containers based on Debian.
35
- For the same reason (lack of `systemd` support for Alpine Linux), the plugin is not available on `static` builds of Netdata (which are based on `muslc`, not `glibc`).
@@ -111,7 +102,7 @@ The plugin automatically enriches certain fields to make them more user-friendly
102
103
The values of all other fields are presented as found in the journals.
104
114
-> IMPORTANT:</br>
105
+> IMPORTANT:
106
> `_UID` `_AUDIT_LOGINUID`, `_SYSTEMD_OWNER_UID` and `_GID` annotations are added during presentation and are taken
107
> from the server running the plugin. For `remote` sources, the names presented may not reflect the actual user and
108
> group names on the origin server.