ServiceMonitor (monitoring.coreos.com/v1)

Type: object

The ServiceMonitor custom resource definition (CRD) defines how Prometheus and PrometheusAgent can scrape metrics from a group of services.
Among other things, it allows to specify:
* The services to scrape via label selectors.
* The container ports to scrape.
* Authentication credentials to use.
* Target and metric relabeling.

Prometheus and PrometheusAgent objects select ServiceMonitor objects using label and namespace selectors.

Type: 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

Type: 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

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: boolean

If true, this reference points to the managing controller.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

spec defines the specification of desired Service selection for target discovery by
Prometheus.

Type: object

attachMetadata defines additional metadata which is added to the
discovered targets.

It requires Prometheus >= v2.37.0.

Type: boolean

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

Type: string

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

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

Type: boolean

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

Type: array of object

endpoints defines the list of endpoints part of this ServiceMonitor.
Defines how to scrape metrics from Kubernetes Endpoints objects.
In most cases, an Endpoints object is backed by a Kubernetes Service object with the same name and labels.

No Additional Items

Each item of this array must be:

Type: object

Endpoint defines an endpoint serving Prometheus metrics to be scraped by
Prometheus.

Type: object

authorization configures the Authorization header credentials used by
the client.

Cannot be set at the same time as basicAuth, bearerTokenSecret or oauth2.

Type: object

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

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the Basic Authentication credentials used by the
client.

Cannot be set at the same time as authorization, bearerTokenSecret or oauth2.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

bearerTokenFile defines the file to read bearer token for scraping the target.

Deprecated: use authorization instead.

Type: object

bearerTokenSecret defines a key of a Secret containing the bearer token
used by the client for authentication. The secret needs to be in the
same namespace as the custom resource and readable by the Prometheus
Operator.

Cannot be set at the same time as authorization, basicAuth or oauth2.

Deprecated: use authorization instead.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

filterRunning 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

Type: boolean

followRedirects defines whether the client should follow HTTP 3xx
redirects.

Type: boolean

honorLabels defines when true the metric's labels when they collide
with the target's labels.

Type: boolean

honorTimestamps defines whether Prometheus preserves the timestamps
when exposed by the target.

Type: string

interval at which Prometheus scrapes the metrics from the target.

If empty, Prometheus uses the global scrape interval.

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

Type: array of object

metricRelabelings defines the relabeling rules to apply to the
samples before ingestion.

No Additional Items

Each item of this array must be:

Type: object

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

Type: enum (of 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"

Must be one of:

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

Type: integerFormat: int64

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

Type: string

regex defines the regular expression against which the extracted value is matched.

Type: string

replacement value against which a Replace action is performed if the
regular expression matches.

Regex capture groups are available.

Type: string

separator defines the string between concatenated SourceLabels.

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: string

LabelName is a valid Prometheus label name.
For Prometheus 3.x, a label name is valid if it contains UTF-8 characters.
For Prometheus 2.x, a label name is only valid if it contains ASCII characters, letters, numbers, as well as underscores.

Type: string

targetLabel defines the 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.

Type: string

noProxy defines 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.

Type: object

oauth2 defines the OAuth2 settings used by the client.

It requires Prometheus >= 2.27.0.

Cannot be set at the same time as authorization, basicAuth or bearerTokenSecret.

Type: object

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

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

The key to select.

Type: 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

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

Each additional property must conform to the following schema

Type: string

Type: string

noProxy defines 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.

Type: 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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

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

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

The key to select.

Type: 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

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

The key to select.

Type: 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

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

params define optional HTTP URL parameters.

Each additional property must conform to the following schema

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

path defines the HTTP path from which to scrape for metrics.

If empty, Prometheus uses the default value (e.g. /metrics).

Type: string

port defines the name of the Service port which this endpoint refers to.

It takes precedence over targetPort.

Type: 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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of object

relabelings defines 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

No Additional Items

Each item of this array must be:

Type: object

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

Type: enum (of 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"

Must be one of:

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

Type: integerFormat: int64

modulus to take of the hash of the source label values.

Only applicable when the action is HashMod.

Type: string

regex defines the regular expression against which the extracted value is matched.

Type: string

replacement value against which a Replace action is performed if the
regular expression matches.

Regex capture groups are available.

Type: string

separator defines the string between concatenated SourceLabels.

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: string

LabelName is a valid Prometheus label name.
For Prometheus 3.x, a label name is valid if it contains UTF-8 characters.
For Prometheus 2.x, a label name is only valid if it contains ASCII characters, letters, numbers, as well as underscores.

Type: string

targetLabel defines the 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.

Type: enum (of string)

scheme defines the HTTP scheme to use when scraping the metrics.

Must be one of:

  • "http"
  • "https"
  • "HTTP"
  • "HTTPS"

Type: string

scrapeTimeout defines the 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.

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

Type: object

targetPort defines the 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.

Type: object

tlsConfig defines TLS configuration used by the client.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

The key to select.

Type: 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

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

caFile defines the path to the CA cert in the Prometheus container to use for the targets.

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

The key to select.

Type: 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

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

certFile defines the path to the client cert file in the Prometheus container for the targets.

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: string

keyFile defines the path to the client key file in the Prometheus container for the targets.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

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

Type: 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

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: 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.

Type: enum (of string)

fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.

It requires Prometheus >= v3.0.0.

Must be one of:

  • "PrometheusProto"
  • "OpenMetricsText0.0.1"
  • "OpenMetricsText1.0.0"
  • "PrometheusText0.0.4"
  • "PrometheusText1.0.0"

Type: 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.

Type: integerFormat: int64

keepDroppedTargets defines the 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.

Type: integerFormat: int64

labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

Type: integerFormat: int64

labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

Type: integerFormat: int64

labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.

It requires Prometheus >= v2.27.0.

Type: 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.

Type: boolean

any defines the boolean describing whether all namespaces are selected in contrast to a
list restricting them.

Type: array of string

matchNames defines the list of namespace names to select from.

No Additional Items

Each item of this array must be:

Type: integerFormat: int64

nativeHistogramBucketLimit defines ff 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.

Type: object

nativeHistogramMinBucketFactor defines 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.

Must match regular expression: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: integerFormat: int64

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

Type: string

scrapeClass defines the scrape class to apply.

Must be at least 1 characters long

Type: boolean

scrapeClassicHistograms defines 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.

Type: boolean

scrapeNativeHistograms defines whether to enable scraping of native histograms.
It requires Prometheus >= v3.8.0.

Type: array of enum (of 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.

No Additional Items

Each item of this array must be:

Type: enum (of string)

ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.
Supported values are:
* OpenMetricsText0.0.1
* OpenMetricsText1.0.0
* PrometheusProto
* PrometheusText0.0.4
* PrometheusText1.0.0

Must be one of:

  • "PrometheusProto"
  • "OpenMetricsText0.0.1"
  • "OpenMetricsText1.0.0"
  • "PrometheusText0.0.4"
  • "PrometheusText1.0.0"

Type: object

selector defines the label selector to select the Kubernetes Endpoints objects to scrape metrics from.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

Type: string

key is the label key that the selector applies to.

Type: string

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

Type: array of 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.

No Additional Items

Each item of this array must be:

Type: 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.

Each additional property must conform to the following schema

Type: string

Type: enum (of string)

selectorMechanism defines the 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.

Must be one of:

  • "RelabelConfig"
  • "RoleSelector"

Type: enum (of string)

serviceDiscoveryRole defines the service discovery role used to discover targets.

If set, the value should be either "Endpoints" or "EndpointSlice".
Otherwise it defaults to the value defined in the
Prometheus/PrometheusAgent resource.

Must be one of:

  • "Endpoints"
  • "EndpointSlice"

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: integerFormat: int64

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

Type: object

status defines the status subresource. It 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

Type: array of object

bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.

No Additional Items

Each item of this array must be:

Type: object

WorkloadBinding is a link between a configuration resource and a workload resource.

Type: array of object

conditions defines the current state of the configuration resource when bound to the referenced Workload object.

No Additional Items

Each item of this array must be:

Type: object

ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.

Type: stringFormat: date-time

lastTransitionTime defines the time of the last update to the current status property.

Type: string

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

Type: integerFormat: int64

observedGeneration defines 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.

Type: string

reason for the condition's last transition.

Type: string

status of the condition.

Must be at least 1 characters long

Type: enum (of string)

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

Must be one of:

  • "Accepted"

Type: enum (of string)

group defines the group of the referenced resource.

Must be one of:

  • "monitoring.coreos.com"

Type: string

name defines the name of the referenced object.

Must be at least 1 characters long

Type: string

namespace defines the namespace of the referenced object.

Must be at least 1 characters long

Type: enum (of string)

resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

Must be one of:

  • "prometheuses"
  • "prometheusagents"
  • "thanosrulers"
  • "alertmanagers"