Chapter 7. PodMonitor [monitoring.coreos.com/v1]
- Description
The
PodMonitorcustom resource definition (CRD) defines howPrometheusandPrometheusAgentcan scrape metrics from a group of pods. Among other things, it allows to specify: * The pods to scrape via label selectors. * The container ports to scrape. * Authentication credentials to use. * Target and metric relabeling.PrometheusandPrometheusAgentobjects selectPodMonitorobjects using label and namespace selectors.- Type
-
object - Required
-
spec
-
7.1. Specification Copy linkLink copied to clipboard!
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec defines the specification of desired Pod selection for target discovery by Prometheus. |
|
|
| status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled. Most recent observed status of the PodMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
7.1.1. .spec Copy linkLink copied to clipboard!
- Description
- spec defines the specification of desired Pod selection for target discovery by Prometheus.
- Type
-
object - Required
-
selector
-
| Property | Type | Description |
|---|---|---|
|
|
| attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.35.0. |
|
|
| bodySizeLimit when defined specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus. It requires Prometheus >= v2.28.0. |
|
|
| convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. |
|
|
| fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. |
|
|
|
jobLabel defines the label to use to retrieve the job name from.
For example if
If the value of this field is empty, the |
|
|
| keepDroppedTargets defines the 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 defines the per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0. |
|
|
| labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0. |
|
|
| labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0. |
|
|
|
namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the |
|
|
| nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. |
|
|
| nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. |
|
|
| podMetricsEndpoints defines how to scrape metrics from the selected pods. |
|
|
| PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus. |
|
|
|
podTargetLabels defines the labels which are transferred from the associated Kubernetes |
|
|
| sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted. |
|
|
| scrapeClass defines the scrape class to apply. |
|
|
| scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.
Notice: |
|
|
| scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. It requires Prometheus >= v2.49.0. |
|
|
|
selector defines the label selector to select the Kubernetes |
|
|
| selectorMechanism defines the mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated. It requires Prometheus >= v2.17.0. |
|
|
| targetLimit defines a limit on the number of scraped targets that will be accepted. |
7.1.2. .spec.attachMetadata Copy linkLink copied to clipboard!
- Description
attachMetadata defines additional metadata which is added to the discovered targets.
It requires Prometheus >= v2.35.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| node when set to true, Prometheus attaches node metadata to the discovered targets.
The Prometheus service account must have the |
7.1.3. .spec.namespaceSelector Copy linkLink copied to clipboard!
- Description
-
namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the
PodMonitorobject but it is possible to select pods across different/all namespaces. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. |
|
|
| matchNames defines the list of namespace names to select from. |
7.1.4. .spec.podMetricsEndpoints Copy linkLink copied to clipboard!
- Description
- podMetricsEndpoints defines how to scrape metrics from the selected pods.
- Type
-
array
7.1.5. .spec.podMetricsEndpoints[] Copy linkLink copied to clipboard!
- Description
- PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as |
|
|
| basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as |
|
|
| bearerTokenSecret defines a key of a Secret containing the bearer token used by the client for authentication. The secret needs to be in the same namespace as the custom resource and readable by the Prometheus Operator.
Cannot be set at the same time as
Deprecated: use |
|
|
| enableHttp2 can be used to disable HTTP2. |
|
|
| filterRunning 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 defines whether the client should follow HTTP 3xx redirects. |
|
|
| honorLabels when true preserves the metric’s labels when they collide with the target’s labels. |
|
|
| honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target. |
|
|
| interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval. |
|
|
| metricRelabelings defines the relabeling rules to apply to the samples before ingestion. |
|
|
| 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 |
|
|
| noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
| oauth2 defines the OAuth2 settings used by the client. It requires Prometheus >= 2.27.0.
Cannot be set at the same time as |
|
|
| params define optional HTTP URL parameters. |
|
|
| |
|
|
| path defines the HTTP path from which to scrape for metrics.
If empty, Prometheus uses the default value (e.g. |
|
|
|
port defines the If the pod doesn’t expose a port with the same name, it will result in no targets being discovered.
If a
It takes precedence over the |
|
|
|
portNumber defines the
The
This cannot be used to enable scraping of an undeclared port. To scrape targets on a port which isn’t exposed, you need to use relabeling to override the In practice Prometheus will select targets for which the matches the target’s __meta_kubernetes_pod_container_port_number. |
|
|
| proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| relabelings defines 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 More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
|
| 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 defines the HTTP scheme to use for scraping. |
|
|
| scrapeTimeout defines the 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. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. |
|
|
|
targetPort defines the name or number of the target port of the Deprecated: use 'port' or 'portNumber' instead. |
|
|
| tlsConfig defines the TLS configuration used by the client. |
|
|
|
trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if It requires Prometheus >= v2.48.0. |
7.1.6. .spec.podMetricsEndpoints[].authorization Copy linkLink copied to clipboard!
- Description
authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as
basicAuth,bearerTokenSecretoroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication. |
|
|
| type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" |
7.1.7. .spec.podMetricsEndpoints[].authorization.credentials Copy linkLink copied to clipboard!
- Description
- credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.8. .spec.podMetricsEndpoints[].basicAuth Copy linkLink copied to clipboard!
- Description
basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as
authorization,bearerTokenSecretoroauth2.- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| password defines a key of a Secret containing the password for authentication. |
|
|
| username defines a key of a Secret containing the username for authentication. |
7.1.9. .spec.podMetricsEndpoints[].basicAuth.password Copy linkLink copied to clipboard!
- Description
- password defines a key of a Secret containing the password for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.10. .spec.podMetricsEndpoints[].basicAuth.username Copy linkLink copied to clipboard!
- Description
- username defines a key of a Secret containing the username for authentication.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.11. .spec.podMetricsEndpoints[].bearerTokenSecret Copy linkLink copied to clipboard!
- Description
bearerTokenSecret defines a key of a Secret containing the bearer token used by the client for authentication. The secret needs to be in the same namespace as the custom resource and readable by the Prometheus Operator.
Cannot be set at the same time as
authorization,basicAuthoroauth2.Deprecated: use
authorizationinstead.- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.12. .spec.podMetricsEndpoints[].metricRelabelings Copy linkLink copied to clipboard!
- Description
- metricRelabelings defines the relabeling rules to apply to the samples before ingestion.
- Type
-
array
7.1.13. .spec.podMetricsEndpoints[].metricRelabelings[] Copy linkLink copied to clipboard!
- 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 |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. |
|
|
| targetLabel defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
7.1.14. .spec.podMetricsEndpoints[].oauth2 Copy linkLink copied to clipboard!
- Description
oauth2 defines the OAuth2 settings used by the client.
It requires Prometheus >= 2.27.0.
Cannot be set at the same time as
authorization,basicAuthorbearerTokenSecret.- Type
-
object - Required
-
clientId -
clientSecret -
tokenUrl
-
| Property | Type | Description |
|---|---|---|
|
|
| clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID. |
|
|
| clientSecret defines a key of a Secret containing the OAuth2 client’s secret. |
|
|
| endpointParams configures the HTTP parameters to append to the token URL. |
|
|
| noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
| proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
| |
|
|
| SecretKeySelector selects a key of a Secret. |
|
|
| proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. |
|
|
| proxyUrl defines the HTTP proxy server to use. |
|
|
| scopes defines the OAuth2 scopes used for the token request. |
|
|
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. |
|
|
| tokenUrl defines the URL to fetch the token from. |
7.1.15. .spec.podMetricsEndpoints[].oauth2.clientId Copy linkLink copied to clipboard!
- Description
- clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.16. .spec.podMetricsEndpoints[].oauth2.clientId.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.17. .spec.podMetricsEndpoints[].oauth2.clientId.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.18. .spec.podMetricsEndpoints[].oauth2.clientSecret Copy linkLink copied to clipboard!
- Description
- clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.19. .spec.podMetricsEndpoints[].oauth2.proxyConnectHeader Copy linkLink copied to clipboard!
- Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
object
7.1.20. .spec.podMetricsEndpoints[].oauth2.proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
7.1.21. .spec.podMetricsEndpoints[].oauth2.proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.22. .spec.podMetricsEndpoints[].oauth2.tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
7.1.23. .spec.podMetricsEndpoints[].oauth2.tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.24. .spec.podMetricsEndpoints[].oauth2.tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.25. .spec.podMetricsEndpoints[].oauth2.tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.26. .spec.podMetricsEndpoints[].oauth2.tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.27. .spec.podMetricsEndpoints[].oauth2.tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.28. .spec.podMetricsEndpoints[].oauth2.tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.29. .spec.podMetricsEndpoints[].oauth2.tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.30. .spec.podMetricsEndpoints[].params Copy linkLink copied to clipboard!
- Description
- params define optional HTTP URL parameters.
- Type
-
object
7.1.31. .spec.podMetricsEndpoints[].proxyConnectHeader Copy linkLink copied to clipboard!
- Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
- Type
-
object
7.1.32. .spec.podMetricsEndpoints[].proxyConnectHeader{} Copy linkLink copied to clipboard!
- Description
- Type
-
array
7.1.33. .spec.podMetricsEndpoints[].proxyConnectHeader{}[] Copy linkLink copied to clipboard!
- Description
- SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.34. .spec.podMetricsEndpoints[].relabelings Copy linkLink copied to clipboard!
- Description
relabelings defines 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_namelabel.More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
- Type
-
array
7.1.35. .spec.podMetricsEndpoints[].relabelings[] Copy linkLink copied to clipboard!
- 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 |
|---|---|---|
|
|
| action to perform based on the regex matching.
Default: "Replace" |
|
|
| modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
| regex defines the regular expression against which the extracted value is matched. |
|
|
| replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. |
|
|
| separator defines the string between concatenated SourceLabels. |
|
|
| sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. |
|
|
| targetLabel defines the label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. |
7.1.36. .spec.podMetricsEndpoints[].tlsConfig Copy linkLink copied to clipboard!
- Description
- tlsConfig defines the TLS configuration used by the client.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| ca defines the Certificate authority used when verifying server certificates. |
|
|
| cert defines the Client certificate to present when doing client-authentication. |
|
|
| insecureSkipVerify defines how to disable target certificate validation. |
|
|
| keySecret defines the Secret containing the client key file for the targets. |
|
|
| maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. |
|
|
| minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. |
|
|
| serverName is used to verify the hostname for the targets. |
7.1.37. .spec.podMetricsEndpoints[].tlsConfig.ca Copy linkLink copied to clipboard!
- Description
- ca defines the Certificate authority used when verifying server certificates.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.38. .spec.podMetricsEndpoints[].tlsConfig.ca.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.39. .spec.podMetricsEndpoints[].tlsConfig.ca.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.40. .spec.podMetricsEndpoints[].tlsConfig.cert Copy linkLink copied to clipboard!
- Description
- cert defines the Client certificate to present when doing client-authentication.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| configMap defines the ConfigMap containing data to use for the targets. |
|
|
| secret defines the Secret containing data to use for the targets. |
7.1.41. .spec.podMetricsEndpoints[].tlsConfig.cert.configMap Copy linkLink copied to clipboard!
- Description
- configMap defines the ConfigMap containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key to select. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the ConfigMap or its key must be defined |
7.1.42. .spec.podMetricsEndpoints[].tlsConfig.cert.secret Copy linkLink copied to clipboard!
- Description
- secret defines the Secret containing data to use for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.43. .spec.podMetricsEndpoints[].tlsConfig.keySecret Copy linkLink copied to clipboard!
- Description
- keySecret defines the Secret containing the client key file for the targets.
- Type
-
object - Required
-
key
-
| Property | Type | Description |
|---|---|---|
|
|
| The key of the secret to select from. Must be a valid secret key. |
|
|
| Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Specify whether the Secret or its key must be defined |
7.1.44. .spec.selector Copy linkLink copied to clipboard!
- Description
-
selector defines the label selector to select the Kubernetes
Podobjects to scrape metrics from. - Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
| 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. |
7.1.45. .spec.selector.matchExpressions Copy linkLink copied to clipboard!
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
-
array
7.1.46. .spec.selector.matchExpressions[] Copy linkLink copied to clipboard!
- 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 |
|---|---|---|
|
|
| key is the label key that the selector applies to. |
|
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
| 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. |
7.1.47. .status Copy linkLink copied to clipboard!
- Description
status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.
Most recent observed status of the PodMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. |
|
|
| WorkloadBinding is a link between a configuration resource and a workload resource. |
7.1.48. .status.bindings Copy linkLink copied to clipboard!
- Description
- bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
- Type
-
array
7.1.49. .status.bindings[] Copy linkLink copied to clipboard!
- Description
- WorkloadBinding is a link between a configuration resource and a workload resource.
- Type
-
object - Required
-
group -
name -
namespace -
resource
-
| Property | Type | Description |
|---|---|---|
|
|
| conditions defines the current state of the configuration resource when bound to the referenced Workload object. |
|
|
| ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. |
|
|
| group defines the group of the referenced resource. |
|
|
| name defines the name of the referenced object. |
|
|
| namespace defines the namespace of the referenced object. |
|
|
| resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). |
7.1.50. .status.bindings[].conditions Copy linkLink copied to clipboard!
- Description
- conditions defines the current state of the configuration resource when bound to the referenced Workload object.
- Type
-
array
7.1.51. .status.bindings[].conditions[] Copy linkLink copied to clipboard!
- Description
- ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
- Type
-
object - Required
-
lastTransitionTime -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime defines the time of the last update to the current status property. |
|
|
| message defines the human-readable message indicating details for the condition’s last transition. |
|
|
|
observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if |
|
|
| reason for the condition’s last transition. |
|
|
| status of the condition. |
|
|
| type of the condition being reported. Currently, only "Accepted" is supported. |
7.2. API endpoints Copy linkLink copied to clipboard!
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/namespaces/{namespace}/podmonitors/{name}/status-
GET: read status of the specified PodMonitor -
PATCH: partially update status of the specified PodMonitor -
PUT: replace status of the specified PodMonitor
-
7.2.1. /apis/monitoring.coreos.com/v1/podmonitors Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
7.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
7.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PodMonitor |
- HTTP method
-
DELETE - Description
- delete a PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
7.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PodMonitor |
- HTTP method
-
GET - Description
- read status of the specified PodMonitor
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified PodMonitor
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |