diff options
| -rw-r--r-- | docs/configuration/service/index.rst | 1 | ||||
| -rw-r--r-- | docs/configuration/service/monitoring.rst | 45 | ||||
| -rw-r--r-- | docs/copyright.rst | 2 |
3 files changed, 47 insertions, 1 deletions
diff --git a/docs/configuration/service/index.rst b/docs/configuration/service/index.rst index 96660e91..11a1a118 100644 --- a/docs/configuration/service/index.rst +++ b/docs/configuration/service/index.rst @@ -17,6 +17,7 @@ Service ipoe-server lldp mdns + monitoring pppoe-server router-advert salt-minion diff --git a/docs/configuration/service/monitoring.rst b/docs/configuration/service/monitoring.rst new file mode 100644 index 00000000..f3fb11ba --- /dev/null +++ b/docs/configuration/service/monitoring.rst @@ -0,0 +1,45 @@ +Monitoring +---------- + +Monitoring functionality with ``telefgraf`` 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' diff --git a/docs/copyright.rst b/docs/copyright.rst index 2093ee80..551d3b26 100644 --- a/docs/copyright.rst +++ b/docs/copyright.rst @@ -2,7 +2,7 @@ Copyright Notice ################ -Copyright (C) 2018-2021 VyOS maintainers and contributors +Copyright (C) 2018-2022 VyOS maintainers and contributors Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all |