Monitoring
VyOS supports monitoring through Telegraf as well as through Prometheus exporters.
Telegraf
Telegraf is the open source server agent to help you collect metrics, events and logs from your routers.
- The following Telegraf plugins are configurable to export metrics and logs:
Azure Data Explorer
Prometheus Client
Splunk
InfluxDB
Loki
Azure data explorer
Telegraf output plugin azure-data-explorer.
Authentication application client-id.
Authentication application client-secret.
Authentication application tenant-id
Type of metrics grouping when push to Azure Data Explorer. The default is
table-per-metric
.
Name of the single table Only if set group-metrics single-table.
Prometheus client
Telegraf output plugin prometheus-client This plugin allows export of Telegraf metrics to Prometheus, for Prometheus native metrics through exporters see section below.
Networks allowed to query this server
HTTP basic authentication username
HTTP basic authentication username
Local IP addresses to listen on
Metris version, the default is 2
Port number used by connection, default is 9273
Example:
set service monitoring telegraf prometheus-client
vyos@r14:~$ curl --silent localhost:9273/metrics | egrep -v "#" | grep cpu_usage_system
cpu_usage_system{cpu="cpu-total",host="r14"} 0.20040080160320556
cpu_usage_system{cpu="cpu0",host="r14"} 0.17182130584191915
cpu_usage_system{cpu="cpu1",host="r14"} 0.22896393817971655
Splunk
Telegraf output plugin splunk HTTP Event Collector.
Example:
set service monitoring telegraf splunk authentication insecure
set service monitoring telegraf splunk authentication token 'xxxxf5b8-xxxx-452a-xxxx-43828911xxxx'
set service monitoring telegraf splunk url 'https://192.0.2.10:8088/services/collector'
InfluxDB
Telegraf output plugin influxdb to write metrics to InfluxDB
via HTTP.
Authentication organization name
Example:
set service monitoring telegraf influxdb authentication organization 'vyos'
set service monitoring telegraf influxdb authentication token 'ZAml9Uy5wrhA...=='
set service monitoring telegraf influxdb bucket 'bucket_vyos'
set service monitoring telegraf influxdb port '8086'
set service monitoring telegraf influxdb url 'http://r1.influxdb2.local'
Loki
Telegraf can be used to send logs to loki using tags as labels.
HTTP basic authentication.
If either is set both must be set.
Prometheus
- The following Prometheus exporters are configurable to export metrics:
Node Exporter
FRR Exporter
Node Exporter
Prometheus node_exporter which provides a wide range of hardware and OS metrics.
Configure the address node_exporter is listening on.
Configure the port number node_exporter is listening on.
FRR Exporter
Prometheus frr_exporter which provides free range routing metrics.
Configure the address frr_exporter is listening on.
Configure the port number frr_exporter is listening on.