×

Specification

Property Type Description

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

ObjectMeta_v2

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

spec

object

Specification of desired Service selection for target discovery by Prometheus.

.spec

Description

Specification of desired Service selection for target discovery by Prometheus.

Type

object

Required
  • endpoints

  • selector

Property Type Description

endpoints

array

A list of endpoints allowed as part of this ServiceMonitor.

endpoints[]

object

Endpoint defines a scrapeable endpoint serving Prometheus metrics.

jobLabel

string

Chooses the label of the Kubernetes Endpoints. Its value will be used for the job-label’s value of the created metrics. Default & fallback value: the name of the respective Kubernetes Endpoint.

labelLimit

integer

Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.

labelNameLengthLimit

integer

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.

labelValueLengthLimit

integer

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.

namespaceSelector

object

Selector to select which namespaces the Kubernetes Endpoints objects are discovered from.

podTargetLabels

array (string)

PodTargetLabels transfers labels on the Kubernetes Pod onto the created metrics.

sampleLimit

integer

SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.

selector

object

Selector to select Endpoints objects.

targetLabels

array (string)

TargetLabels transfers labels from the Kubernetes Service onto the created metrics.

targetLimit

integer

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

.spec.endpoints

Description

A list of endpoints allowed as part of this ServiceMonitor.

Type

array

.spec.endpoints[]

Description

Endpoint defines a scrapeable endpoint serving Prometheus metrics.

Type

object

Property Type Description

authorization

object

Authorization section for this endpoint

basicAuth

object

BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints

bearerTokenFile

string

File to read bearer token for scraping targets.

bearerTokenSecret

object

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.

followRedirects

boolean

FollowRedirects configures whether scrape requests follow HTTP 3xx redirects.

honorLabels

boolean

HonorLabels chooses the metric’s labels on collisions with target labels.

honorTimestamps

boolean

HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.

interval

string

Interval at which metrics should be scraped If not specified Prometheus' global scrape interval is used.

metricRelabelings

array

MetricRelabelConfigs to apply to samples before ingestion.

metricRelabelings[]

object

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

oauth2

object

OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.

params

object

Optional HTTP URL parameters

params{}

array (string)

path

string

HTTP path to scrape for metrics.

port

string

Name of the service port this endpoint refers to. Mutually exclusive with targetPort.

proxyUrl

string

ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.

relabelings

array

RelabelConfigs to apply to samples before scraping. Prometheus 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

relabelings[]

object

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

scheme

string

HTTP scheme to use for scraping.

scrapeTimeout

string

Timeout after which the scrape is ended If not specified, the Prometheus global scrape timeout is used unless it is less than Interval in which the latter is used.

targetPort

integer-or-string

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.

tlsConfig

object

TLS configuration to use when scraping the endpoint

.spec.endpoints[].authorization

Description

Authorization section for this endpoint

Type

object

Property Type Description

credentials

object

The secret’s key that contains the credentials of the request

type

string

Set the authentication type. Defaults to Bearer, Basic will cause an error

.spec.endpoints[].authorization.credentials

Description

The secret’s key that contains the credentials of the request

Type

object

Required
  • key

Property Type Description

key