Repository navigation
docs(admin): document classic and native histograms - #1239
Draft
pbleser-oc wants to merge 2 commits into
Draft
pbleser-oc wants to merge 2 commits into
pbleser-oc wants to merge 2 commits 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
Update the page "Monitoring with Prometheus" for the changes to the histograms in opencloud-eu/opencloud#3817: - the duration histograms are exposed in both classic and native form (opencloud-eu/opencloud#3825), with at most 100 native buckets; - how to switch to native histograms without losing data, with always_scrape_classic_histograms, including a warning for setups that already have native histograms enabled when they upgrade; - PromQL examples for both forms side by side; - the shared bucket sets and the histograms whose bucket boundaries change (opencloud-eu/opencloud#3828); - the deprecated latency Summaries of invitations and webfinger, and the histograms to use instead (opencloud-eu/opencloud#3827); - the list of duration histograms with their bucket sets and native form. Fixes opencloud-eu#1235
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 #1235 (part of opencloud-eu/opencloud#3817)
Note
This builds on #1238, which adds the page "Monitoring with Prometheus"; its commit is included here until it is merged. Only the last commit, bd07a58, belongs to this PR: see the diff of that commit.
It documents OpenCloud PRs that are not merged yet: opencloud-eu/opencloud#3825 (classic and native histograms), opencloud-eu/opencloud#3827 (deprecated Summaries) and opencloud-eu/opencloud#3828 (bucket sets). It stays a draft until they are merged.
Changes
Updates the page "Monitoring with Prometheus" for the changes to the histograms:
always_scrape_classic_histograms, in four steps, including a warning for setups that already have native histograms enabled when they upgrade OpenCloud.Checks
pnpm build --locale en,prettier --checkandmarkdownlint-cli2pass for the changed files (the broken anchors that the build reports are on existing developer pages).