ServiceMonitor defines monitoring for a set of services.
ServiceMonitor defines monitoring for a set of services.
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 Service selection for target discovery by Prometheus. |
Specification of desired Service selection for target discovery by Prometheus.
object
endpoints
selector
Property | Type | Description |
---|---|---|
|
|
A list of endpoints allowed as part of this ServiceMonitor. |
|
|
Endpoint defines a scrapeable endpoint serving Prometheus metrics. |
|
|
Chooses the label of the Kubernetes |
|
|
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. |
|
|
Selector to select which namespaces the Kubernetes Endpoints objects are discovered from. |
|
|
PodTargetLabels transfers labels on the Kubernetes |
|
|
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
|
|
Selector to select Endpoints objects. |
|
|
TargetLabels transfers labels from the Kubernetes |
|
|
TargetLimit defines a limit on the number of scraped targets that will be accepted. |
Endpoint defines a scrapeable endpoint serving Prometheus metrics.
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/#endpoints |
|
|
File to read bearer token for scraping targets. |
|
|
Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator. |
|
|
HonorLabels chooses the metric’s labels on collisions with target labels. |
|
|
HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. |
|
|
Interval at which metrics should be scraped |
|
|
MetricRelabelConfigs to apply to samples before ingestion. |
|
|
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines |
|
|
OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. |
|
|
Optional HTTP URL parameters |
|
|
|
|
|
HTTP path to scrape for metrics. |
|
|
Name of the service port this endpoint refers to. Mutually exclusive with targetPort. |
|
|
ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. |
|
|
RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. 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 |
|
|
HTTP scheme to use for scraping. |
|
|
Timeout after which the scrape is ended |
|
|
Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with port. |
|
|
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/#endpoints
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 service monitor 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 |
RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. 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. |
|
|
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 actio |