From 0e8c527982f245ed9192711ab2ed1792715dcd39 Mon Sep 17 00:00:00 2001 From: hyperdefined Date: Sun, 1 Jun 2025 20:21:04 -0400 Subject: [PATCH] docs/api-env-variables: add metrics vars --- docs/api-env-variables.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/api-env-variables.md b/docs/api-env-variables.md index 92e7a6cf..a84601aa 100644 --- a/docs/api-env-variables.md +++ b/docs/api-env-variables.md @@ -64,6 +64,14 @@ this document is not final and will expand over time. feel free to improve it! [*view details*](#service-specific) +### prometheus metrics vars +| name | value example | +|:---------------------------------|:-------------------------| +| METRICS | `1` | +| METRICS_PORT | `9100` | + +[*view details*](#metrics) + ## general [*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. 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. \ No newline at end of file