Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 1. Monitoring APIs

1.1. Alertmanager [monitoring.coreos.com/v1]
Copy link

Description
Alertmanager describes an Alertmanager cluster.
Type
object
Description
AlertmanagerConfig configures the Prometheus Alertmanager, specifying how alerts should be grouped, inhibited and notified to external systems.
Type
object
Description
AlertRelabelConfig defines a set of relabel configs for alerts. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type
object

1.4. AlertingRule [monitoring.openshift.io/v1]
Copy link

Description
AlertingRule represents a set of user-defined Prometheus rule groups containing alerting rules. This resource is the supported method for cluster admins to create alerts based on metrics recorded by the platform monitoring stack in OpenShift, i.e. the Prometheus instance deployed to the openshift-monitoring namespace. You might use this to create custom alerting rules not shipped with OpenShift based on metrics from components such as the node_exporter, which provides machine-level metrics such as CPU usage, or kube-state-metrics, which provides metrics on Kubernetes usage. The API is mostly compatible with the upstream PrometheusRule type from the prometheus-operator. The primary difference being that recording rules are not allowed here — only alerting rules. For each AlertingRule resource created, a corresponding PrometheusRule will be created in the openshift-monitoring namespace. OpenShift requires admins to use the AlertingRule resource rather than the upstream type in order to allow better OpenShift specific defaulting and validation, while not modifying the upstream APIs directly. You can find upstream API documentation for PrometheusRule resources here: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type
object

1.5. PodMonitor [monitoring.coreos.com/v1]
Copy link

Description
PodMonitor defines monitoring for a set of pods.
Type
object

1.6. Probe [monitoring.coreos.com/v1]
Copy link

Description
Probe defines monitoring for a set of static targets or ingresses.
Type
object

1.7. Prometheus [monitoring.coreos.com/v1]
Copy link

Description
Prometheus defines a Prometheus deployment.
Type
object

1.8. PrometheusRule [monitoring.coreos.com/v1]
Copy link

Description
PrometheusRule defines recording and alerting rules for a Prometheus instance
Type
object

1.9. ServiceMonitor [monitoring.coreos.com/v1]
Copy link

Description
ServiceMonitor defines monitoring for a set of services.
Type
object

1.10. ThanosRuler [monitoring.coreos.com/v1]
Copy link

Description
ThanosRuler defines a ThanosRuler deployment.
Type
object
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat