PodMonitor.spec.podMetricsEndpoints[]
PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
| Field / Type | Description |
|---|---|
`authorization` configures the Authorization header credentials to use when scraping the target. Cannot be set at the same time as `basicAuth`, or `oauth2`. | |
`basicAuth` configures the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as `authorization`, or `oauth2`. | |
`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 | `enableHttp2` can be used to disable HTTP2 when scraping the target. |
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 | `followRedirects` defines whether the scrape requests should follow HTTP 3xx redirects. |
honorLabels | When true, `honorLabels` preserves the metric's labels when they collide with the target's labels. |
honorTimestamps | `honorTimestamps` controls whether Prometheus preserves the timestamps when exposed by the target. |
interval | Interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval.
|
`metricRelabelings` configures the relabeling rules to apply to the samples before ingestion. | |
`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` define optional HTTP URL parameters. | |
path | HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`). |
port | Name of the Pod port which this endpoint refers to. It takes precedence over `targetPort`. |
proxyUrl | `proxyURL` configures the HTTP Proxy URL (e.g. "http://proxyserver:2195") to go through when scraping the target. |
`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 | |
scheme | 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 | 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.
|
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.
| |
TLS configuration to use when scraping the target. | |
trackTimestampsStaleness | `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. |