docs: add a guide for monitoring Omni with Prometheus - #696
Merged
Conversation
Iheanacho-ai
reviewed
Aug 5, 2026
Iheanacho-ai
reviewed
Aug 5, 2026
Iheanacho-ai
approved these changes
Aug 5, 2026
utkuozdemir
force-pushed
the
docs/omni-exporter
branch
from
August 5, 2026 22:41
d866169 to
bc6f51e
Compare
Documents the Omni exporter, which exposes the state of the clusters, machines, machine sets, upgrades and etcd backups of an Omni instance as Prometheus metrics. The guide covers creating a read-only service account, running the exporter, adding a scrape job, restricting access to the metrics endpoint, the metric conventions that matter when writing queries against it, and troubleshooting. The metrics Omni exposes about itself are not reachable by external users of the SaaS offering, so the exporter is the way for a user to bring the state of their instance into their own monitoring stack. Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
utkuozdemir
force-pushed
the
docs/omni-exporter
branch
from
August 5, 2026 22:43
bc6f51e to
3a05b1b
Compare
Member
Author
|
/m |
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
3 participants
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.
Documents the Omni exporter, which exposes the state of the clusters, machines, machine sets, upgrades and etcd backups of an Omni instance as Prometheus metrics. The guide covers creating a read-only service account, running the exporter, adding a scrape job, restricting access to the metrics endpoint, the metric conventions that matter when writing queries against it, and troubleshooting.
The metrics Omni exposes about itself are not reachable by external users of the SaaS offering, so the exporter is the way for a user to bring the state of their instance into their own monitoring stack.
The page follows the section hierarchy agreed on #675.