@cryptotaxi247 / netdata-1 / commits / 5cf7f6410

Regenerate integrations docs (#22364)

Co-authored-by: Ancairon <70198089+Ancairon@users.noreply.github.com>

Netdata bot committed May 4, 2026 at 06:47 UTC 5cf7f64107f033cb5a12124495d1c1d3b1f8cee3
13 files changed +299 -12
src/collectors/COLLECTORS.md
+2
@@ -200,6 +200,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
200 | [kern.ipc.sem](https://github.com/netdata/netdata/blob/master/src/collectors/freebsd.plugin/integrations/kern.ipc.sem.md) | Collect information about semaphore. |
201 | [kern.ipc.shm](https://github.com/netdata/netdata/blob/master/src/collectors/freebsd.plugin/integrations/kern.ipc.shm.md) | Collect shared memory information. |
202 | [Kernel Same-Page Merging](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/kernel_same-page_merging.md) | Kernel Samepage Merging (KSM) is a memory-saving feature in Linux that enables the kernel to examine the memory of different processes and identify identical pages. |
203 +| [Linux Audit Subsystem](https://github.com/netdata/netdata/blob/master/src/collectors/debugfs.plugin/integrations/linux_audit_subsystem.md) | Monitors Linux kernel audit subsystem status via NETLINK_AUDIT. |
204 | [Linux kernel SLAB allocator statistics](https://github.com/netdata/netdata/blob/master/src/collectors/slabinfo.plugin/integrations/linux_kernel_slab_allocator_statistics.md) | Collects metrics on kernel SLAB cache utilization to monitor the low-level performance impact of workloads in the kernel. |
205 | [Linux ZSwap](https://github.com/netdata/netdata/blob/master/src/collectors/debugfs.plugin/integrations/linux_zswap.md) | Collects zswap performance metrics on Linux systems. |
206 | [macOS](https://github.com/netdata/netdata/blob/master/src/collectors/macos.plugin/integrations/macos.md) | Monitor macOS metrics for efficient operating system performance. |
@@ -555,6 +556,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
556 | [Physical and Logical Disk Performance Metrics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md) | Detailed statistics for all disk devices and volumes. |
557 | [S.M.A.R.T.](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/smartctl/integrations/s.m.a.r.t..md) | This collector monitors the health status of storage devices by analyzing S.M.A.R.T. |
558 | [Samba](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/samba/integrations/samba.md) | This collector monitors Samba syscalls and SMB2 calls. |
559 +| [SMB Server Shares](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/smb_server_shares.md) | Monitor SMB server share activity and throughput counters on Windows systems. |
560 | [StoreCLI RAID](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/storcli/integrations/storecli_raid.md) | Monitors the health of StoreCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system. |
561 | [Storidge](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/storidge.md) | Keep an eye on Storidge storage metrics for efficient storage management and performance. |
562 | [Synology ActiveBackup](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/synology_activebackup.md) | Track Synology Active Backup metrics for efficient backup and data protection management. |
src/collectors/debugfs.plugin/integrations/linux_audit_subsystem.md new
+147
@@ -0,0 +1,147 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/debugfs.plugin/integrations/linux_audit_subsystem.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/debugfs.plugin/metadata.yaml"
4 +sidebar_label: "Linux Audit Subsystem"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Collectors/Operating Systems"
7 +keywords: ['audit', 'auditd', 'backlog', 'security', 'kernel panic', 'compliance']
8 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 +endmeta-->
10 +
11 +# Linux Audit Subsystem
12 +
13 +
14 +<img src="https://netdata.cloud/img/linux.svg" width="150"/>
15 +
16 +
17 +Plugin: debugfs.plugin
18 +Module: audit
19 +
20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21 +
22 +## Overview
23 +
24 +Monitors Linux kernel audit subsystem status via NETLINK_AUDIT. Tracks audit backlog depth, backlog utilization, lost events, and configuration (failure mode, enabled state). Critical for detecting audit backlog overflow conditions that cause kernel panics when failure mode is set to 2 (panic).
25 +
26 +
27 +Query kernel audit status via NETLINK_AUDIT socket (AUDIT_GET)
28 +
29 +This collector is only supported on the following platforms:
30 +
31 +- Linux
32 +
33 +This collector only supports collecting metrics from a single instance of this integration.
34 +
35 +This integration requires root privileges or CAP_AUDIT_CONTROL capability to query the kernel audit subsystem via netlink. The Netdata installer grants this capability to debugfs.plugin automatically. The module detects missing privileges and disables itself gracefully.
36 +
37 +
38 +### Default Behavior
39 +
40 +#### Auto-Detection
41 +
42 +Automatically detects and monitors the Linux audit subsystem when the kernel supports NETLINK_AUDIT. Gracefully disables itself if audit is not available.
43 +
44 +
45 +#### Limits
46 +
47 +The default configuration for this integration does not impose any limits on data collection.
48 +
49 +#### Performance Impact
50 +
51 +Minimal. Performs a single netlink query per collection cycle. No file I/O, no process forking.
52 +
53 +
54 +## Setup
55 +
56 +
57 +### Prerequisites
58 +
59 +#### Linux kernel with audit support
60 +
61 +The Linux kernel must have audit support enabled (CONFIG_AUDIT=y). Most distribution kernels include this by default.
62 +
63 +
64 +
65 +### Configuration
66 +
67 +#### Options
68 +
69 +
70 +
71 +<details open><summary>Config options</summary>
72 +
73 +
74 +
75 +| Option | Description | Default | Required |
76 +|:-----|:------------|:--------|:---------:|
77 +| update every | Data collection frequency. | 1 | no |
78 +
79 +
80 +</details>
81 +
82 +
83 +
84 +#### via File
85 +
86 +The configuration file name for this integration is `netdata.conf`.
87 +Configuration for this specific integration is located in the `[plugin:debugfs]` section within that file.
88 +
89 +The file format is a modified INI syntax. The general structure is:
90 +
91 +```ini
92 +[section1]
93 + option1 = some value
94 + option2 = some other value
95 +
96 +[section2]
97 + option3 = some third value
98 +```
99 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
100 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
101 +
102 +```bash
103 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
104 +sudo ./edit-config netdata.conf
105 +```
106 +
107 +##### Examples
108 +There are no configuration examples.
109 +
110 +
111 +
112 +## Alerts
113 +
114 +
115 +The following alerts are available:
116 +
117 +| Alert name | On metric | Description |
118 +|:------------|:----------|:------------|
119 +| [ audit_backlog_utilization ](https://github.com/netdata/netdata/blob/master/src/health/health.d/audit.conf) | audit.backlog_utilization | Linux audit backlog utilization has exceeded the warning threshold while failure mode is set to panic. Kernel panic is imminent if backlog overflows. |
120 +| [ audit_lost_events ](https://github.com/netdata/netdata/blob/master/src/health/health.d/audit.conf) | audit.lost | Linux audit subsystem is losing events (backlog overflow, rate limiting, or memory pressure). |
121 +
122 +
123 +## Metrics
124 +
125 +Metrics grouped by *scope*.
126 +
127 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
128 +
129 +Monitor the Linux kernel audit subsystem status and backlog health.
130 +
131 +### Per Linux Audit Subsystem instance
132 +
133 +Audit subsystem status for the entire system.
134 +
135 +This scope has no labels.
136 +
137 +Metrics:
138 +
139 +| Metric | Dimensions | Unit |
140 +|:------|:----------|:----|
141 +| audit.backlog | used, free | events |
142 +| audit.backlog_utilization | utilization | % |
143 +| audit.lost | lost | events/s |
144 +| audit.enabled | disabled, enabled, immutable | state |
145 +| audit.failure | silent, printk, panic | state |
146 +
147 +
src/collectors/ebpf.plugin/integrations/ebpf_cachestat.md
+1 -1
@@ -50,7 +50,7 @@ The default configuration for this integration does not impose any limits on dat
50
51 #### Performance Impact
52
53 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
53 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
54
55 ## Setup
56
src/collectors/ebpf.plugin/integrations/ebpf_dcstat.md
+1 -1
@@ -50,7 +50,7 @@ The default configuration for this integration does not impose any limits on dat
50
51 #### Performance Impact
52
53 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
53 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
54
55 ## Setup
56
src/collectors/ebpf.plugin/integrations/ebpf_filedescriptor.md
+1 -1
@@ -50,7 +50,7 @@ The default configuration for this integration does not impose any limits on dat
50
51 #### Performance Impact
52
53 -Depending of kernel version and frequency that files are open and close, this thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
53 +Depending of kernel version and frequency that files are open and close, this thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
54
55 ## Setup
56
src/collectors/ebpf.plugin/integrations/ebpf_mdflush.md
+1 -1
@@ -45,7 +45,7 @@ The default configuration for this integration does not impose any limits on dat
45
46 #### Performance Impact
47
48 -This thread will add overhead every time that `md_flush_request` is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
48 +This thread will add overhead every time that `md_flush_request` is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
49
50 ## Setup
51
src/collectors/ebpf.plugin/integrations/ebpf_mount.md
+1 -1
@@ -45,7 +45,7 @@ The default configuration for this integration does not impose any limits on dat
45
46 #### Performance Impact
47
48 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
48 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
49
50 ## Setup
51
src/collectors/ebpf.plugin/integrations/ebpf_shm.md
+1 -1
@@ -50,7 +50,7 @@ The default configuration for this integration does not impose any limits on dat
50
51 #### Performance Impact
52
53 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
53 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
54
55 ## Setup
56
src/collectors/ebpf.plugin/integrations/ebpf_socket.md
+3 -3
@@ -50,7 +50,7 @@ The default configuration for this integration does not impose any limits on dat
50
51 #### Performance Impact
52
53 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
53 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
54
55 ## Setup
56
@@ -156,12 +156,12 @@ Metrics:
156
157 | Metric | Dimensions | Unit |
158 |:------|:----------|:----|
159 -| ip.inbound_conn | connection_tcp | connections/s |
159 +| ip.inbound_conn | connected_tcp, connected_udp | connections/s |
160 | ip.tcp_outbound_conn | received | connections/s |
161 | ip.tcp_functions | received, send, closed | calls/s |
162 | ip.total_tcp_bandwidth | received, send | kilobits/s |
163 | ip.tcp_error | received, send | calls/s |
164 -| ip.tcp_retransmit | retransmited | calls/s |
164 +| ip.tcp_retransmit | retransmitted | calls/s |
165 | ip.udp_functions | received, send | calls/s |
166 | ip.total_udp_bandwidth | received, send | kilobits/s |
167 | ip.udp_error | received, send | calls/s |
src/collectors/ebpf.plugin/integrations/ebpf_swap.md
+1 -1
@@ -50,7 +50,7 @@ The default configuration for this integration does not impose any limits on dat
50
51 #### Performance Impact
52
53 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
53 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
54
55 ## Setup
56
src/collectors/ebpf.plugin/integrations/ebpf_sync.md
+1 -1
@@ -45,7 +45,7 @@ The default configuration for this integration does not impose any limits on dat
45
46 #### Performance Impact
47
48 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
48 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
49
50 ## Setup
51
src/collectors/ebpf.plugin/integrations/ebpf_vfs.md
+1 -1
@@ -50,7 +50,7 @@ The default configuration for this integration does not impose any limits on dat
50
51 #### Performance Impact
52
53 -This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology.
53 +This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
54
55 ## Setup
56
src/collectors/windows.plugin/integrations/smb_server_shares.md new
+138
@@ -0,0 +1,138 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/smb_server_shares.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4 +sidebar_label: "SMB Server Shares"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Collectors/Storage and Filesystems"
7 +keywords: ['windows', 'microsoft', 'smb', 'share', 'file sharing']
8 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 +endmeta-->
10 +
11 +# SMB Server Shares
12 +
13 +
14 +<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15 +
16 +
17 +Plugin: windows.plugin
18 +Module: PerflibSMB
19 +
20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21 +
22 +## Overview
23 +
24 +Monitor SMB server share activity and throughput counters on Windows systems.
25 +
26 +
27 +It queries the 'SMB Server Shares' object from Perflib in order to gather the metrics.
28 +
29 +
30 +This collector is only supported on the following platforms:
31 +
32 +- windows
33 +
34 +This collector only supports collecting metrics from a single instance of this integration.
35 +
36 +
37 +### Default Behavior
38 +
39 +#### Auto-Detection
40 +
41 +This collector is disabled by default. When enabled, it automatically detects all available SMB share instances and metrics.
42 +
43 +
44 +#### Limits
45 +
46 +The default configuration for this integration does not impose any limits on data collection.
47 +
48 +#### Performance Impact
49 +
50 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
51 +
52 +## Setup
53 +
54 +
55 +### Prerequisites
56 +
57 +No action required.
58 +
59 +### Configuration
60 +
61 +#### Options
62 +
63 +
64 +
65 +
66 +
67 +| Option | Description | Default | Required |
68 +|:-----|:------------|:--------|:---------:|
69 +| update every | Data collection frequency. | 1 | no |
70 +
71 +
72 +
73 +
74 +#### via File
75 +
76 +The configuration file name for this integration is `netdata.conf`.
77 +Configuration for this specific integration is located in the `[plugin:windows:PerflibSMB]` section within that file.
78 +
79 +The file format is a modified INI syntax. The general structure is:
80 +
81 +```ini
82 +[section1]
83 + option1 = some value
84 + option2 = some other value
85 +
86 +[section2]
87 + option3 = some third value
88 +```
89 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
90 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91 +
92 +```bash
93 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
94 +sudo ./edit-config netdata.conf
95 +```
96 +
97 +##### Examples
98 +There are no configuration examples.
99 +
100 +
101 +
102 +## Alerts
103 +
104 +There are no alerts configured by default for this integration.
105 +
106 +
107 +## Metrics
108 +
109 +Metrics grouped by *scope*.
110 +
111 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
112 +
113 +
114 +
115 +### Per SMB Share
116 +
117 +These metrics refer to SMB shares.
118 +
119 +Labels:
120 +
121 +| Label | Description |
122 +|:-----------|:----------------|
123 +| share | SMB share name as exposed by the Windows SMB Server Shares performance object. |
124 +
125 +Metrics:
126 +
127 +| Metric | Dimensions | Unit |
128 +|:------|:----------|:----|
129 +| smb.server_shares_current_open_file_count | open | files |
130 +| smb.server_shares_tree_connect_count | connections | connections |
131 +| smb.server_shares_received_bytes | received | bytes/s |
132 +| smb.server_shares_write_requests | writes | requests/s |
133 +| smb.server_shares_read_requests | reads | requests/s |
134 +| smb.server_shares_metadata_requests | metadata | requests/s |
135 +| smb.server_shares_sent_bytes | sent | bytes/s |
136 +| smb.server_shares_files_opened | opened | files/s |
137 +
138 +