Skip to content

Commit 7d9bd96

Browse files
committed
Updating node exporter metrics input plugin docs for netstat collector enhancement and added missing config options. Fixes #2213.
Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 863ec6d commit 7d9bd96

File tree

1 file changed

+40
-24
lines changed

1 file changed

+40
-24
lines changed

pipeline/inputs/node-exporter-metrics.md

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This plugin is generally supported on Linux-based operating systems, with macOS
1515

1616
{% endhint %}
1717

18-
## Configuration
18+
## Configuration parameters
1919

2020
`scrape_interval` sets the default for all scrapes. To set granular scrape intervals, set the specific interval. For example, `collector.cpu.scrape_interval`. When using a granular scrape interval, if a value greater than `0` is used, it overrides the global default. Otherwise, the global default is used.
2121

@@ -30,33 +30,45 @@ For example, if the global interval is set to `5` and an override interval of `6
3030
This helps with down-sampling when collecting metrics.
3131

3232
| Key | Description | Default |
33-
|---|---|---|
34-
| `scrape_interval` | The rate in seconds at which metrics are collected from the host operating system. | `5` |
35-
| `path.procfs` | The mount point used to collect process information and metrics. | `/proc/` |
36-
| `path.sysfs` | The path in the filesystem used to collect system metrics. | `/sys/` |
33+
| --- | --- | --- |
3734
| `collector.cpu.scrape_interval` | The rate in seconds at which `cpu` metrics are collected from the host operating system. | `0` |
3835
| `collector.cpufreq.scrape_interval` | The rate in seconds at which `cpufreq` metrics are collected from the host operating system. | `0` |
39-
| `collector.meminfo.scrape_interval` | The rate in seconds at which `meminfo` metrics are collected from the host operating system. | `0` |
4036
| `collector.diskstats.scrape_interval` | The rate in seconds at which `diskstats` metrics are collected from the host operating system. | `0` |
37+
| `collector.filefd.scrape_interval` | The rate in seconds at which `filefd` metrics are collected from the host operating system. | `0` |
4138
| `collector.filesystem.scrape_interval` | The rate in seconds at which `filesystem` metrics are collected from the host operating system. | `0` |
42-
| `collector.uname.scrape_interval` | The rate in seconds at which `uname` metrics are collected from the host operating system. | `0` |
43-
| `collector.stat.scrape_interval` | The rate in seconds at which `stat` metrics are collected from the host operating system. | `0` |
44-
| `collector.time.scrape_interval` | The rate in seconds at which `time` metrics are collected from the host operating system. | `0` |
39+
| `collector.hwmon.chip-exclude` | Regex of chips to exclude for the `hwmon` collector. | Not set by default. |
40+
| `collector.hwmon.chip-include` | Regex of chips to include for the `hwmon` collector. | Not set by default. |
41+
| `collector.hwmon.scrape_interval` | The rate in seconds at which `hwmon` metrics are collected from the host operating system. | `0` |
42+
| `collector.hwmon.sensor-exclude` | Regex of sensors to exclude for the `hwmon` collector. | Not set by default. |
43+
| `collector.hwmon.sensor-include` | Regex of sensors to include for the `hwmon` collector. | Not set by default. |
4544
| `collector.loadavg.scrape_interval` | The rate in seconds at which `loadavg` metrics are collected from the host operating system. | `0` |
46-
| `collector.vmstat.scrape_interval` | The rate in seconds at which `vmstat` metrics are collected from the host operating system. | `0` |
47-
| `collector.thermal_zone.scrape_interval` | The rate in seconds at which `thermal_zone` metrics are collected from the host operating system. | `0` |
48-
| `collector.filefd.scrape_interval` | The rate in seconds at which `filefd` metrics are collected from the host operating system. | `0` |
45+
| `collector.meminfo.scrape_interval` | The rate in seconds at which `meminfo` metrics are collected from the host operating system. | `0` |
46+
| `collector.netdev.scrape_interval` | The rate in seconds at which `netdev` metrics are collected from the host operating system. | `0` |
47+
| `collector.netstat.scrape_interval` | The rate in seconds at which `netstat` metrics are collected from the host operating system. | `0` |
4948
| `collector.nvme.scrape_interval` | The rate in seconds at which `nvme` metrics are collected from the host operating system. | `0` |
5049
| `collector.processes.scrape_interval` | The rate in seconds at which system level `process` metrics are collected from the host operating system. | `0` |
51-
| `metrics` | Specify which metrics are collected from the host operating system. These metrics depend on `/procfs` or `/sysfs`. The actual values of metrics will be read from `/proc` or `/sys` when needed. `cpu`, `cpufreq`, `meminfo`, `diskstats`, `filesystem`, `stat`, `loadavg`, `vmstat`, `netdev`, and `filefd` depend on `procfs`. `cpufreq` metrics depend on `sysfs`. | `"cpu,cpufreq,meminfo,diskstats,filesystem,uname,stat,time,loadavg,vmstat,netdev,filefd"` |
52-
| `filesystem.ignore_mount_point_regex` | Specify the regular expression for the `mount` points to prevent collection of/ignore. | `^/(dev\|proc\|run/credentials/.+\|sys\|var/lib/docker/.+\|var/lib/containers/storage/.+)($\|/)` |
53-
| `filesystem.ignore_filesystem_type_regex` | Specify the regular expression for the `filesystem` types to prevent collection of or ignore. | `^(autofs\|binfmt_misc\|bpf\|cgroup2?\|configfs\|debugfs\|devpts\|devtmpfs\|fusectl\|hugetlbfs\|iso9660\|mqueue\|nsfs\|overlay\|proc\|procfs\|pstore\|rpc_pipefs\|securityfs\|selinuxfs\|squashfs\|sysfs\|tracefs)$` |
50+
| `collector.sockstat.scrape_interval` | The rate in seconds at which `sockstat` metrics are collected from the host operating system. | `0` |
51+
| `collector.stat.scrape_interval` | The rate in seconds at which `stat` metrics are collected from the host operating system. | `0` |
52+
| `collector.systemd.scrape_interval` | The rate in seconds at which `systemd` metrics are collected from the host operating system. | `0` |
53+
| `collector.textfile.path` | Specify path or directory to collect textfile metrics from the host operating system. | Not set by default. |
54+
| `collector.textfile.scrape_interval` | The rate in seconds at which `textfile` metrics are collected from the host operating system. | `0` |
55+
| `collector.thermalzone.scrape_interval` | The rate in seconds at which `thermal_zone` metrics are collected from the host operating system. | `0` |
56+
| `collector.time.scrape_interval` | The rate in seconds at which `time` metrics are collected from the host operating system. | `0` |
57+
| `collector.uname.scrape_interval` | The rate in seconds at which `uname` metrics are collected from the host operating system. | `0` |
58+
| `collector.vmstat.scrape_interval` | The rate in seconds at which `vmstat` metrics are collected from the host operating system. | `0` |
5459
| `diskstats.ignore_device_regex` | Specify the regular expression for the` diskstats` to prevent collection of/ignore. | `^(ram\|loop\|fd\|(h\|s\|v\|xv)d[a-z]\|nvme\\d+n\\d+p)\\d+$` |
60+
| `filesystem.ignore_filesystem_type_regex` | Specify the regular expression for the `filesystem` types to prevent collection of or ignore. | `^(autofs\|binfmt_misc\|bpf\|cgroup2?\|configfs\|debugfs\|devpts\|devtmpfs\|fusectl\|hugetlbfs\|iso9660\|mqueue\|nsfs\|overlay\|proc\|procfs\|pstore\|rpc_pipefs\|securityfs\|selinuxfs\|squashfs\|sysfs\|tracefs)$` |
61+
| `filesystem.ignore_mount_point_regex` | Specify the regular expression for the `mount` points to prevent collection of/ignore. | `^/(dev\|proc\|run/credentials/.+\|sys\|var/lib/docker/.+\|var/lib/containers/storage/.+)($\|/)` |
62+
| `metrics` | Specify which metrics are collected from the host operating system. These metrics depend on `/procfs` or `/sysfs`. The actual values of metrics will be read from `/proc` or `/sys` when needed. `cpu`, `cpufreq`, `meminfo`, `diskstats`, `filesystem`, `stat`, `loadavg`, `vmstat`, `netdev`, `netstat`, `sockstat`, and `filefd` depend on `procfs`. `cpufreq` and `hwmon` metrics depend on `sysfs`. | `"cpu,cpufreq,meminfo,diskstats,filesystem,uname,stat,time,loadavg,vmstat,netdev,netstat,sockstat,filefd,systemd,nvme,thermal_zone,hwmon"` |
63+
| `path.procfs` | The mount point used to collect process information and metrics. | `/proc` |
64+
| `path.rootfs` | The root filesystem mount point. | `/` |
65+
| `path.sysfs` | The path in the filesystem used to collect system metrics. | `/sys` |
66+
| `scrape_interval` | The rate in seconds at which metrics are collected from the host operating system. | `5` |
67+
| `systemd_exclude_pattern` | Regular expression to determine which units are excluded in the metrics produced by the `systemd` collector. | `.+\\.(automount\|device\|mount\|scope\|slice)"` |
68+
| `systemd_include_pattern` | Regular expression to determine which units are included in the metrics produced by the `systemd` collector. | Not applied unless explicitly set. |
69+
| `systemd_include_service_task_metrics` | Determines if the collector will include service task metrics. | `false` |
5570
| `systemd_service_restart_metrics` | Determines if the collector will include service restart metrics. | `false` |
5671
| `systemd_unit_start_time_metrics` | Determines if the collector will include unit start time metrics. | `false` |
57-
| `systemd_include_service_task_metrics` | Determines if the collector will include service task metrics. | `false` |
58-
| `systemd_include_pattern` | Regular expression to determine which units are included in the metrics produced by the `systemd` collector. | Not applied unless explicitly set. |
59-
| `systemd_exclude_pattern` | Regular expression to determine which units are excluded in the metrics produced by the `systemd` collector. | `.+\\.(automount\|device\|mount\|scope\|slice)"` |
6072

6173
## Collectors available
6274

@@ -71,17 +83,21 @@ The Version column specifies the Fluent Bit version where the collector is avail
7183
| `diskstats` | Exposes disk I/O statistics. | Linux, macOS | 1.8 |
7284
| `filefd` | Exposes file descriptor statistics from `/proc/sys/fs/file-nr`. | Linux | 1.8.2 |
7385
| `filesystem` | Exposes filesystem statistics from `/proc/*/mounts`. | Linux | 2.0.9 |
86+
| `hwmon` | Exposes hardware monitoring metrics from `/sys/class/hwmon`. | Linux | 2.2.0 |
7487
| `loadavg` | Exposes load average. | Linux, macOS | 1.8 |
7588
| `meminfo` | Exposes memory statistics. | Linux, macOS | 1.8 |
7689
| `netdev` | Exposes network interface statistics such as bytes transferred. | Linux, macOS | 1.8.2 |
90+
| `netstat` | Exposes network statistics from `/proc/net/netstat`. | Linux | 2.2.0 |
91+
| `nvme` | Exposes `nvme` statistics from `/proc`. | Linux | 2.2.0 |
92+
| `processes` | Exposes processes statistics from `/proc`. | Linux | 2.2.0 |
93+
| `sockstat` | Exposes socket statistics from `/proc/net/sockstat`. | Linux | 2.2.0 |
7794
| `stat` | Exposes various statistics from `/proc/stat`. This includes boot time, forks, and interruptions. | Linux | 1.8 |
78-
| `time` | Exposes the current system time. | Linux | v1.8 |
95+
| `systemd` | Exposes statistics from `systemd`. | Linux | 2.1.3 |
96+
| `textfile` | Exposes custom metrics from text files. Requires `collector.textfile.path` to be set. | Linux | 2.2.0 |
97+
| `thermal_zone` | Exposes thermal statistics from `/sys/class/thermal/thermal_zone/*`. | Linux | 2.2.1 |
98+
| `time` | Exposes the current system time. | Linux | 1.8 |
7999
| `uname` | Exposes system information as provided by the `uname` system call. | Linux, macOS | 1.8 |
80100
| `vmstat` | Exposes statistics from `/proc/vmstat`. | Linux | 1.8.2 |
81-
| `systemd collector` | Exposes statistics from `systemd`. | Linux | 2.1.3 |
82-
| `thermal_zone` | Expose thermal statistics from `/sys/class/thermal/thermal_zone/*` | Linux | 2.2.1 |
83-
| `nvme` | Exposes `nvme` statistics from `/proc`. | Linux | 2.2.0 |
84-
| `processes` | Exposes processes statistics from `/proc`. | Linux | 2.2.0 |
85101

86102
## Threading
87103

@@ -209,7 +225,7 @@ If you use dashboards for monitoring, Grafana is one option. The Fluent Bit sour
209225

210226
By default, Grafana dashboard plots the data from the last 24 hours. Change it to **Last 5 minutes** to see the recent data being collected.
211227

212-
#### Stop the Service
228+
#### Stop the service
213229

214230
```shell
215231
docker-compose down

0 commit comments

Comments
 (0)