ServiceMonitor

monitoring.coreos.com / v1

apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: name: example

apiVersion string

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 string

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

metadata object

spec object required

Specification of desired Service selection for target discovery by Prometheus.

attachMetadata object

`attachMetadata` defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.37.0.

node boolean

When set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` permissions on the `Nodes` objects.

bodySizeLimit string

When defined, bodySizeLimit specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus. It requires Prometheus >= v2.28.0.

pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$

convertClassicHistogramsToNHCB boolean

Whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.

endpoints []object required

List of endpoints part of this ServiceMonitor. Defines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects. In most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels.

authorization object

`authorization` configures the Authorization header credentials to use when scraping the target. Cannot be set at the same time as `basicAuth`, or `oauth2`.

credentials object

Selects a key of a Secret in the namespace that contains the credentials for authentication.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

Name 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

optional boolean

Specify whether the Secret or its key must be defined

type string

Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"

basicAuth object

`basicAuth` configures the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as `authorization`, or `oauth2`.

password object

`password` specifies a key of a Secret containing the password for authentication.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

username object

`username` specifies a key of a Secret containing the username for authentication.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

bearerTokenFile string

File to read bearer token for scraping the target. Deprecated: use `authorization` instead.

bearerTokenSecret object

`bearerTokenSecret` specifies a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the ServiceMonitor object and readable by the Prometheus Operator. Deprecated: use `authorization` instead.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

enableHttp2 boolean

`enableHttp2` can be used to disable HTTP2 when scraping the target.

filterRunning boolean

When true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery. If unset, the filtering is enabled. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

followRedirects boolean

`followRedirects` defines whether the scrape requests should follow HTTP 3xx redirects.

honorLabels boolean

When true, `honorLabels` preserves the metric's labels when they collide with the target's labels.

honorTimestamps boolean

`honorTimestamps` controls whether Prometheus preserves the timestamps when exposed by the target.

interval string

Interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval.

pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

metricRelabelings []object

`metricRelabelings` configures the relabeling rules to apply to the samples before ingestion.

action string

Action 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"

enum:

replace, Replace, keep, Keep, drop, Drop, hashmod, HashMod, labelmap, LabelMap, labeldrop, LabelDrop, labelkeep, LabelKe...

replace, Replace, keep, Keep, drop, Drop, hashmod, HashMod, labelmap, LabelMap, labeldrop, LabelDrop, labelkeep, LabelKeep, lowercase, Lowercase, uppercase, Uppercase, keepequal, KeepEqual, dropequal, DropEqual

modulus integer

Modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`.

format: int64

regex string

Regular expression against which the extracted value is matched.

replacement string

Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.

separator string

Separator is the string between concatenated SourceLabels.

sourceLabels []string

The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel string

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.

noProxy string

`noProxy` is 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.

oauth2 object

`oauth2` configures the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0. Cannot be set at the same time as `authorization`, or `basicAuth`.

clientId object required

`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

clientSecret object required

`clientSecret` specifies a key of a Secret containing the OAuth2 client's secret.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

endpointParams object

`endpointParams` configures the HTTP parameters to append to the token URL.

noProxy string

proxyConnectHeader object

ProxyConnectHeader 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.

proxyFromEnvironment boolean

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.

proxyUrl string

`proxyURL` defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

scopes []string

`scopes` defines the OAuth2 scopes used for the token request.

tlsConfig object

TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.

ca object

Certificate authority used when verifying server certificates.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

cert object

Client certificate to present when doing client-authentication.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

insecureSkipVerify boolean

Disable target certificate validation.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

maxVersion string

Maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

enum: TLS10, TLS11, TLS12, TLS13

minVersion string

Minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

enum: TLS10, TLS11, TLS12, TLS13

serverName string

Used to verify the hostname for the targets.

tokenUrl string required

`tokenURL` configures the URL to fetch the token from.

minLength: 1

params object

params define optional HTTP URL parameters.

path string

HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`).

port string

Name of the Service port which this endpoint refers to. It takes precedence over `targetPort`.

proxyConnectHeader object

ProxyConnectHeader 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.

proxyFromEnvironment boolean

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.

proxyUrl string

`proxyURL` defines the HTTP proxy server to use.

pattern: ^(http|https|socks5)://.+$

relabelings []object

`relabelings` configures the relabeling rules to apply the target's metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. 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

action string

Action 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"

enum:

replace, Replace, keep, Keep, drop, Drop, hashmod, HashMod, labelmap, LabelMap, labeldrop, LabelDrop, labelkeep, LabelKe...

replace, Replace, keep, Keep, drop, Drop, hashmod, HashMod, labelmap, LabelMap, labeldrop, LabelDrop, labelkeep, LabelKeep, lowercase, Lowercase, uppercase, Uppercase, keepequal, KeepEqual, dropequal, DropEqual

modulus integer

Modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`.

format: int64

regex string

Regular expression against which the extracted value is matched.

replacement string

Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available.

separator string

Separator is the string between concatenated SourceLabels.

sourceLabels []string

The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.

targetLabel string

scheme string

HTTP scheme to use for scraping. `http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling. If empty, Prometheus uses the default value `http`.

enum: http, https

scrapeTimeout string

Timeout after which Prometheus considers the scrape to be failed. If empty, Prometheus uses the global scrape timeout unless it is less than the target's scrape interval value in which the latter is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.

pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

targetPort string | integer

Name or number of the target port of the `Pod` object behind the Service. The port must be specified with the container's port property.

tlsConfig object

TLS configuration to use when scraping the target.

ca object

Certificate authority used when verifying server certificates.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

caFile string

Path to the CA cert in the Prometheus container to use for the targets.

cert object

Client certificate to present when doing client-authentication.

configMap object

ConfigMap containing data to use for the targets.

key string required

The key to select.

name string

optional boolean

Specify whether the ConfigMap or its key must be defined

secret object

Secret containing data to use for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

certFile string

Path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify boolean

Disable target certificate validation.

keyFile string

Path to the client key file in the Prometheus container for the targets.

keySecret object

Secret containing the client key file for the targets.

key string required

The key of the secret to select from. Must be a valid secret key.

name string

optional boolean

Specify whether the Secret or its key must be defined

maxVersion string

Maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

enum: TLS10, TLS11, TLS12, TLS13

minVersion string

Minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

enum: TLS10, TLS11, TLS12, TLS13

serverName string

Used to verify the hostname for the targets.

trackTimestampsStaleness boolean

`trackTimestampsStaleness` defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. It requires Prometheus >= v2.48.0.

fallbackScrapeProtocol string

The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0.

enum: PrometheusProto, OpenMetricsText0.0.1, OpenMetricsText1.0.0, PrometheusText0.0.4, PrometheusText1.0.0

jobLabel string

`jobLabel` selects the label from the associated Kubernetes `Service` object which will be used as the `job` label for all metrics. For example if `jobLabel` is set to `foo` and the Kubernetes `Service` object is labeled with `foo: bar`, then Prometheus adds the `job="bar"` label to all ingested metrics. If the value of this field is empty or if the label doesn't exist for the given Service, the `job` label of the metrics defaults to the name of the associated Kubernetes `Service`.

keepDroppedTargets integer

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.

format: int64

labelLimit integer

Per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0.

format: int64

labelNameLengthLimit integer

Per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0.

format: int64

labelValueLengthLimit integer

Per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0.

format: int64

namespaceSelector object

`namespaceSelector` defines in which namespace(s) Prometheus should discover the services. By default, the services are discovered in the same namespace as the `ServiceMonitor` object but it is possible to select pods across different/all namespaces.

any boolean

Boolean describing whether all namespaces are selected in contrast to a list restricting them.

matchNames []string

List of namespace names to select from.

nativeHistogramBucketLimit integer

If 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.

format: int64

nativeHistogramMinBucketFactor string | integer

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.

string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

podTargetLabels []string

`podTargetLabels` defines the labels which are transferred from the associated Kubernetes `Pod` object onto the ingested metrics.

sampleLimit integer

`sampleLimit` defines a per-scrape limit on the number of scraped samples that will be accepted.

format: int64

scrapeClass string

The scrape class to apply.

minLength: 1

scrapeClassicHistograms boolean

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.

scrapeProtocols []string

`scrapeProtocols` 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.

selector object required

Label selector to select the Kubernetes `Endpoints` objects to scrape metrics from.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

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 object

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.

selectorMechanism string

Mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated. It requires Prometheus >= v2.17.0.

enum: RelabelConfig, RoleSelector

targetLabels []string

`targetLabels` defines the labels which are transferred from the associated Kubernetes `Service` object onto the ingested metrics.

targetLimit integer

`targetLimit` defines a limit on the number of scraped targets that will be accepted.

format: int64

status object

This Status subresource is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled. Most recent observed status of the ServiceMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

bindings []object

The list of workload resources (Prometheus or PrometheusAgent) which select the configuration resource.

conditions []object

The current state of the configuration resource when bound to the referenced Prometheus object.

lastTransitionTime string required

LastTransitionTime is the time of the last update to the current status property.

format: date-time

message string

Human-readable message indicating details for the condition's last transition.

observedGeneration integer

ObservedGeneration represents 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.

format: int64

reason string

Reason for the condition's last transition.

status string required

Status of the condition.

minLength: 1

type string required

Type of the condition being reported. Currently, only "Accepted" is supported.

enum: Accepted

minLength: 1

group string required

The group of the referenced resource.

enum: monitoring.coreos.com

name string required

The name of the referenced object.

minLength: 1

namespace string required

The namespace of the referenced object.

minLength: 1

resource string required

The type of resource being referenced (e.g. Prometheus or PrometheusAgent).

enum: prometheuses, prometheusagents

No matches. Try .spec.attachMetadata for an exact path