NAME
IO::K8s::PrometheusOperator::V1::PodMetricsEndpoint - PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by Prometheus.
VERSION
version 1.108
authorization
authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as `basicAuth`, `bearerTokenSecret` or `oauth2`.
basicAuth
basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as `authorization`, `bearerTokenSecret` or `oauth2`.
bearerTokenSecret
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`, `basicAuth` or `oauth2`.
Deprecated: use `authorization` instead.
enableHttp2
enableHttp2 can be used to disable HTTP2.
filterRunning
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 client should follow HTTP 3xx redirects.
honorLabels
honorLabels when true preserves the metric's labels when they collide with the target's labels.
honorTimestamps
honorTimestamps defines 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
metricRelabelings defines the relabeling rules to apply to the samples before ingestion.
noProxy
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
oauth2 defines the OAuth2 settings used by the client.
It requires Prometheus >= 2.27.0.
Cannot be set at the same time as `authorization`, `basicAuth` or `bearerTokenSecret`.
params
params define optional HTTP URL parameters.
path
path defines the HTTP path from which to scrape for metrics.
If empty, Prometheus uses the default value (e.g. `/metrics`).
port
port defines the `Pod` port name which exposes the endpoint.
If the pod doesn't expose a port with the same name, it will result in no targets being discovered.
If a `Pod` has multiple `Port`s with the same name (which is not recommended), one target instance per unique port number will be generated.
It takes precedence over the `portNumber` and `targetPort` fields.
portNumber
portNumber defines the `Pod` port number which exposes the endpoint.
The `Pod` must declare the specified `Port` in its spec or the target will be dropped by Prometheus.
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 `__address__` label (but beware of duplicate targets if the `Pod` has other declared ports).
In practice Prometheus will select targets for which the matches the target's __meta_kubernetes_pod_container_port_number.
proxyConnectHeader
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.
proxyFromEnvironment
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
proxyUrl defines the HTTP proxy server to use.
relabelings
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_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
scheme
scheme defines the HTTP scheme to use for scraping.
scrapeTimeout
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
targetPort defines the 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' or 'portNumber' instead.
tlsConfig
tlsConfig defines the TLS configuration used by the client.
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.
SUPPORT
Issues
Please report bugs and feature requests on GitHub at https://github.com/pplu/io-k8s-p5/issues.
CONTRIBUTING
Contributions are welcome! Please fork the repository and submit a pull request.
AUTHORS
Torsten Raudssus <getty@cpan.org>
Jose Luis Martinez Torres <jlmartin@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2018-2026 by Jose Luis Martinez Torres <jlmartin@cpan.org>.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004