Repository navigation
docs(admin): document monitoring with Prometheus - #1238
Open
pbleser-oc wants to merge 1 commit into
Open
pbleser-oc wants to merge 1 commit into
pbleser-oc wants to merge 1 commit into
Conversation
Add the admin page "Monitoring with Prometheus", as OpenCloud works today: where OpenCloud exposes its metrics (debug servers, one endpoint per process, the OpenCloud Compose monitoring files, the debug token), a Prometheus scrape configuration, and the duration histograms: classic histograms with their buckets and PromQL examples, the native-only request duration histogram of the proxy with its classic fallbacks, how to enable native histograms per Prometheus version, and a list of all duration histograms. Fixes opencloud-eu#1237
pbleser-oc
added
Priority:p4-low
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1237
Changes
A new admin page, Monitoring with Prometheus (
docs/admin/configuration/monitoring.md, listed in the configuration index after Logging). The admin docs had no page about metrics yet. It documents how OpenCloud works today:*_DEBUG_ADDR, path/metrics); in a single OpenCloud process all debug endpoints return the same metrics, so one endpoint is enough; the default address only accepts local connections.monitoring/monitoring.ymlandmonitoring/monitoring-collaboration.yml(and theopencloud-netnetwork), and how to check them.*_DEBUG_TOKEN, sent as a bearer token, and how to generate a random token on Linux and macOS._bucket/_count/_sum, example output, the default buckets), native histograms, and how to enable them per Prometheus version (--enable-feature=native-histogramsup to 3.7,scrape_native_histogramsfrom 3.8 on).opencloud_proxy_request_duration_secondsand its classic fallbacks, with PromQL examples for setups with and without native histograms.The changes to the histograms from opencloud-eu/opencloud#3817 are documented separately, on top of this page, in #1235.
Checks
pnpm build --locale en,prettier --checkandmarkdownlint-cli2pass for the changed files (the broken anchors that the build reports are on existing developer pages).