monitoring.coreos.com/v1/Probe

string

.apiVersion

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

string

.kind

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

object

.metadata

object required

.spec

Specification of desired Ingress selection for target discovery by Prometheus.

object

.spec .authorization

Authorization section for this endpoint

object

.spec .authorization .credentials

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

string required

.spec .authorization .credentials .key

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

string

.spec .authorization .credentials .name

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

boolean

.spec .authorization .credentials .optional

Specify whether the Secret or its key must be defined

string

.spec .authorization .type

Defines the authentication type. The value is case-insensitive.

“Basic” is not a supported value.

Default: “Bearer”

object

.spec .basicAuth

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

object

.spec .basicAuth .password

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

string required

.spec .basicAuth .password .key

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

string

.spec .basicAuth .password .name

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

boolean

.spec .basicAuth .password .optional

Specify whether the Secret or its key must be defined

object

.spec .basicAuth .username

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

string required

.spec .basicAuth .username .key

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

string

.spec .basicAuth .username .name

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

boolean

.spec .basicAuth .username .optional

Specify whether the Secret or its key must be defined

object

.spec .bearerTokenSecret

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

string required

.spec .bearerTokenSecret .key

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

string

.spec .bearerTokenSecret .name

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

boolean

.spec .bearerTokenSecret .optional

Specify whether the Secret or its key must be defined

boolean

.spec .convertClassicHistogramsToNHCB

Whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.

string

.spec .fallbackScrapeProtocol

The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.

It requires Prometheus >= v3.0.0.

string

.spec .interval

Interval at which targets are probed using the configured prober. If not specified Prometheus’ global scrape interval is used.

string

.spec .jobName

The job name assigned to scraped metrics by default.

integer

.spec .keepDroppedTargets

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.

integer

.spec .labelLimit

Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

integer

.spec .labelNameLengthLimit

Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

integer

.spec .labelValueLengthLimit

Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

array

.spec .metricRelabelings

MetricRelabelConfigs to apply to samples before ingestion.

string

.spec .metricRelabelings[] .action

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”

integer

.spec .metricRelabelings[] .modulus

Modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

string

.spec .metricRelabelings[] .regex

Regular expression against which the extracted value is matched.

string

.spec .metricRelabelings[] .replacement

Replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

string

.spec .metricRelabelings[] .separator

Separator is the string between concatenated SourceLabels.

array

.spec .metricRelabelings[] .sourceLabels

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

string

.spec .metricRelabelings[] .targetLabel

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.

string

.spec .module

The module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

integer

.spec .nativeHistogramBucketLimit

If 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.

integer | string

.spec .nativeHistogramMinBucketFactor

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.

object

.spec .oauth2

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

object required

.spec .oauth2 .clientId

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

object

.spec .oauth2 .clientId .configMap

ConfigMap containing data to use for the targets.

string required

.spec .oauth2 .clientId .configMap .key

The key to select.

string

.spec .oauth2 .clientId .configMap .name

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

boolean

.spec .oauth2 .clientId .configMap .optional

Specify whether the ConfigMap or its key must be defined

object

.spec .oauth2 .clientId .secret

Secret containing data to use for the targets.

string required

.spec .oauth2 .clientId .secret .key

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

string

.spec .oauth2 .clientId .secret .name

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

boolean

.spec .oauth2 .clientId .secret .optional

Specify whether the Secret or its key must be defined

object required

.spec .oauth2 .clientSecret

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

string required

.spec .oauth2 .clientSecret .key

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

string

.spec .oauth2 .clientSecret .name

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

boolean

.spec .oauth2 .clientSecret .optional

Specify whether the Secret or its key must be defined

object

.spec .oauth2 .endpointParams

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

string

.spec .oauth2 .noProxy

noProxy is 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.

object

.spec .oauth2 .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.

boolean

.spec .oauth2 .proxyFromEnvironment

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.

string

.spec .oauth2 .proxyUrl

proxyURL defines the HTTP proxy server to use.

array

.spec .oauth2 .scopes

scopes defines the OAuth2 scopes used for the token request.

object

.spec .oauth2 .tlsConfig

TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.

object

.spec .oauth2 .tlsConfig .ca

Certificate authority used when verifying server certificates.

object

.spec .oauth2 .tlsConfig .ca .configMap

ConfigMap containing data to use for the targets.

string required

.spec .oauth2 .tlsConfig .ca .configMap .key

The key to select.

string

.spec .oauth2 .tlsConfig .ca .configMap .name

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

boolean

.spec .oauth2 .tlsConfig .ca .configMap .optional

Specify whether the ConfigMap or its key must be defined

object

.spec .oauth2 .tlsConfig .ca .secret

Secret containing data to use for the targets.

string required

.spec .oauth2 .tlsConfig .ca .secret .key

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

string

.spec .oauth2 .tlsConfig .ca .secret .name

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

boolean

.spec .oauth2 .tlsConfig .ca .secret .optional

Specify whether the Secret or its key must be defined

object

.spec .oauth2 .tlsConfig .cert

Client certificate to present when doing client-authentication.

object

.spec .oauth2 .tlsConfig .cert .configMap

ConfigMap containing data to use for the targets.

string required

.spec .oauth2 .tlsConfig .cert .configMap .key

The key to select.

string

.spec .oauth2 .tlsConfig .cert .configMap .name

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

boolean

.spec .oauth2 .tlsConfig .cert .configMap .optional

Specify whether the ConfigMap or its key must be defined

object

.spec .oauth2 .tlsConfig .cert .secret

Secret containing data to use for the targets.

string required

.spec .oauth2 .tlsConfig .cert .secret .key

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

string

.spec .oauth2 .tlsConfig .cert .secret .name

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

boolean

.spec .oauth2 .tlsConfig .cert .secret .optional

Specify whether the Secret or its key must be defined

boolean

.spec .oauth2 .tlsConfig .insecureSkipVerify

Disable target certificate validation.

object

.spec .oauth2 .tlsConfig .keySecret

Secret containing the client key file for the targets.

string required

.spec .oauth2 .tlsConfig .keySecret .key

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

string

.spec .oauth2 .tlsConfig .keySecret .name

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

boolean

.spec .oauth2 .tlsConfig .keySecret .optional

Specify whether the Secret or its key must be defined

string

.spec .oauth2 .tlsConfig .maxVersion

Maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

string

.spec .oauth2 .tlsConfig .minVersion

Minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

string

.spec .oauth2 .tlsConfig .serverName

Used to verify the hostname for the targets.

string required

.spec .oauth2 .tokenUrl

tokenURL configures the URL to fetch the token from.

object

.spec .prober

Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.

string

.spec .prober .path

Path to collect metrics from. Defaults to /probe.

string

.spec .prober .proxyUrl

Optional ProxyURL.

string

.spec .prober .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.

string required

.spec .prober .url

Mandatory URL of the prober.

integer

.spec .sampleLimit

SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.

string

.spec .scrapeClass

The scrape class to apply.

boolean

.spec .scrapeClassicHistograms

Whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.

array

.spec .scrapeProtocols

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.

string

.spec .scrapeTimeout

Timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.

integer

.spec .targetLimit

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

object

.spec .targets

Targets defines a set of static or dynamically discovered targets to probe.

object

.spec .targets .ingress

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

object

.spec .targets .ingress .namespaceSelector

From which namespaces to select Ingress objects.

boolean

.spec .targets .ingress .namespaceSelector .any

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

array

.spec .targets .ingress .namespaceSelector .matchNames

List of namespace names to select from.

array

.spec .targets .ingress .relabelingConfigs

RelabelConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the __tmp_prometheus_ingress_address label. It can be used to customize the probed URL. 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

string

.spec .targets .ingress .relabelingConfigs[] .action

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”

integer

.spec .targets .ingress .relabelingConfigs[] .modulus

Modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

string

.spec .targets .ingress .relabelingConfigs[] .regex

Regular expression against which the extracted value is matched.

string

.spec .targets .ingress .relabelingConfigs[] .replacement

Replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

string

.spec .targets .ingress .relabelingConfigs[] .separator

Separator is the string between concatenated SourceLabels.

array

.spec .targets .ingress .relabelingConfigs[] .sourceLabels

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

string

.spec .targets .ingress .relabelingConfigs[] .targetLabel

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.

object

.spec .targets .ingress .selector

Selector to select the Ingress objects.

array

.spec .targets .ingress .selector .matchExpressions

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

string required

.spec .targets .ingress .selector .matchExpressions[] .key

key is the label key that the selector applies to.

string required

.spec .targets .ingress .selector .matchExpressions[] .operator

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

array

.spec .targets .ingress .selector .matchExpressions[] .values

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.

object

.spec .targets .ingress .selector .matchLabels

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.

object

.spec .targets .staticConfig

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.

object

.spec .targets .staticConfig .labels

Labels assigned to all metrics scraped from the targets.

array

.spec .targets .staticConfig .relabelingConfigs

RelabelConfigs to apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

string

.spec .targets .staticConfig .relabelingConfigs[] .action

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”

integer

.spec .targets .staticConfig .relabelingConfigs[] .modulus

Modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

string

.spec .targets .staticConfig .relabelingConfigs[] .regex

Regular expression against which the extracted value is matched.

string

.spec .targets .staticConfig .relabelingConfigs[] .replacement

Replacement value against which a Replace action is performed if the regular expression matches.

Regex capture groups are available.

string

Regex capture groups are available.

array

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

.spec .tlsConfig .keySecret .optional

Specify whether the Secret or its key must be defined

string

.spec .tlsConfig .maxVersion

Maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

string

.spec .tlsConfig .minVersion

Minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

string

.spec .tlsConfig .serverName

Used to verify the hostname for the targets.

monitoring.coreos.com / v1 / Probe