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 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, being applied to samples before ingestion. It defines |
|
|
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. |
|
|
Timeout for scraping metrics from the Prometheus exporter. |
|
|
TargetLimit defines a limit on the number of scraped targets that will be accepted. |
|
|
Targets defines a set of static and/or dynamically discovered targets to be probed using the prober. |
|
|
TLS configuration to use when scraping the endpoint. |
Authorization section for this endpoint
object
Property | Type | Description |
---|---|---|
|
|
The secret’s key that contains the credentials of the request |
|
|
Set the authentication type. Defaults to Bearer, Basic will cause an error |
The secret’s key that contains the credentials of the request
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 |
---|---|---|
|
|
The secret in the service monitor namespace that contains the password for authentication. |
|
|
The secret in the service monitor namespace that contains the username for authentication. |
The secret in the service monitor namespace that contains 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 |
The secret in the service monitor namespace that contains 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, being applied to samples before ingestion. It defines <metric_relabel_configs>
-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
object
Property | Type | Description |
---|---|---|
|
|
Action to perform based on regex matching. Default is 'replace' |
|
|
Modulus to take of the hash of the source label values. |
|
|
Regular expression against which the extracted value is matched. Default is '(.*)' |
|
|
Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1' |
|
|
Separator placed between concatenated source label values. default is ';'. |
|
|
The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. |
|
|
Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |
OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
object
clientId
clientSecret
tokenUrl
Property | Type | Description |
---|---|---|
|
|
The secret or configmap containing the OAuth2 client id |
|
|
The secret containing the OAuth2 client secret |
|
|
Parameters to append to the token URL |
|
|
OAuth2 scopes used for the token request |
|
|
The URL to fetch the token from |
The secret or configmap containing the OAuth2 client 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 |
The secret containing the OAuth2 client 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. Defaults to |
|
|
Mandatory URL of the prober. |
Targets defines a set of static and/or dynamically discovered targets to be probed using the prober.
object
Property | Type | Description |
---|---|---|
|
|
Ingress defines the set of dynamically discovered ingress objects which hosts are considered for probing. |
|
|
StaticConfig defines static targets which are considers for probing. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config. |
Ingress defines the set of dynamically discovered ingress objects which hosts are considered for probing.
object
Property | Type | Description |
---|---|---|
|
|
Select Ingress objects by namespace. |
|
|
RelabelConfigs to apply to samples before ingestion. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
|
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines |
|
|
Select Ingress objects by labels. |
Select Ingress objects by namespace.
object
Property | Type | Description |
---|---|---|
|
|
Boolean describing whether all namespaces are selected in contrast to a list restricting them. |
|
|
List of namespace names. |
RelabelConfigs to apply to samples before ingestion. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
array
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines <metric_relabel_configs>
-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
object
Property | Type | Description |
---|---|---|
|
|
Action to perform based on regex matching. Default is 'replace' |
|
|
Modulus to take of the hash of the source label values. |