Skip to content

Commit

Permalink
T973: reorganizes basic strucutre
Browse files Browse the repository at this point in the history
-restructures documentation to add prometheus section
  • Loading branch information
nvollmar committed Dec 16, 2024
1 parent 60a2b53 commit f16abf3
Showing 1 changed file with 33 additions and 18 deletions.
51 changes: 33 additions & 18 deletions docs/configuration/service/monitoring.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
##########
Monitoring
----------
##########

Azure-data-explorer
VyOS supports monitoring through Telegraf as well as through Prometheus exporters.

********
Telegraf
********

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_

Expand Down Expand Up @@ -34,7 +49,8 @@ Telegraf output plugin azure-data-explorer_

Remote URL.

Prometheus-client

Prometheus client
=================
Telegraf output plugin prometheus-client_

Expand Down Expand Up @@ -79,6 +95,7 @@ Example:
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.
Expand All @@ -103,7 +120,8 @@ Example:
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
InfluxDB
========
Monitoring functionality with ``telegraf`` and ``InfluxDB 2`` is provided.
Telegraf is the open source server agent to help you collect metrics, events
Expand All @@ -130,6 +148,17 @@ and logs from your routers.
Remote URL


Example:

.. code-block:: none
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
====

Expand Down Expand Up @@ -160,20 +189,6 @@ Telegraf can be used to send logs to Loki using tags as labels.
This is NOT recommended, as it makes it impossible to differentiate
between multiple metrics.

Example
=======

An example of a configuration that sends ``telegraf`` metrics to remote
``InfluxDB 2``

.. code-block:: none
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'
.. _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

0 comments on commit f16abf3

Please sign in to comment.