Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Collecting Metrics/Collecting Metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ This section outlines the required privileges and how they are configured in dif
|------------------------|-------------------------------------------------|-----------------------------------------------------|
| apps.plugin | CAP_DAC_READ_SEARCH, CAP_SYS_PTRACE | setuid root |
| debugfs.plugin | CAP_DAC_READ_SEARCH | setuid root |
| systemd-journal.plugin | CAP_DAC_READ_SEARCH | setuid root |
| perf.plugin | CAP_PERFMON | setuid root |
| slabinfo.plugin | CAP_DAC_READ_SEARCH | setuid root |
| go.d.plugin | CAP_DAC_READ_SEARCH, CAP_NET_ADMIN, CAP_NET_RAW | setuid root |
Expand Down
16 changes: 8 additions & 8 deletions docs/Dashboards and Charts/Tabs/Logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ slug: "/dashboards-and-charts/tabs/logs"

# Logs tab

The Logs tab is using the [`journal-viewer` plugin](/docs/logs/systemd-journal-logs/journal-viewer-plugin), to present a structured view into your infrastructure's `systemd` logs.
The Logs tab is using the [`systemd` journal plugin](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference), to present a structured view into your infrastructure's `systemd` logs.

We have a thorough section explaining how you can [work with logs](https://learn.netdata.cloud/docs/logs), detailing how the plugin works, and what other utilities are used under the hood to provide you with the visualizations and the log entries.

The [`journal-viewer` plugin](/docs/logs/systemd-journal-logs/journal-viewer-plugin) documentation has information about:
The [`systemd` journal plugin](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference) documentation has information about:

- [Key features the plugin provides](/docs/logs/systemd-journal-logs/journal-viewer-plugin#key-features)
- [Journal sources](/docs/logs/systemd-journal-logs/journal-viewer-plugin#journal-sources)
- [Journal fields](/docs/logs/systemd-journal-logs/journal-viewer-plugin#journal-fields)
- [Full-text search](/docs/logs/systemd-journal-logs/journal-viewer-plugin#full-text-search)
- [Query performance](/docs/logs/systemd-journal-logs/journal-viewer-plugin#query-performance)
- [Performance at scale](/docs/logs/systemd-journal-logs/journal-viewer-plugin#performance-at-scale)
- [Key features the plugin provides](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference#key-features)
- [Journal sources](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference#journal-sources)
- [Journal fields](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference#journal-fields)
- [Full-text search](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference#full-text-search)
- [Query performance](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference#query-performance)
- [Performance at scale](/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference#performance-at-scale)

We recommend you to read through that document, to better understand how the plugin and the visualizations work.
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,13 @@ The health module manages alert definitions through DynCfg:
</details>

<details>
<summary><strong>journal-viewer-plugin (External Plugin, Rust)</strong></summary><br/>
<summary><strong>systemd-journal.plugin (External Plugin, C)</strong></summary><br/>

External Rust plugin that provides systemd journal log viewing and analysis:
External C plugin that manages journal directory configurations:

- **Location**: `src/crates/netdata-log-viewer/journal-viewer-plugin/`
- **Use Case**: Viewing and analyzing systemd journal logs
- **File**: `src/collectors/systemd-journal.plugin/systemd-journal-dyncfg.c`
- **Pattern**: SINGLE configuration type
- **Use Case**: Managing journal directory paths

<br/>
</details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/logs/active_journal_centralization_guide_no_encryption.md"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/systemd-journal.plugin/active_journal_centralization_guide_no_encryption.md"
sidebar_label: "Active journal source without encryption"
learn_status: "Published"
learn_rel_path: "Logs/Logs Centralization Points with systemd-journald"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This means that if both certificates are issued by the same certificate authorit

## Self-signed certificates

To simplify the process of creating and managing self-signed certificates, we have created [this bash script](https://github.com/netdata/netdata/blob/master/docs/logs/systemd-journal-self-signed-certs.sh).
To simplify the process of creating and managing self-signed certificates, we have created [this bash script](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/systemd-journal-self-signed-certs.sh).

This helps to also automate the distribution of the certificates to your servers (it generates a new bash script for each of your servers, which includes everything required, including the certificates).

Expand All @@ -44,7 +44,7 @@ On the server that will issue the certificates (usually the centralization serve
sudo apt-get install systemd-journal-remote openssl

# download the script and make it executable
curl >systemd-journal-self-signed-certs.sh "https://raw.githubusercontent.com/netdata/netdata/master/docs/logs/systemd-journal-self-signed-certs.sh"
curl >systemd-journal-self-signed-certs.sh "https://raw.githubusercontent.com/netdata/netdata/master/src/collectors/systemd-journal.plugin/systemd-journal-self-signed-certs.sh"
chmod 750 systemd-journal-self-signed-certs.sh
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/logs/forward_secure_sealing.md"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/systemd-journal.plugin/forward_secure_sealing.md"
sidebar_label: "Forward Secure Sealing (FSS) in Systemd-Journal"
learn_status: "Published"
learn_rel_path: "Logs/Systemd Journal Logs"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/logs/README.md"
sidebar_label: "Journal Viewer Plugin"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/systemd-journal.plugin/README.md"
sidebar_label: "Systemd Journal Plugin Reference"
learn_status: "Published"
learn_rel_path: "Logs/Systemd Journal Logs"
description: "View and analyze logs available in systemd journal"
sidebar_position: "1204000"
learn_link: "https://learn.netdata.cloud/docs/logs/systemd-journal-logs/journal-viewer-plugin"
slug: "/logs/systemd-journal-logs/journal-viewer-plugin"
learn_link: "https://learn.netdata.cloud/docs/logs/systemd-journal-logs/systemd-journal-plugin-reference"
slug: "/logs/systemd-journal-logs/systemd-journal-plugin-reference"
---

# `journal-viewer` plugin
# `systemd` journal plugin

[KEY FEATURES](#key-features) | [PREREQUISITES](#prerequisites) | [JOURNAL SOURCES](#journal-sources) | [JOURNAL FIELDS](#journal-fields) | [VISUALIZATION](#visualization-capabilities) | [PLAY MODE](#play-mode) | [FULL TEXT SEARCH](#full-text-search) | [QUERY PERFORMANCE](#query-performance) | [PERFORMANCE AT SCALE](#performance-at-scale) | [BEST PRACTICES](#best-practices-for-better-performance) | [CONFIGURATION](#configuration-and-maintenance) | [FAQ](#faq) | [HOW TO TROUBLESHOOT COMMON ISSUES](#how-to-troubleshoot-common-issues) | [HOW TO VERIFY SETUP](#how-to-verify-setup)

The `journal-viewer` plugin provides an efficient way to view, explore, and analyze `systemd` journal logs directly from the Netdata dashboard. It combines powerful filtering, real-time updates, and visual analysis tools to help you troubleshoot system issues effectively.
The `systemd` journal plugin provides an efficient way to view, explore, and analyze `systemd` journal logs directly from the Netdata dashboard. It combines powerful filtering, real-time updates, and visual analysis tools to help you troubleshoot system issues effectively.

![Netdata systemd journal plugin interface](https://github.com/netdata/netdata/assets/2662304/691b7470-ec56-430c-8b81-0c9e49012679)

Expand Down Expand Up @@ -555,7 +555,7 @@ Sampling ensures responsiveness at scale, but selecting sources and filters rema

| Error Message | Meaning | Solution |
|--------------|---------|----------|
| "Plugin not available" | The journal-viewer plugin isn't loaded | Check your Netdata installation type (must not be Alpine or static) |
| "Plugin not available" | The systemd-journal plugin isn't loaded | Check your Netdata installation type (must not be Alpine or static) |
| "Unable to open journal" | Permission issues accessing journal files | Ensure Netdata has proper permissions for journal directories |
| "Timeout while querying" | Query is taking too long to complete | Reduce the query scope with filters or shorter timeframes |
| "No sources detected" | Cannot find valid journal files | Check journal file locations and setup |
Expand All @@ -569,7 +569,7 @@ Sampling ensures responsiveness at scale, but selecting sources and filters rema
sudo netdata -W plugins
```

Check that the `journal-viewer-plugin` is listed as active.
Check that the `systemd-journal` plugin is listed as active.

### How to confirm journal sources are detected

Expand Down
6 changes: 3 additions & 3 deletions docs/Netdata Agent/Installation/Docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ The Netdata container requires specific **privileges** and **mounts** to provide
| go.d.plugin | /var/log | Web servers logs tailing. See [weblog](https://github.com/netdata/go.d.plugin/tree/master/modules/weblog#readme) collector. |
| apps.plugin | /etc/passwd, /etc/group | Monitoring of host system resource usage by each user and user group. |
| proc.plugin | /proc | Host system monitoring (CPU, memory, network interfaces, disks, etc.). |
| journal-viewer-plugin | /var/log | Viewing, exploring and analyzing systemd journal logs. |
| systemd-units.plugin | /run/dbus | Systemd-list-units function: information about all systemd units, including their active state, description, whether they are enabled, and more. |
| systemd-journal.plugin | /var/log | Viewing, exploring and analyzing systemd journal logs. |
| systemd-units.plugin | /run/dbus | Systemd-list-units function: information about all systemd units, including their active state, description, whether they are enabled, and more. |
| go.d.plugin | /run/dbus | [go.d/systemdunits](https://github.com/netdata/go.d.plugin/tree/master/modules/systemdunits#readme) |

</details>
Expand Down Expand Up @@ -485,7 +485,7 @@ The following components won't work:
- freeipmi.plugin
- perf.plugin
- slabinfo.plugin
- journal-viewer-plugin
- systemd-journal.plugin

This method creates a [volume](https://docs.docker.com/storage/volumes/) for Netdata's configuration files
_within the container_ at `/etc/netdata`.
Expand Down
2 changes: 1 addition & 1 deletion docs/Netdata Agent/Logging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ Netdata assigns unique UUIDs to specific event types for easy filtering and corr
| `d1f59606-dd4d-41e3-b217-a0cfcae8e632` | Extreme Cardinality | Metric cardinality exceeds safe limits |
| `4fdf4081-6c12-4623-a032-b7fe73beacb8` | User Configuration | Dynamic configuration changed by user |

You can view these events using the Netdata `log-viewer` plugin at the `MESSAGE_ID` filter,
You can view these events using the Netdata systemd-journal.plugin at the `MESSAGE_ID` filter,
or using `journalctl` like this:

```bash
Expand Down
4 changes: 2 additions & 2 deletions docs/Top Consumers/Top Consumers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Beyond their primary roles of collecting metrics, collectors can execute specifi
| Network-connections | Real-time monitoring of all network connections, showing established connections, ports, protocols, and connection states across TCP/UDP services. | `netstat`, `ss` | yes | [network-viewer](https://github.com/netdata/netdata/tree/master/src/collectors/network-viewer.plugin) |
| Network-interfaces | Network traffic, packet drop rates, interface states, MTU, speed, and duplex mode for all network interfaces. | `bmon`, `bwm-ng` | no | [proc](https://github.com/netdata/netdata/tree/master/src/collectors/proc.plugin#readme) |
| Processes | Real-time information about the system's resource usage, including CPU utilization, memory consumption, and disk IO for every running process. | `top`, `htop` | yes | [apps](https://github.com/netdata/netdata/blob/master/src/collectors/apps.plugin/README.md) |
| Systemd-journal | Viewing, exploring and analyzing systemd journal logs. | `journalctl` | yes | [journal-viewer](/docs/logs/systemd-journal-logs/journal-viewer-plugin) |
| Systemd-list-units | Information about all systemd units, including their active state, description, whether or not they are enabled, and more. | `systemctl list-units` | yes | [journal-viewer](/docs/logs/systemd-journal-logs/journal-viewer-plugin) |
| Systemd-journal | Viewing, exploring and analyzing systemd journal logs. | `journalctl` | yes | [systemd-journal](https://github.com/netdata/netdata/tree/master/src/collectors/systemd-journal.plugin#readme) |
| Systemd-list-units | Information about all systemd units, including their active state, description, whether or not they are enabled, and more. | `systemctl list-units` | yes | [systemd-journal](https://github.com/netdata/netdata/tree/master/src/collectors/systemd-journal.plugin#readme) |
| Systemd-services | System resource utilization for all running systemd services: CPU, memory, and disk IO. | `systemd-cgtop` | no | [cgroups](https://github.com/netdata/netdata/tree/master/src/collectors/cgroups.plugin#readme) |
| Netdata-api-calls | Real-time tracing of API calls made to the Netdata Agent. It provides information on query, source, status, elapsed time, and more. | | yes | |
| Netdata-streaming | Comprehensive overview of all Netdata children instances, offering detailed information about their status, replication completion time, and many more. | | yes | |
Expand Down
6 changes: 3 additions & 3 deletions ingest/generated_map.tsv
Original file line number Diff line number Diff line change
Expand Up @@ -595,15 +595,15 @@ https://github.com/netdata/netdata/edit/master/src/web/api/exporters/shell/READM

https://github.com/netdata/netdata/edit/master/integrations/logs/integrations/systemd_journal_logs.md Systemd Journal Logs Published Logs/Systemd Journal Logs ['systemd', 'journal', 'logs'] https://github.com/netdata/netdata/edit/master/integrations/logs/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE LOGS' metadata.yaml FILE
https://github.com/netdata/netdata/edit/master/integrations/logs/integrations/windows_event_logs.md Windows Event Logs Published Logs/Windows Event Logs ['windows', 'windows events', 'logs'] https://github.com/netdata/netdata/edit/master/integrations/logs/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE LOGS' metadata.yaml FILE
https://github.com/netdata/netdata/edit/master/docs/logs/README.md Journal Viewer Plugin Published Logs/Systemd Journal Logs View and analyze logs available in systemd journal
https://github.com/netdata/netdata/edit/master/docs/logs/forward_secure_sealing.md Forward Secure Sealing (FSS) in Systemd-Journal Published Logs/Systemd Journal Logs
https://github.com/netdata/netdata/edit/master/src/collectors/systemd-journal.plugin/README.md Systemd Journal Plugin Reference Published Logs/Systemd Journal Logs View and analyze logs available in systemd journal
https://github.com/netdata/netdata/edit/master/src/collectors/systemd-journal.plugin/forward_secure_sealing.md Forward Secure Sealing (FSS) in Systemd-Journal Published Logs/Systemd Journal Logs
https://github.com/netdata/netdata/edit/master/src/collectors/windows-events.plugin/README.md Windows Events Plugin Reference Published Logs/Windows Event Logs
https://github.com/netdata/netdata/edit/master/src/collectors/log2journal/README.md log2journal Published Logs/log2journal
https://github.com/netdata/netdata/edit/master/src/libnetdata/log/systemd-cat-native.md systemd-cat-native Published Logs/systemd-cat-native
https://github.com/netdata/netdata/edit/master/docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/README.md Logs Centralization Points with systemd-journald Published Logs/Logs Centralization Points with systemd-journald
https://github.com/netdata/netdata/edit/master/docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/passive-journal-centralization-with-encryption-using-self-signed-certificates.md Passive journal centralization with encryption using self-signed certificates Published Logs/Logs Centralization Points with systemd-journald
https://github.com/netdata/netdata/edit/master/docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/passive-journal-centralization-without-encryption.md Passive journal centralization without encryption Published Logs/Logs Centralization Points with systemd-journald
https://github.com/netdata/netdata/edit/master/docs/logs/active_journal_centralization_guide_no_encryption.md Active journal source without encryption Published Logs/Logs Centralization Points with systemd-journald
https://github.com/netdata/netdata/edit/master/src/collectors/systemd-journal.plugin/active_journal_centralization_guide_no_encryption.md Active journal source without encryption Published Logs/Logs Centralization Points with systemd-journald


https://github.com/netdata/netdata/edit/master/docs/top-monitoring-netdata-functions.md Top Consumers Published Top Consumers Present the Netdata Functions what these are and why they should be used.
Expand Down
Loading