Probe defines monitoring for a set of static targets or ingresses.
Probe defines monitoring for a set of static targets or ingresses.
object
spec
Property | Type | Description |
---|---|---|
|
|
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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
Specification of desired Ingress selection for target discovery by Prometheus. |
Specification of desired Ingress selection for target discovery by Prometheus.
object
Property | Type | Description |
---|---|---|
|
|
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 probe and accessible by the Prometheus Operator. |
|
|
Interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used. |
|
|
The job name assigned to scraped metrics by default. |
|
|
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. |
|
|
Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. |
|
|
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. |
|
|
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. |
|
|
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 |
|
|
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 |
|
|
OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. |
|
|
Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty. |
|
|
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
|
|
The scrape class to apply. |
|
|
|
|
|
Timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. |
|
|
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. |
|
|
TLS configuration to use when scraping the endpoint. |
Authorization section for this endpoint
object
Property | Type | Description |
---|---|---|
|
|
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" |
Selects a key of a Secret in the namespace that contains the credentials for authentication.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint
object
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
password
specifies a key of a Secret containing the password for authentication.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
username
specifies a key of a Secret containing the username for authentication.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
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.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
MetricRelabelConfigs to apply to samples before ingestion.
array
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
object
Property | Type | Description |
---|---|---|
|
|
Action to perform based on the regex matching.
|
|
|
Modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
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 |
OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
object
clientId
clientSecret
tokenUrl
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
clientId
specifies a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
clientSecret
specifies a key of a Secret containing the OAuth2 client’s secret.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
object
url
Property | Type | Description |
---|---|---|
|
|
Path to collect metrics from. Defaults to |
|
|
Optional ProxyURL. |
|
|
HTTP scheme to use for scraping. |
|
|
Mandatory URL of the prober. |
Targets defines a set of static or dynamically discovered targets to probe.
object
Property | Type | Description |
---|---|---|
|
|
ingress defines the Ingress objects to probe and the relabeling configuration. If |
|
|
staticConfig defines the static list of targets to probe and the relabeling configuration. If |
ingress defines the Ingress objects to probe and the relabeling configuration. If staticConfig
is also defined, staticConfig
takes precedence.
object
Property | Type | Description |
---|---|---|
|
|
From which namespaces to select Ingress objects. |
|
|
RelabelConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the |
|
|
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 |
|
|
Selector to select the Ingress objects. |
From which namespaces to select Ingress objects.
object
Property | Type | Description |
---|---|---|
|
|
Boolean describing whether all namespaces are selected in contrast to a list restricting them. |
|
|
List of namespace names to select from. |
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
array
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
object
Property | Type | Description |
---|---|---|
|
|
Action to perform based on the regex matching.
|
|
|
Modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
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 |
Selector to select the Ingress objects.
object
Property | Type | Description |
---|---|---|
|
|
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. |
matchExpressions is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
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. |
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
Property | Type | Description |
---|---|---|
|
|
Labels assigned to all metrics scraped from the targets. |
|
|
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 |
|
|
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 |
|
|
The list of hosts to probe. |
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
array
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
object
Property | Type | Description |
---|---|---|
|
|
Action to perform based on the regex matching.
|
|
|
Modulus to take of the hash of the source label values.
Only applicable when the action is |
|
|
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 |
TLS configuration to use when scraping the endpoint.
object
Property | Type | Description |
---|---|---|
|
|
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. |
Certificate authority used when verifying server certificates.
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
Client certificate to present when doing client-authentication.
object
Property | Type | Description |
---|---|---|
|
|
ConfigMap containing data to use for the targets. |
|
|
Secret containing data to use for the targets. |
ConfigMap containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the ConfigMap or its key must be defined |
Secret containing data to use for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
Secret containing the client key file for the targets.
object
key
Property | Type | Description |
---|---|---|
|
|
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 TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
The following API endpoints are available:
/apis/monitoring.coreos.com/v1/probes
GET
: list objects of kind Probe
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes
DELETE
: delete collection of Probe
GET
: list objects of kind Probe
POST
: create a Probe
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}
DELETE
: delete a Probe
GET
: read the specified Probe
PATCH
: partially update the specified Probe
PUT
: replace the specified Probe
GET
list objects of kind Probe
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
DELETE
delete collection of Probe
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind Probe
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create a Probe
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the Probe |
DELETE
delete a Probe
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
HTTP code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
GET
read the specified Probe
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified Probe
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified Probe
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |