PodMonitor [monitoring.coreos.com/v1] - Monitoring APIs | API reference | OpenShift Container Platform 4.15

Specification
API endpoints

Description

PodMonitor defines monitoring for a set of pods.

Type

object

Required

spec

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the ReST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	Specification of desired Pod selection for target discovery by Prometheus.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the ReST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

Specification of desired Pod selection for target discovery by Prometheus.

.spec

Description

Specification of desired Pod selection for target discovery by Prometheus.

Type

object

Required

selector

Property Type Description

Property	Type	Description
`attachMetadata`	`object`	`attachMetadata` defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.37.0.
`jobLabel`	`string`	The label to use to retrieve the job name from. `jobLabel` selects the label from the associated Kubernetes `Pod` object which will be used as the `job` label for all metrics. For example if `jobLabel` is set to `foo` and the Kubernetes `Pod` object is labeled with `foo: bar`, then Prometheus adds the `job="bar"` label to all ingested metrics. If the value of this field is empty, the `job` label of the metrics defaults to the namespace and name of the PodMonitor object (e.g. `<namespace>/<name>`).
`keepDroppedTargets`	`integer`	Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0.
`labelLimit`	`integer`	Per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0.
`labelNameLengthLimit`	`integer`	Per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0.
`labelValueLengthLimit`	`integer`	Per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0.
`namespaceSelector`	`object`	Selector to select which namespaces the Kubernetes `Pods` objects are discovered from.
`podMetricsendpoints`	`array`	List of endpoints part of this PodMonitor.
`podMetricsendpoints[]`	`object`	PodMetricsendpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
`podTargetLabels`	`array (string)`	`podTargetLabels` defines the labels which are transferred from the associated Kubernetes `Pod` object onto the ingested metrics.
`sampleLimit`	`integer`	`sampleLimit` defines a per-scrape limit on the number of scraped samples that will be accepted.
`selector`	`object`	Label selector to select the Kubernetes `Pod` objects.
`targetLimit`	`integer`	`targetLimit` defines a limit on the number of scraped targets that will be accepted.

attachMetadata

object

attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.37.0.

jobLabel

string

The label to use to retrieve the job name from. jobLabel selects the label from the associated Kubernetes Pod object which will be used as the job label for all metrics. For example if jobLabel is set to foo and the Kubernetes Pod object is labeled with foo: bar, then Prometheus adds the job="bar" label to all ingested metrics. If the value of this field is empty, the job label of the metrics defaults to the namespace and name of the PodMonitor object (e.g. <namespace>/<name>).

keepDroppedTargets

integer

Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0.

labelLimit

integer

Per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0.

labelNameLengthLimit

integer

Per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0.

labelValueLengthLimit

integer

Per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0.

namespaceSelector

object

Selector to select which namespaces the Kubernetes Pods objects are discovered from.

podMetricsendpoints

array

List of endpoints part of this PodMonitor.

podMetricsendpoints[]

object

PodMetricsendpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.

podTargetLabels

array (string)

podTargetLabels defines the labels which are transferred from the associated Kubernetes Pod object onto the ingested metrics.

sampleLimit

integer

sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted.

selector

object

Label selector to select the Kubernetes Pod objects.

targetLimit

integer

targetLimit defines a limit on the number of scraped targets that will be accepted.

.spec.attachMetadata

Description: attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.37.0.
Type: object

Property Type Description

Property	Type	Description
`node`	`boolean`	When set to true, Prometheus must have the `get` permission on the `Nodes` objects.

node

boolean

When set to true, Prometheus must have the get permission on the Nodes objects.

.spec.namespaceSelector

Description: Selector to select which namespaces the Kubernetes Pods objects are discovered from.
Type: object

Property Type Description

Property	Type	Description
`any`	`boolean`	Boolean describing whether all namespaces are selected in contrast to a list restricting them.
`matchNames`	`array (string)`	List of namespace names to select from.

any

boolean

Boolean describing whether all namespaces are selected in contrast to a list restricting them.

matchNames

array (string)

List of namespace names to select from.

.spec.podMetricsendpoints

Description: List of endpoints part of this PodMonitor.
Type: array

.spec.podMetricsendpoints[]

Description: PodMetricsendpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
Type: object

Property Type Description

Property	Type	Description
`authorization`	`object`	`authorization` configures the Authorization header credentials to use when scraping the target. Cannot be set at the same time as `basicAuth`, or `oauth2`.
`basicAuth`	`object`	`basicAuth` configures the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as `authorization`, or `oauth2`.
`bearerTokenSecret`	`object`	`bearerTokenSecret` specifies a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the PodMonitor object and readable by the Prometheus Operator. Deprecated: use `authorization` instead.
`enableHttp2`	`boolean`	`enableHttp2` can be used to disable HTTP2 when scraping the target.
`filterRunning`	`boolean`	When true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery. If unset, the filtering is enabled. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase
`followRedirects`	`boolean`	`followRedirects` defines whether the scrape requests should follow HTTP 3xx redirects.
`honorLabels`	`boolean`	When true, `honorLabels` preserves the metric’s labels when they collide with the target’s labels.
`honorTimestamps`	`boolean`	`honorTimestamps` controls whether Prometheus preserves the timestamps when exposed by the target.
`interval`	`string`	Interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval.
`metricRelabelings`	`array`	`metricRelabelings` configures the relabeling rules to apply to the samples before ingestion.
`metricRelabelings[]`	`object`	RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
`oauth2`	`object`	`oauth2` configures the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0. Cannot be set at the same time as `authorization`, or `basicAuth`.
`params`	`object`	`params` define optional HTTP URL parameters.
`params{}`	`array (string)`
`path`	`string`	HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`).
`port`	`string`	Name of the Pod port which this endpoint refers to. It takes precedence over `targetPort`.
`proxyUrl`	`string`	`proxyURL` configures the HTTP Proxy URL (e.g. "http://proxyserver:2195") to go through when scraping the target.
`relabelings`	`array`	`relabelings` configures the relabeling rules to apply the target’s metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job’s name is available via the `\__tmp_prometheus_job_name` label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
`relabelings[]`	`object`	RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
`scheme`	`string`	HTTP scheme to use for scraping. `http` and `https` are the expected values unless you rewrite the `scheme` label via relabeling. If empty, Prometheus uses the default value `http`.
`scrapeTimeout`	`string`	Timeout after which Prometheus considers the scrape to be failed. If empty, Prometheus uses the global scrape timeout unless it is less than the target’s scrape interval value in which the latter is used.
`targetPort`	`integer-or-string`	Name or number of the target port of the `Pod` object behind the Service, the port must be specified with container port property. Deprecated: use 'port' instead.
`tlsConfig`	`object`	TLS configuration to use when scraping the target.
`trackTimestampsStaleness`	`boolean`	`trackTimestampsStaleness` defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. It requires Prometheus >= v2.48.0.

authorization

object

authorization configures the Authorization header credentials to use when scraping the target. Cannot be set at the same time as basicAuth, or oauth2.

basicAuth

object

basicAuth configures the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as authorization, or oauth2.

bearerTokenSecret

object

bearerTokenSecret specifies a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the PodMonitor object and readable by the Prometheus Operator. Deprecated: use authorization instead.

enableHttp2

boolean

enableHttp2 can be used to disable HTTP2 when scraping the target.

filterRunning

boolean

When true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery. If unset, the filtering is enabled. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

followRedirects

boolean

followRedirects defines whether the scrape requests should follow HTTP 3xx redirects.

honorLabels

boolean

When true, honorLabels preserves the metric’s labels when they collide with the target’s labels.

honorTimestamps

boolean

honorTimestamps controls whether Prometheus preserves the timestamps when exposed by the target.

interval

string

Interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval.

metricRelabelings

array

metricRelabelings configures the relabeling rules to apply to the samples before ingestion.

metricRelabelings[]

object

RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

oauth2

object

oauth2 configures the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0. Cannot be set at the same time as authorization, or basicAuth.

params

object

params define optional HTTP URL parameters.

params{}

array (string)

path

string

HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics).

port

string

Name of the Pod port which this endpoint refers to. It takes precedence over targetPort.

proxyUrl

string

proxyURL configures the HTTP Proxy URL (e.g. "http://proxyserver:2195") to go through when scraping the target.

relabelings

array

relabelings configures the relabeling rules to apply the target’s metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job’s name is available via the \__tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

scheme

string

HTTP scheme to use for scraping. http and https are the expected values unless you rewrite the scheme label via relabeling. If empty, Prometheus uses the default value http.

scrapeTimeout

string

Timeout after which Prometheus considers the scrape to be failed. If empty, Prometheus uses the global scrape timeout unless it is less than the target’s scrape interval value in which the latter is used.

targetPort

integer-or-string

Name or number of the target port of the Pod object behind the Service, the port must be specified with container port property. Deprecated: use 'port' instead.

tlsConfig

object

TLS configuration to use when scraping the target.

trackTimestampsStaleness

boolean

trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if honorTimestamps is false. It requires Prometheus >= v2.48.0.

.spec.podMetricsendpoints[].authorization

Description: authorization configures the Authorization header credentials to use when scraping the target. Cannot be set at the same time as basicAuth, or oauth2.
Type: object

Property Type Description

Property	Type	Description
`credentials`	`object`	Selects a key of a Secret in the namespace that contains the credentials for authentication.
`type`	`string`	Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"

credentials

object

Selects a key of a Secret in the namespace that contains the credentials for authentication.

type

string

Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"

.spec.podMetricsendpoints[].authorization.credentials

Description

Selects a key of a Secret in the namespace that contains the credentials for authentication.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].basicAuth

Description: basicAuth configures the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as authorization, or oauth2.
Type: object

Property Type Description

Property	Type	Description
`password`	`object`	`password` specifies a key of a Secret containing the password for authentication.
`username`	`object`	`username` specifies a key of a Secret containing the username for authentication.

password

object

password specifies a key of a Secret containing the password for authentication.

username

object

username specifies a key of a Secret containing the username for authentication.

.spec.podMetricsendpoints[].basicAuth.password

Description

password specifies a key of a Secret containing the password for authentication.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].basicAuth.username

Description

username specifies a key of a Secret containing the username for authentication.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].bearerTokenSecret

Description

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].metricRelabelings

Description: metricRelabelings configures the relabeling rules to apply to the samples before ingestion.
Type: array

.spec.podMetricsendpoints[].metricRelabelings[]

Description: RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type: object

Property Type Description

Property	Type	Description
`action`	`string`	Action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `Dropequal` and `Keepequal` actions require Prometheus >= v2.41.0. Default: "Replace"
`modulus`	`integer`	Modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`.
`regex`	`string`	Regular expression against which the extracted value is matched.
`replacement`	`string`	Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.
`separator`	`string`	Separator is the string between concatenated SourceLabels.
`sourceLabels`	`array (string)`	The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
`targetLabel`	`string`	Label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `Keepequal` and `Dropequal` actions. Regex capture groups are available.

action

string

Action to perform based on the regex matching. Uppercase and Lowercase actions require Prometheus >= v2.36.0. Dropequal and Keepequal actions require Prometheus >= v2.41.0. Default: "Replace"

modulus

integer

Modulus to take of the hash of the source label values. Only applicable when the action is HashMod.

regex

string

Regular expression against which the extracted value is matched.

replacement

string

Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.

separator

string

Separator is the string between concatenated SourceLabels.

sourceLabels

array (string)

The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

Label to which the resulting string is written in a replacement. It is mandatory for Replace, HashMod, Lowercase, Uppercase, Keepequal and Dropequal actions. Regex capture groups are available.

.spec.podMetricsendpoints[].oauth2

Description

oauth2 configures the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0. Cannot be set at the same time as authorization, or basicAuth.

Type

object

Required

clientId
clientSecret
tokenUrl

Property Type Description

Property	Type	Description
`clientId`	`object`	`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
`clientSecret`	`object`	`clientSecret` specifies a key of a Secret containing the OAuth2 client’s secret.
`endpointParams`	`object (string)`	`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes`	`array (string)`	`scopes` defines the OAuth2 scopes used for the token request.
`tokenUrl`	`string`	`tokenURL` configures the URL to fetch the token from.

clientId

object

clientId specifies a key of a Secret or ConfigMap containing the OAuth2 client’s ID.

clientSecret

object

clientSecret specifies a key of a Secret containing the OAuth2 client’s secret.

endpointParams

object (string)

endpointParams configures the HTTP parameters to append to the token URL.

scopes

array (string)

scopes defines the OAuth2 scopes used for the token request.

tokenUrl

string

tokenURL configures the URL to fetch the token from.

.spec.podMetricsendpoints[].oauth2.clientId

Description: clientId specifies a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type: object

Property Type Description

Property	Type	Description
`configMap`	`object`	ConfigMap containing data to use for the targets.
`secret`	`object`	Secret containing data to use for the targets.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.podMetricsendpoints[].oauth2.clientId.configMap

Description

ConfigMap containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key to select.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the ConfigMap or its key must be defined

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.podMetricsendpoints[].oauth2.clientId.secret

Description

Secret containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].oauth2.clientSecret

Description

clientSecret specifies a key of a Secret containing the OAuth2 client’s secret.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].params

Description: params define optional HTTP URL parameters.
Type: object

.spec.podMetricsendpoints[].relabelings

Description: relabelings configures the relabeling rules to apply the target’s metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job’s name is available via the \__tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type: array

.spec.podMetricsendpoints[].relabelings[]

Description: RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type: object

Property Type Description

Property	Type	Description
`action`	`string`	Action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `Dropequal` and `Keepequal` actions require Prometheus >= v2.41.0. Default: "Replace"
`modulus`	`integer`	Modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`.
`regex`	`string`	Regular expression against which the extracted value is matched.
`replacement`	`string`	Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.
`separator`	`string`	Separator is the string between concatenated SourceLabels.
`sourceLabels`	`array (string)`	The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
`targetLabel`	`string`	Label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `Keepequal` and `Dropequal` actions. Regex capture groups are available.

action

string

Action to perform based on the regex matching. Uppercase and Lowercase actions require Prometheus >= v2.36.0. Dropequal and Keepequal actions require Prometheus >= v2.41.0. Default: "Replace"

modulus

integer

Modulus to take of the hash of the source label values. Only applicable when the action is HashMod.

regex

string

Regular expression against which the extracted value is matched.

replacement

string

Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.

separator

string

Separator is the string between concatenated SourceLabels.

sourceLabels

array (string)

The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel

string

.spec.podMetricsendpoints[].tlsConfig

Description: TLS configuration to use when scraping the target.
Type: object

Property Type Description

Property	Type	Description
`ca`	`object`	Certificate authority used when verifying server certificates.
`cert`	`object`	Client certificate to present when doing client-authentication.
`insecureSkipVerify`	`boolean`	Disable target certificate validation.
`keySecret`	`object`	Secret containing the client key file for the targets.
`serverName`	`string`	Used to verify the hostname for the targets.

ca

object

Certificate authority used when verifying server certificates.

cert

object

Client certificate to present when doing client-authentication.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

.spec.podMetricsendpoints[].tlsConfig.ca

Description: Certificate authority used when verifying server certificates.
Type: object

Property Type Description

Property	Type	Description
`configMap`	`object`	ConfigMap containing data to use for the targets.
`secret`	`object`	Secret containing data to use for the targets.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.podMetricsendpoints[].tlsConfig.ca.configMap

Description

ConfigMap containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key to select.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the ConfigMap or its key must be defined

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.podMetricsendpoints[].tlsConfig.ca.secret

Description

Secret containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].tlsConfig.cert

Description: Client certificate to present when doing client-authentication.
Type: object

Property Type Description

Property	Type	Description
`configMap`	`object`	ConfigMap containing data to use for the targets.
`secret`	`object`	Secret containing data to use for the targets.

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.podMetricsendpoints[].tlsConfig.cert.configMap

Description

ConfigMap containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key to select.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the ConfigMap or its key must be defined

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.podMetricsendpoints[].tlsConfig.cert.secret

Description

Secret containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.podMetricsendpoints[].tlsConfig.keySecret

Description

Secret containing the client key file for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.selector

Description: Label selector to select the Kubernetes Pod objects.
Type: object

Property Type Description

Property	Type	Description
`matchexpressions`	`array`	matchexpressions is a list of label selector requirements. The requirements are ANDed.
`matchexpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (string)`	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchexpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchexpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.selector.matchexpressions

Description: matchexpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.selector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.
`values`	`array (string)`	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is exists or DoesNotexist, the values array must be empty. This array is replaced during a strategic merge patch.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is exists or DoesNotexist, the values array must be empty. This array is replaced during a strategic merge patch.

API endpoints

The following API endpoints are available:

/apis/monitoring.coreos.com/v1/podmonitors
- GeT: list objects of kind PodMonitor
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors
- DeLeTe: delete collection of PodMonitor
- GeT: list objects of kind PodMonitor
- POST: create a PodMonitor
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}
- DeLeTe: delete a PodMonitor
- GeT: read the specified PodMonitor
- PATCH: partially update the specified PodMonitor
- PUT: replace the specified PodMonitor

/apis/monitoring.coreos.com/v1/podmonitors

HTTP method: GeT
Description: list objects of kind PodMonitor

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`PodMonitorList` schema
401 - Unauthorized	empty

/apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors

HTTP method: DeLeTe
Description: delete collection of PodMonitor

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: list objects of kind PodMonitor

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`PodMonitorList` schema
401 - Unauthorized	empty

HTTP method: POST
Description: create a PodMonitor

Table 4. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 5. Body parameters
Parameter	Type	Description
`body`	`PodMonitor` schema

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`PodMonitor` schema
201 - Created	`PodMonitor` schema
202 - Accepted	`PodMonitor` schema
401 - Unauthorized	empty

/apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}

Table 7. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PodMonitor

HTTP method: DeLeTe
Description: delete a PodMonitor

Table 8. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: read the specified PodMonitor

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`PodMonitor` schema
401 - Unauthorized	empty

HTTP method: PATCH
Description: partially update the specified PodMonitor

Table 11. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`PodMonitor` schema
401 - Unauthorized	empty

HTTP method: PUT
Description: replace the specified PodMonitor

Table 13. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 14. Body parameters
Parameter	Type	Description
`body`	`PodMonitor` schema

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`PodMonitor` schema
201 - Created	`PodMonitor` schema
401 - Unauthorized	empty