The operator-prometheus module: custom resources

When set to true, Prometheus must have permissions to get Nodes.

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

List of namespace names to select from.

Authorization section for this endpoint

BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint

Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the pod monitor and accessible by the Prometheus Operator.

Whether to enable HTTP2.

Drop pods that are not running. (Failed, Succeeded). Enabled by default. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

FollowRedirects configures whether scrape requests follow HTTP 3xx redirects.

HonorLabels chooses the metric’s labels on collisions with target labels.

HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.

Interval at which metrics should be scraped If not specified Prometheus’ global scrape interval is used.

MetricRelabelConfigs to apply to 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

OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.

Optional HTTP URL parameters

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

Name of the pod port this endpoint refers to. Mutually exclusive with targetPort.

ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.

RelabelConfigs to apply to samples before scraping. Prometheus 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

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

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.

Timeout after which the scrape is ended If not specified, the Prometheus global scrape interval is used.

Deprecated: Use ‘port’ instead.

TLS configuration to use when scraping the endpoint.

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.

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

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

The secret in the service monitor namespace that contains the password for authentication.

The secret in the service monitor namespace that contains the username for authentication.

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

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Specify whether the Secret or its key must be defined

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 to take of the hash of the source label values. Only applicable when the action is HashMod.

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 is the string between concatenated SourceLabels.

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

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.

The secret or configmap containing the OAuth2 client id

The secret containing the OAuth2 client secret

Parameters to append to the token URL

OAuth2 scopes used for the token request

The URL to fetch the token from

Path to collect metrics from. Defaults to /probe.

Optional ProxyURL.

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.

Mandatory URL of the prober.

ingress defines the Ingress objects to probe and the relabeling configuration. If staticConfig is also defined, staticConfig takes precedence.

staticConfig defines the static list of targets to probe and the relabeling configuration. If ingress is also defined, staticConfig takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.

Certificate authority used when verifying server certificates.

Client certificate to present when doing client-authentication.

Disable target certificate validation.

Secret containing the client key file for the targets.

Used to verify the hostname for the targets.

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

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

The secret in the service monitor namespace that contains the password for authentication.

The secret in the service monitor namespace that contains the username for authentication.

Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value.

Authorization header configuration to authenticate against the Consul Server.

BasicAuth information to authenticate against the Consul Server. More info: https://prometheus.io/docs/operating/configuration/#endpoints

Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.

Whether to enable HTTP2. If unset, Prometheus uses its default value.

Configure whether HTTP requests follow HTTP 3xx redirects. If unset, Prometheus uses its default value.

Namespaces are only supported in Consul Enterprise.

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.

Node metadata key/value pairs to filter nodes for a given service.

Optional OAuth 2.0 configuration.

Admin Partitions are only supported in Consul Enterprise.

Specifies headers to send to proxies during CONNECT requests.

Use proxy URL indicated by environment variables (HTTP_PROXY, https_proxy, HTTPs_PROXY, https_proxy, and no_proxy) If unset, Prometheus uses its default value.

Optional proxy URL.

The time after which the provided names are refreshed. On large setup it might be a good idea to increase this value because the catalog will change all the time. If unset, Prometheus uses its default value.

HTTP Scheme default “http”

A valid string consisting of a hostname or IP followed by an optional port number.

A list of services for which targets are retrieved. If omitted, all services are scraped.

The string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value.

An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.

TLS Config

Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent.

A list of DNS domain names to be queried.

The port number used if the query type is not SRV Ignored for SRV records

RefreshInterval configures the time after which the provided names are refreshed. If not set, Prometheus uses its default value.

The type of DNS query to perform. One of SRV, A, AAAA or MX. If not set, Prometheus uses its default value.

List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the prometheus-operator project makes no guarantees about the working directory where the configuration file is stored. Files must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets.

RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files.

Authorization header configuration to authenticate against the target HTTP endpoint.

BasicAuth information to authenticate against the target HTTP endpoint. More info: https://prometheus.io/docs/operating/configuration/#endpoints

RefreshInterval configures the refresh interval at which Prometheus will re-query the endpoint to update the target list.

TLS configuration applying to the target HTTP endpoint.

URL from which the targets are fetched.

Role of the Kubernetes entities that should be discovered. Currently the only supported role is “Node”.

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 to take of the hash of the source label values. Only applicable when the action is HashMod.

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 is the string between concatenated SourceLabels.

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

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 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 to take of the hash of the source label values. Only applicable when the action is HashMod.

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 is the string between concatenated SourceLabels.

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

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.

Labels assigned to all metrics scraped from the targets.

List of targets for this static configuration.

Certificate authority used when verifying server certificates.

Client certificate to present when doing client-authentication.

Disable target certificate validation.

Secret containing the client key file for the targets.

Used to verify the hostname for the targets.

When set to true, Prometheus must have permissions to get Nodes.

Authorization section for this endpoint

BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints

File to read bearer token for scraping targets.

Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.