This is a cache of https://docs.openshift.com/container-platform/4.16/rest_api/monitoring_apis/monitoring-apis-index.html. It is a snapshot of the page at 2024-11-27T10:35:55.922+0000.
About Monitoring APIs - Monitoring APIs | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | Op<strong>e</strong>nShift Contain<strong>e</strong>r Platform 4.16
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
&times;

Monitoring APIs

Alertmanager [monitoring.coreos.com/v1]

Description

Alertmanager describes an Alertmanager cluster.

Type

object

AlertmanagerConfig [monitoring.coreos.com/v1beta1]

Description

AlertmanagerConfig configures the Prometheus Alertmanager, specifying how alerts should be grouped, inhibited and notified to external systems.

Type

object

AlertRelabelConfig [monitoring.openshift.io/v1]

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

AlertingRule [monitoring.openshift.io/v1]

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

PodMonitor [monitoring.coreos.com/v1]

Description

PodMonitor defines monitoring for a set of pods.

Type

object

Probe [monitoring.coreos.com/v1]

Description

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

Type

object

Prometheus [monitoring.coreos.com/v1]

Description

Prometheus defines a Prometheus deployment.

Type

object

PrometheusRule [monitoring.coreos.com/v1]

Description

PrometheusRule defines recording and alerting rules for a Prometheus instance

Type

object

ServiceMonitor [monitoring.coreos.com/v1]

Description

ServiceMonitor defines monitoring for a set of services.

Type

object

ThanosRuler [monitoring.coreos.com/v1]

Description

ThanosRuler defines a ThanosRuler deployment.

Type

object