summaryrefslogtreecommitdiff
path: root/docs/configuration/service
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2022-01-13 20:40:52 +0100
committerGitHub <noreply@github.com>2022-01-13 20:40:52 +0100
commit7f905ce1ffa6f465ed04068171d79e699fb0c7bb (patch)
tree2a84a0902c3a8f425c83d5386e61dcb91f3f4d88 /docs/configuration/service
parentc767db9c81f6526c5ff54a7c9c642e41f69619d5 (diff)
parent3d392e7c2005ab64fc654ef8c4dfe3f9bcd651df (diff)
downloadvyos-documentation-7f905ce1ffa6f465ed04068171d79e699fb0c7bb.tar.gz
vyos-documentation-7f905ce1ffa6f465ed04068171d79e699fb0c7bb.zip
Merge pull request #694 from sever-sever/monitoring
Add service monitroting telegraf
Diffstat (limited to 'docs/configuration/service')
-rw-r--r--docs/configuration/service/index.rst1
-rw-r--r--docs/configuration/service/monitoring.rst45
2 files changed, 46 insertions, 0 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'