Probe

com.coreos.monitoring.v1.Probe

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:

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

apiVersionstring = "monitoring.coreos.com/v1"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
kindstring = "Probe"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
metadataobject
specobject requiredspec defines the specification of desired Ingress selection for target discovery by Prometheus.
authorizationobjectauthorization configures the Authorization header credentials used by the client.Cannot be set at the same time as `basicAuth`, `bearerTokenSecret` or `oauth2`.
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
typestringtype defines the authentication type. The value is case-insensitive."Basic" is not a supported value.Default: "Bearer"
basicAuthobjectbasicAuth defines the Basic Authentication credentials used by the client.Cannot be set at the same time as `authorization`, `bearerTokenSecret` or `oauth2`.
passwordobjectpassword defines a key of a Secret containing the password for authentication.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
usernameobjectusername defines a key of a Secret containing the username for authentication.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
bearerTokenSecretobjectbearerTokenSecret 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.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
convertClassicHistogramsToNHCBbooleanconvertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
fallbackScrapeProtocolstringfallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.It requires Prometheus >= v3.0.0.
followRedirectsbooleanfollowRedirects defines whether the client should follow HTTP 3xx redirects.
intervalstringinterval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.
jobNamestringjobName assigned to scraped metrics by default.
keepDroppedTargetsinteger (int64)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.
labelLimitinteger (int64)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.
labelNameLengthLimitinteger (int64)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.
labelValueLengthLimitinteger (int64)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[]objectmetricRelabelings defines the RelabelConfig to apply to samples before ingestion.
actionstringaction 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"
modulusinteger (int64)modulus to take of the hash of the source label values.Only applicable when the action is `HashMod`.
regexstringregex defines the regular expression against which the extracted value is matched.
replacementstringreplacement value against which a Replace action is performed if the regular expression matches.Regex capture groups are available.
separatorstringseparator defines the string between concatenated SourceLabels.
sourceLabels[]stringsourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
targetLabelstringtargetLabel 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.
modulestringmodule 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
nativeHistogramBucketLimitinteger (int64)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.
nativeHistogramMinBucketFactorobjectnativeHistogramMinBucketFactor 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.
oauth2objectoauth2 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`.
clientIdobject requiredclientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe key to select.
namestringName 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
optionalbooleanSpecify whether the ConfigMap or its key must be defined
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
clientSecretobject requiredclientSecret defines a key of a Secret containing the OAuth2 client's secret.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
endpointParamsmap[string]stringendpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy 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.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
proxyFromEnvironmentbooleanproxyFromEnvironment 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.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopes[]stringscopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe key to select.
namestringName 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
optionalbooleanSpecify whether the ConfigMap or its key must be defined
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe key to select.
namestringName 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
optionalbooleanSpecify whether the ConfigMap or its key must be defined
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
maxVersionstringmaxVersion defines the maximum acceptable TLS version.It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.
tokenUrlstring requiredtokenUrl defines the URL to fetch the token from.
params[]objectparams 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.
namestring requiredname defines the parameter name
values[]stringvalues defines the parameter values
proberobjectprober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
noProxystringnoProxy 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.
pathstringpath to collect metrics from. Defaults to `/probe`.
proxyConnectHeadermap[string][]objectproxyConnectHeader 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.
proxyFromEnvironmentbooleanproxyFromEnvironment 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.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
schemestringscheme defines the HTTP scheme to use when scraping the prober.
urlstring requiredurl 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.
sampleLimitinteger (int64)sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
scrapeClassstringscrapeClass defines the scrape class to apply.
scrapeClassicHistogramsbooleanscrapeClassicHistograms 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.
scrapeNativeHistogramsbooleanscrapeNativeHistograms defines whether to enable scraping of native histograms. It requires Prometheus >= v3.8.0.
scrapeProtocols[]stringscrapeProtocols 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.
scrapeTimeoutstringscrapeTimeout 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.
targetLimitinteger (int64)targetLimit defines a limit on the number of scraped targets that will be accepted.
targetsobjecttargets defines a set of static or dynamically discovered targets to probe.
ingressobjectingress defines the Ingress objects to probe and the relabeling configuration. If `staticConfig` is also defined, `staticConfig` takes precedence.
namespaceSelectorobjectnamespaceSelector defines from which namespaces to select Ingress objects.
anybooleanany defines the boolean describing whether all namespaces are selected in contrast to a list restricting them.
matchNames[]stringmatchNames defines the list of namespace names to select from.
relabelingConfigs[]objectrelabelingConfigs 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
actionstringaction 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"
modulusinteger (int64)modulus to take of the hash of the source label values.Only applicable when the action is `HashMod`.
regexstringregex defines the regular expression against which the extracted value is matched.
replacementstringreplacement value against which a Replace action is performed if the regular expression matches.Regex capture groups are available.
separatorstringseparator defines the string between concatenated SourceLabels.
sourceLabels[]stringsourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
targetLabelstringtargetLabel 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.
selectorobjectselector to select the Ingress objects.
matchExpressions[]objectmatchExpressions is a list of label selector requirements. The requirements are ANDed.
keystring requiredkey is the label key that the selector applies to.
operatorstring requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values[]stringvalues 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.
matchLabelsmap[string]stringmatchLabels 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.
staticConfigobjectstaticConfig 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.
labelsmap[string]stringlabels defines all labels assigned to all metrics scraped from the targets.
relabelingConfigs[]objectrelabelingConfigs 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
actionstringaction 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"
modulusinteger (int64)modulus to take of the hash of the source label values.Only applicable when the action is `HashMod`.
regexstringregex defines the regular expression against which the extracted value is matched.
replacementstringreplacement value against which a Replace action is performed if the regular expression matches.Regex capture groups are available.
separatorstringseparator defines the string between concatenated SourceLabels.
sourceLabels[]stringsourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
targetLabelstringtargetLabel 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[]stringstatic defines the list of hosts to probe.
tlsConfigobjecttlsConfig defines the TLS configuration used by the client.
caobjectca defines the Certificate authority used when verifying server certificates.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe key to select.
namestringName 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
optionalbooleanSpecify whether the ConfigMap or its key must be defined
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
certobjectcert defines the Client certificate to present when doing client-authentication.
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
keystring requiredThe key to select.
namestringName 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
optionalbooleanSpecify whether the ConfigMap or its key must be defined
secretobjectsecret defines the Secret containing data to use for the targets.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
keystring requiredThe key of the secret to select from. Must be a valid secret key.
namestringName 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
optionalbooleanSpecify whether the Secret or its key must be defined
maxVersionstringmaxVersion defines the maximum acceptable TLS version.It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.
statusobject read-onlystatus 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[]object read-onlybindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
conditions[]object read-onlyconditions defines the current state of the configuration resource when bound to the referenced Workload object.
lastTransitionTimestring (date-time) required read-onlylastTransitionTime defines the time of the last update to the current status property.
messagestring read-onlymessage defines the human-readable message indicating details for the condition's last transition.
observedGenerationinteger (int64) read-onlyobservedGeneration 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.
reasonstring read-onlyreason for the condition's last transition.
statusstring required read-onlystatus of the condition.
typestring required read-onlytype of the condition being reported. Currently, only "Accepted" is supported.
groupstring required read-onlygroup defines the group of the referenced resource.
namestring required read-onlyname defines the name of the referenced object.
namespacestring required read-onlynamespace defines the namespace of the referenced object.
resourcestring required read-onlyresource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).