vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

monitoring: Add azure prometheus and splunk output plugins

Browse Source
This commit is contained in:
Viacheslav Hletenko 2022-05-30 16:09:59 +03:00
parent 9dffd71f8f
commit 6ff761ce00
1 changed files with 106 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
docs/configuration/service/monitoring.rst
View File

@ -1,10 +1,111 @@
Monitoring
----------
Monitoring functionality with ``telegraf`` and ``InfluxDB 2`` is provided.
Azure-data-explorer
===================
Telegraf output plugin azure-data-explorer_
.. cfgcmd:: set service monitoring telegraf azure-data-explorer authentication client-id <client-id>
Authentication application client-id.
.. cfgcmd:: set service monitoring telegraf azure-data-explorer authentication client-secret <client-secret>
Authentication application client-secret.
.. cfgcmd:: set service monitoring telegraf azure-data-explorer authentication tenant-id <tenant-id>
Authentication application tenant-id
.. cfgcmd:: set service monitoring telegraf azure-data-explorer database <name>
Remote databe name.
.. cfgcmd:: set service monitoring telegraf azure-data-explorer group-metrics <single-table | table-per-metric>
Type of metrics grouping when push to Azure Data Explorer. The default is
``table-per-metric``.
.. cfgcmd:: set service monitoring telegraf azure-data-explorer table <name>
Name of the single table Only if set group-metrics single-table.
.. cfgcmd:: set service monitoring telegraf azure-data-explorer url <url>
Remote URL.
Prometheus-client
=================
Telegraf output plugin prometheus-client_
.. cfgcmd:: set service monitoring telegraf prometheus-client
Output plugin Prometheus client
.. cfgcmd:: set service monitoring telegraf prometheus-client allow-from <prefix>
Networks allowed to query this server
.. cfgcmd:: set service monitoring telegraf prometheus-client authentication username <username>
HTTP basic authentication username
.. cfgcmd:: set service monitoring telegraf prometheus-client authentication password <password>
HTTP basic authentication username
.. cfgcmd:: set service monitoring telegraf prometheus-client listen-address <address>
Local IP addresses to listen on
.. cfgcmd:: set service monitoring telegraf prometheus-client metric-version <1 | 2>
Metris version, the default is ``2``
.. cfgcmd:: set service monitoring telegraf prometheus-client port <port>
Port number used by connection, default is ``9273``
Example:
.. code-block:: none
set service monitoring telegraf prometheus-client
.. code-block:: none
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.
.. cfgcmd:: set service monitoring telegraf splunk authentication insecure
Use TLS but skip host validation
.. cfgcmd:: set service monitoring telegraf splunk authentication token <token>
Authorization token
.. cfgcmd:: set service monitoring telegraf splunk authentication url <url>
Remote URL to Splunk collector
Example:
.. code-block:: none
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'
Telegraf
========
Monitoring functionality with ``telegraf`` and ``InfluxDB 2`` is provided.
Telegraf is the open source server agent to help you collect metrics, events
and logs from your routers.
@ -43,3 +144,7 @@ An example of a configuration that sends ``telegraf`` metrics to remote
set service monitoring telegraf port '8086'
set service monitoring telegraf source 'all'
set service monitoring telegraf url 'http://r1.influxdb2.local'
.. _azure-data-explorer: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/azure_data_explorer
.. _prometheus-client: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/prometheus_client
.. _splunk: https://www.splunk.com/en_us/blog/it/splunk-metrics-via-telegraf.html