ServiceMonitor defines monitoring for a set of services.
Last changed in Prometheus Operator v0.42.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
Specification of desired Service selection for target discovery by Prometheus.
A list of endpoints allowed as part of this ServiceMonitor.
BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints
The secret in the service monitor namespace that contains the password for authentication.
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.
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
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.
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
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.
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.
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. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
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.
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
Stuct containing the CA cert to use for the targets.
ConfigMap containing data to use for the targets.
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.
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
Path to the CA cert in the Prometheus container to use for the targets.
Struct containing the client cert file for the targets.
ConfigMap containing data to use for the targets.
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.
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
Path to the client cert file in the Prometheus container for the targets.
Disable target certificate validation.
Path to the client key file in the Prometheus container for the targets.
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. 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
Used to verify the hostname for the targets.
The label to use to retrieve the job name from.
Selector to select which namespaces the Endpoints objects are discovered from.
Boolean describing whether all namespaces are selected in contrast to a list restricting them.
List of namespace names.
PodTargetLabels transfers labels on the Kubernetes Pod onto the target.
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
Selector to select Endpoints 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.
TargetLabels transfers labels on the Kubernetes Service onto the target.
Source: bundle.yaml
Changes to ServiceMonitor (monitoring.coreos.com/v1) in each Prometheus Operator version, compared to the version before it.
1 property has changed the description
Released · View ServiceMonitor in v0.42.0
1 property has changed the description
Released · View ServiceMonitor in v0.38.0
5 properties have been added
3 properties have changed type
1 property is now required
The description of ServiceMonitor has changed
17 properties have changed the description
Released · View ServiceMonitor in v0.35.0
5 properties have been added
5 properties have changed the description
Released · View ServiceMonitor in v0.34.0
3 properties have changed the description
Released · View ServiceMonitor in v0.32.0
1 property has changed the description
Released · View ServiceMonitor in v0.29.0
3 properties have been added
Released · View ServiceMonitor in v0.24.0
1 property has changed the description
Released · View ServiceMonitor in v0.23.0
1 property is no longer required
The description of ServiceMonitor has changed
Released · View ServiceMonitor in v0.22.0
1 property has been added
Released · View ServiceMonitor in v0.20.0
1 property has been added
2 properties are no longer required
Released · View ServiceMonitor in v0.18.0
ServiceMonitor was already present in this version of Prometheus Operator, the oldest one on kubespec.dev
Released · View ServiceMonitor in v0.17.0
No examples of ServiceMonitor yet. Contribute one on GitHub.