Node Exporter Metrics
A plugin based on Prometheus Node Exporter to collect system / host level metrics
Prometheus Node Exporter is a popular way to collect system level metrics from operating systems, such as CPU / Disk / Network / Process statistics. Fluent Bit 1.8.0 includes node exporter metrics plugin that builds off the Prometheus design to collect system level metrics without having to manage two separate processes or agents.
The initial release of Node Exporter Metrics contains a subset of collectors and metrics available from Prometheus Node Exporter and we plan to expand them over time.
Important note: Metrics collected with Node Exporter Metrics flow through a separate pipeline from logs and current filters do not operate on top of metrics.
This plugin is currently only supported on Linux based operating systems

Configuration

Key
Description
Default
scrape_interval
The rate at which metrics are collected from the host operating system
5 seconds
path.procfs
The mount point used to collect process information and metrics
/proc/
path.sysfs
The path in the filesystem used to collect system metrics
/sys/

Collectors available

The following table describes the available collectors as part of this plugin. All of them are enabled by default and respects the original metrics name, descriptions, and types from Prometheus Exporter, so you can use your current dashboards without any compatibility problem.
note: the Version column specifies the Fluent Bit version where the collector is available.
Name
Description
OS
Version
cpu
Exposes CPU statistics.
Linux
v1.8
cpufreq
Exposes CPU frequency statistics.
Linux
v1.8
diskstats
Exposes disk I/O statistics.
Linux
v1.8
filefd
Exposes file descriptor statistics from /proc/sys/fs/file-nr.
Linux
v1.8.2
loadavg
Exposes load average.
Linux
v1.8
meminfo
Exposes memory statistics.
Linux
v1.8
netdev
Exposes network interface statistics such as bytes transferred.
Linux
v1.8.2
stat
Exposes various statistics from /proc/stat. This includes boot time, forks, and interruptions.
Linux
v1.8
time
Exposes the current system time.
Linux
v1.8
uname
Exposes system information as provided by the uname system call.
Linux
v1.8
vmstat
Exposes statistics from /proc/vmstat.
Linux
v1.8.2

Getting Started

Simple Configuration File

In the following configuration file, the input plugin node_exporter_metrics collects metrics every 2 seconds and exposes them through our Prometheus Exporter output plugin on HTTP/TCP port 2021.
1
# Node Exporter Metrics + Prometheus Exporter
2
# -------------------------------------------
3
# The following example collect host metrics on Linux and expose
4
# them through a Prometheus HTTP end-point.
5
#
6
# After starting the service try it with:
7
#
8
# $ curl http://127.0.0.1:2021/metrics
9
#
10
[SERVICE]
11
flush 1
12
log_level info
13
14
[INPUT]
15
name node_exporter_metrics
16
tag node_metrics
17
scrape_interval 2
18
19
[OUTPUT]
20
name prometheus_exporter
21
match node_metrics
22
listen 0.0.0.0
23
port 2021
24
25
Copied!
You can test the expose of the metrics by using curl:
1
curl http://127.0.0.1:2021/metrics
Copied!

Container to Collect Host Metrics

When deploying Fluent Bit in a container you will need to specify additional settings to ensure that Fluent Bit has access to the host operating system. The following docker command deploys Fluent Bit with specific mount paths and settings enabled to ensure that Fluent Bit can collect from the host. These are then exposed over port 2021.
1
docker run -ti -v /proc:/host/proc \
2
-v /sys:/host/sys \
3
-p 2021:2021 \
4
fluent/fluent-bit:1.8.0 \
5
/fluent-bit/bin/fluent-bit \
6
-i node_exporter_metrics -p path.procfs=/host/proc -p path.sysfs=/host/sys \
7
-o prometheus_exporter -p "add_label=host $HOSTNAME" \
8
-f 1
Copied!

Fluent Bit + Prometheus + Grafana

If you like dashboards for monitoring, Grafana is one of the preferred options. In our Fluent Bit source code repository, we have pushed a simple docker-compose example. Steps:

Get a copy of Fluent Bit source code

1
git clone https://github.com/fluent/fluent-bit
2
cd fluent-bit/docker_compose/node-exporter-dashboard/
Copied!

Start the service and view your Dashboard

1
docker-compose up --force-recreate -d --build
Copied!
Now open your browser in the address http://127.0.0.1:3000. When asked for the credentials to access Grafana, just use the admin username and admin password.
Note that by default Grafana dashboard plots the data from the last 24 hours, so just change it to Last 5 minutes to see the recent data being collected.

Stop the Service

1
docker-compose down
Copied!

Enhancement Requests

Our current plugin implements a sub-set of the available collectors in the original Prometheus Node Exporter, if you would like that we prioritize a specific collector please open a Github issue by using the following template: - in_node_exporter_metrics
Last modified 3mo ago