summaryrefslogtreecommitdiff
path: root/docs/configuration/service/monitoring.rst
blob: 7396f14298078d8a7dbb4520e3d747170ee0895e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Monitoring
----------

Monitoring functionality with ``telegraf`` and ``InfluxDB 2`` is provided.

Telegraf
========
Telegraf is the open source server agent to help you collect metrics, events
and logs from your routers.

.. cfgcmd:: set service monitoring telegraf authentication organization <organization>

   Authentication organization name

.. cfgcmd:: set service monitoring telegraf authentication token <token>

   Authentication token

.. cfgcmd:: set service monitoring telegraf bucket <bucket>

   Remote ``InfluxDB`` bucket name

.. cfgcmd:: set service monitoring port <port>

   Remote port

.. cfgcmd:: set service monitoring telegraf url <url>

   Remote URL


Example
=======

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

.. code-block:: none

  set service monitoring telegraf authentication organization 'vyos'
  set service monitoring telegraf authentication token 'ZAml9Uy5wrhA...=='
  set service monitoring telegraf bucket 'bucket_vyos'
  set service monitoring telegraf port '8086'
  set service monitoring telegraf source 'all'
  set service monitoring telegraf url 'http://r1.influxdb2.local'