ami/tl-vikunja
1
0
Fork 0
Code

update prometheus docs for clarity (#1458)

Browse Source 
Make it clearer that the `/metrics` endpoint is under `/api/v1`

Co-authored-by: Skyler Hawthorne <skyler@dead10ck.com>
Reviewed-on: https://kolaente.dev/vikunja/api/pulls/1458
Reviewed-by: konrad <k@knt.li>
Co-authored-by: Skyler Hawthorne <dead10ck@noreply.kolaente.de>
Co-committed-by: Skyler Hawthorne <dead10ck@noreply.kolaente.de>
This commit is contained in:
Skyler Hawthorne 2023-04-02 18:10:55 +00:00 committed by konrad
parent 01fb738dc8
commit ae5a3cf020
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
config.yml.sample
View File

@ -310,7 +310,7 @@ auth:
# Prometheus metrics endpoint # Prometheus metrics endpoint
metrics: 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 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. # 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: username:

2
docs/content/doc/setup/config.md
View File

@ -1154,7 +1154,7 @@ Prometheus metrics endpoint
### enabled ### 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` Default: `false`