From ae5a3cf020c112487b155f74856779f7b51d3611 Mon Sep 17 00:00:00 2001 From: Skyler Hawthorne Date: Sun, 2 Apr 2023 18:10:55 +0000 Subject: [PATCH] update prometheus docs for clarity (#1458) Make it clearer that the `/metrics` endpoint is under `/api/v1` Co-authored-by: Skyler Hawthorne Reviewed-on: https://kolaente.dev/vikunja/api/pulls/1458 Reviewed-by: konrad Co-authored-by: Skyler Hawthorne Co-committed-by: Skyler Hawthorne --- config.yml.sample | 2 +- docs/content/doc/setup/config.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/config.yml.sample b/config.yml.sample index db30341e2..8c59e0c4c 100644 --- a/config.yml.sample +++ b/config.yml.sample @@ -310,7 +310,7 @@ auth: # Prometheus metrics endpoint metrics: - # If set to true, enables a /metrics endpoint for prometheus to collect metrics about Vikunja. + # If set to true, enables a /metrics endpoint for prometheus to collect metrics about Vikunja. You can query it from `/api/v1/metrics`. enabled: false # If set to a non-empty value the /metrics endpoint will require this as a username via basic auth in combination with the password below. username: diff --git a/docs/content/doc/setup/config.md b/docs/content/doc/setup/config.md index ff63fde5e..52929aa2f 100644 --- a/docs/content/doc/setup/config.md +++ b/docs/content/doc/setup/config.md @@ -1154,7 +1154,7 @@ Prometheus metrics endpoint ### enabled -If set to true, enables a /metrics endpoint for prometheus to collect metrics about Vikunja. +If set to true, enables a /metrics endpoint for prometheus to collect metrics about Vikunja. You can query it from `/api/v1/metrics`. Default: `false`