Update README.md
Costa Tsaousis committed
Oct 6, 2023 at 01:16 UTC
4b95ff26bc62e6ec85340ea6dc787d8ae0ab743f
1 file changed
+8
-8
collectors/systemd-journal.plugin/README.md
+8
-8
@@ -1,10 +1,10 @@
1
-# SystemD Journal
1
+# `systemd` journal plugin
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
7
-The SystemD Journal plugin by Netdata makes viewing, exploring and analyzing systemd journal logs simple and efficient.
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
10
journal centralization servers.
@@ -68,7 +68,7 @@ The plugin allows viewing, exploring and querying the journal files of all users
68
### `namespaces` journals
69
70
Journal 'namespaces' are both a mechanism for logically isolating the log stream of projects consisting
71
-of one or more services from the rest of the system and a mechanism for improving performance. Systemd service
71
+of one or more services from the rest of the system and a mechanism for improving performance. `systemd` service
72
units may be assigned to a specific journal namespace through the `LogNamespace=` unit file setting.
73
74
The plugin auto-detects the namespaces available and provides a list of all namespaces at the "sources" list on the UI.
@@ -224,7 +224,7 @@ This Netdata plugin does not require any configuration or maintenance.
224
225
### Can I use this plugin on journals' centralization servers?
226
227
-Yes. You can centralize your logs using systemd journal, and then install Netdata
227
+Yes. You can centralize your logs using `systemd-journal-remote`, and then install Netdata
228
on this logs centralization server to explore the logs of all your infrastructure.
229
230
This plugin will automatically provide multi-node views of your logs and also give you the ability to combine the logs
@@ -255,7 +255,7 @@ anywhere. All communication from/to Netdata Cloud is encrypted.
255
256
### What are `volatile` and `persistent` journals?
257
258
-SystemD JournalD allows creating both `volatile` journals in a `tmpfs` ram drive,
258
+`systemd` `journald` allows creating both `volatile` journals in a `tmpfs` ram drive,
259
and `persistent` journals stored on disk.
260
261
`volatile` journals are particularly useful when the system monitored is sensitive to
@@ -263,11 +263,11 @@ disk I/O, or does not have any writable disks at all.
263
264
For more information check `man systemd-journald`.
265
266
-### Is it worth to build a systemd logs centralization server?
266
+### Is it worth to build a `systemd` logs centralization server?
267
268
Yes. It is simple, fast and the software to do it is already in your systems.
269
270
-For application and system logs, systemd journal is ideal and the visibility you can get
270
+For application and system logs, `systemd` journal is ideal and the visibility you can get
271
by centralizing your system logs and the use of this Netdata plugin, is unparalleled.
272
273
### How do I configure a journals' centralization server?
@@ -356,7 +356,7 @@ Keep in mind that immediately after starting `systemd-journal-upload` on a serve
356
357
#### Limitations when using a logs centralization server
358
359
-As of this writing `namespaces` support by systemd is limited:
359
+As of this writing `namespaces` support by `systemd` is limited:
360
361
- Docker containers cannot log to namespaces. Check [this issue](https://github.com/moby/moby/issues/41879).
362
- `systemd-journal-upload` automatically uploads `system` and `user` journals, but not `namespaces` journals. For this you need to spawn a `systemd-journal-upload` per namespace.