The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter). The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics. `Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.
Last changed in Prometheus Operator v0.87.0
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
spec defines the specification of desired Ingress selection for target discovery by Prometheus.
authorization section for this endpoint
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
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
type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
basicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint
password defines a key of a Secret containing the password for authentication.
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
username defines a key of a Secret containing the username for authentication.
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
bearerTokenSecret defines the 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.
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
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.
interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.
jobName assigned to scraped metrics by default.
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. Only valid in Prometheus versions 2.27.0 and newer.
labelNameLengthLimit defines the 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.
labelValueLengthLimit defines the 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.
metricRelabelings defines the RelabelConfig to apply to samples before ingestion.
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`.
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 `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. Regex capture groups are available.
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
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.
oauth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
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
secret defines the Secret containing data to use for the targets.
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
clientSecret defines a key of a Secret containing the OAuth2 client's secret.
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
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.
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
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.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
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
secret defines the Secret containing data to use for the targets.
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
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
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
secret defines the Secret containing data to use for the targets.
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
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
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
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.
tokenUrl defines the URL to fetch the token from.
params defines the list of HTTP query parameters for the scrape. Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.
name defines the parameter name
values defines the parameter values
prober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
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.
path to collect metrics from. Defaults to `/probe`.
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.
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
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.
scheme defines the HTTP scheme to use when scraping the prober.
url defines the address of the prober. Unlike what the name indicates, the value should be in the form of `address:port` without any scheme which should be specified in the `scheme` field.
sampleLimit defines per-scrape limit on 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: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.
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.
scrapeTimeout defines the 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.
targetLimit defines a limit on the number of scraped targets that will be accepted.
targets defines a set of static or dynamically discovered targets to probe.
ingress defines the Ingress objects to probe and the relabeling configuration. If `staticConfig` is also defined, `staticConfig` takes precedence.
namespaceSelector defines from which namespaces to select Ingress objects.
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.
relabelingConfigs 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
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`.
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 `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. Regex capture groups are available.
selector to select the Ingress objects.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
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.
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.
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.
labels defines all labels assigned to all metrics scraped from the targets.
relabelingConfigs defines relabelings to be apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
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`.
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 `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. Regex capture groups are available.
static defines the list of hosts to probe.
tlsConfig defines the TLS configuration to use when scraping the endpoint.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
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
secret defines the Secret containing data to use for the targets.
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
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
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
secret defines the Secret containing data to use for the targets.
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
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
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
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.
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 Probe. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
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 `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the object.
reason for the condition's last transition.
status of the condition.
type of the condition being reported. Currently, only "Accepted" is supported.
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).
Source: bundle.yaml
Changes to Probe (monitoring.coreos.com/v1) in each Prometheus Operator version, compared to the version before it.
2 properties have changed the description
Released · View Probe in v0.87.0
1 property has been added
103 properties have changed the description
Released · View Probe in v0.86.0
1 property has changed the description
Released · View Probe in v0.80.0
1 property has been added
Released · View Probe in v0.79.0
3 properties have been added
Released · View Probe in v0.78.0
The description of Probe has changed
41 properties have changed the description
Released · View Probe in v0.77.0
12 properties have changed the description
Released · View Probe in v0.75.0
56 properties have changed the description
Released · View Probe in v0.74.0
2 properties have been added
Released · View Probe in v0.72.0
7 properties have changed the description
Released · View Probe in v0.70.0
1 property has been added
Released · View Probe in v0.68.0
23 properties have changed the description
Released · View Probe in v0.67.0
2 properties have changed the description
Released · View Probe in v0.65.0
2 properties have changed the description
Released · View Probe in v0.61.0
3 properties have changed the description
Released · View Probe in v0.58.0
1 property has changed the description
Released · View Probe in v0.56.0
9 properties have changed the description
Released · View Probe in v0.55.0
1 property has been added
Released · View Probe in v0.51.0
7 properties have been added
Released · View Probe in v0.50.0
1 property has been added
Released · View Probe in v0.49.0
3 properties have been added
Released · View Probe in v0.47.0
1 property has been added
Released · View Probe in v0.46.0
Probe was first seen on this version of Prometheus Operator
Released · View Probe in v0.41.0
No examples of Probe yet. Contribute one on GitHub.
kubespec.dev