summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Vollmar <nvo@scaling.ch>2024-07-01 08:49:35 +0200
committerNicolas Vollmar <nvo@scaling.ch>2024-07-01 08:52:13 +0200
commit2b051992294fad1729c124d72ab88fb241c0d39d (patch)
tree3dbbeb03b06e7643d74a30efb885597908ffb05a
parent83e88845f237d7b0fe257ec005a88b2c2839184b (diff)
downloadvyos-documentation-2b051992294fad1729c124d72ab88fb241c0d39d.tar.gz
vyos-documentation-2b051992294fad1729c124d72ab88fb241c0d39d.zip
T6477: Add documentation for telegraf loki output
-rw-r--r--docs/configuration/service/monitoring.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/configuration/service/monitoring.rst b/docs/configuration/service/monitoring.rst
index 245af067..10b4dee2 100644
--- a/docs/configuration/service/monitoring.rst
+++ b/docs/configuration/service/monitoring.rst
@@ -130,6 +130,36 @@ and logs from your routers.
Remote URL
+Loki
+====
+
+Telegraf can be used to send logs to Loki using tags as labels.
+
+.. cfgcmd:: set service monitoring telegraf loki port <port>
+
+ Remote Loki port
+
+ Default is 3100
+
+.. cfgcmd:: set service monitoring telegraf loki url <url>
+
+ Remote Loki url
+
+.. cfgcmd:: set service monitoring telegraf loki authentication username <username>
+.. cfgcmd:: set service monitoring telegraf loki authentication password <password>
+
+ HTTP basic authentication.
+
+ If either is set both must be set.
+
+.. cfgcmd:: set service monitoring telegraf loki metric-name-label <label>
+
+ Label to use for the metric name when sending metrics.
+
+ If set to an empty string, the label will not be added.
+ This is NOT recommended, as it makes it impossible to differentiate
+ between multiple metrics.
+
Example
=======