mirrors/cobalt
1
0
Fork 0
mirror of https://github.com/imputnet/cobalt.git synced 2025-06-28 17:38:31 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

docs/api-env-variables: add metrics vars

Browse Source
This commit is contained in:
hyperdefined 2025-06-01 20:21:04 -04:00
parent c9dc352f62
commit 0e8c527982
No known key found for this signature in database
GPG Key ID: 38C93C4835071D4A
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/api-env-variables.md
View File

@ -64,6 +64,14 @@ this document is not final and will expand over time. feel free to improve it!
[*view details*](#service-specific) [*view details*](#service-specific)
### prometheus metrics vars
| name | value example |
|:---------------------------------|:-------------------------|
| METRICS | `1` |
| METRICS_PORT | `9100` |
[*view details*](#metrics)
## general ## general
[*jump to the table*](#general-vars) [*jump to the table*](#general-vars)
@ -256,3 +264,16 @@ the value is a string.
when set to `1`, cobalt will try to use higher quality audio if user requests it via `youtubeBetterAudio`. will negatively impact the rate limit of a secondary youtube client with a session. when set to `1`, cobalt will try to use higher quality audio if user requests it via `youtubeBetterAudio`. will negatively impact the rate limit of a secondary youtube client with a session.
the value is a number, either `0` or `1`. the value is a number, either `0` or `1`.
## prometheus metrics
[*jump to the table*](#prometheus-metrics-vars)
### METRICS
enable prometheus compatible metrics. metrics include: successful/failed requests to services, http requests, and http requests duration.
the value is a number, either `0` or `1`.
### METRICS_PORT
port from which the metrics will be server under. these are local to the container/host.
the value is a number from 1024 to 65535.