Skip to content

Commit

Permalink
T6477: Add documentation for telegraf loki output
Browse files Browse the repository at this point in the history
  • Loading branch information
nvollmar committed Jul 1, 2024
1 parent 83e8884 commit 6ad2ee6
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ $ git clone https://github.com/vyos/vyos-documentation.git

$ cd vyos-documentation

$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make html
$ docker run --platform linux/amd64 --rm -it -v "$(pwd)":/vyos:Z -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make html

# For sphinx autobuild
$ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make livehtml
Expand Down
30 changes: 30 additions & 0 deletions docs/configuration/service/monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down

0 comments on commit 6ad2ee6

Please sign in to comment.