From 1ea821a6c35cc9a8057380f05ab6815d433c406b Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 10 Sep 2021 23:01:33 -0400 Subject: [PATCH] docs: document the vector-logs command --- docs/deployment/logs.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/deployment/logs.md b/docs/deployment/logs.md index 50ba2bb76..69bdb6796 100644 --- a/docs/deployment/logs.md +++ b/docs/deployment/logs.md @@ -37,7 +37,7 @@ You can use these modifiers as follows: dokku logs node-js-app -t -p web ``` -will show logs continually from the web process. +The above command will show logs continually from the web process. ### Failed deploy logs @@ -127,6 +127,29 @@ dokku logs:vector-stop The `vector` container will be stopped and removed from the system. If the container is not running, this command will do nothing. +#### Checking Vector's Logs + +It may be necessary to check the vector container's logs to ensure that vector is operating as expected. This can be performed with the `logs:vector-logs` command. + +```shell +dokku logs:vector-logs +``` + +This command also supports the following modifiers: + +```shell +--num NUM # the number of lines to display +--tail # continually stream logs +``` + +You can use these modifiers as follows: + +```shell +dokku logs:vector-logs --tail --num 10 +``` + +The above command will show logs continually from the vector container, with an initial history of 10 log lines + #### Configuring a log sink Vector uses the concept of log "sinks" to send logs to a given endpoint. Log sinks may be configured globally or on a per-app basis by specifying a `vector-sink` in DSN form with the `logs:set` command. Specifying a sink value will reload any running vector container.