prometheus operator v0.93.1

ScrapeConfig.spec.dockerSDConfigs.tlsConfig.ca.secret.spec

spec defines the specification of ScrapeConfigSpec.

61 fields
ScrapeConfig.spec.dockerSDConfigs.tlsConfig.ca.secret.spec fields and descriptions
Field / TypeDescription
object

authorization defines the header to use on every scrape request.

object[]

azureSDConfigs defines a list of Azure service discovery configurations.

object

basicAuth defines information to use on every scrape request.

bodySizeLimit
string

bodySizeLimit defines a per-scrape limit on the size of the uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail. It requires Prometheus >= v2.28.0.

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

consulSDConfigs defines a list of Consul service discovery configurations.

convertClassicHistogramsToNHCB
boolean

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

object[]

digitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.

object[]

dnsSDConfigs defines a list of DNS service discovery configurations.

object[]

dockerSDConfigs defines a list of Docker service discovery configurations.

object[]

dockerSwarmSDConfigs defines a list of Dockerswarm service discovery configurations.

object[]

ec2SDConfigs defines a list of EC2 service discovery configurations.

enableCompression
boolean

enableCompression when false, Prometheus will request uncompressed response from the scraped target. It requires Prometheus >= v2.49.0. If unset, Prometheus uses true by default.

enableHTTP2
boolean

enableHTTP2 defines whether to enable HTTP2.

object[]

eurekaSDConfigs defines a list of Eureka service discovery configurations.

fallbackScrapeProtocol
string

fallbackScrapeProtocol defines 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"]
object[]

fileSDConfigs defines a list of file service discovery configurations.

object[]

gceSDConfigs defines a list of GCE service discovery configurations.

object[]

hetznerSDConfigs defines a list of Hetzner service discovery configurations.

honorLabels
boolean

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

honorTimestamps
boolean

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

object[]

httpSDConfigs defines a list of HTTP service discovery configurations.

object[]

ionosSDConfigs defines a list of IONOS service discovery configurations.

jobName
string

jobName defines the value of the `job` label assigned to the scraped metrics by default. The `job_name` field in the rendered scrape configuration is always controlled by the operator to prevent duplicate job names, which Prometheus does not allow. Instead the `job` label is set by means of relabeling configs.

  • minLength: 1
keepDroppedTargets
integer

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.

  • format: int64
  • minimum: 0
object[]

kubernetesSDConfigs defines a list of Kubernetes service discovery configurations.

object[]

kumaSDConfigs defines a list of Kuma service discovery configurations.

labelLimit
integer

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

  • format: int64
  • minimum: 0
labelNameLengthLimit
integer

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

  • format: int64
  • minimum: 0
labelValueLengthLimit
integer

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

  • format: int64
  • minimum: 0
object[]

lightSailSDConfigs defines a list of Lightsail service discovery configurations.

object[]

linodeSDConfigs defines a list of Linode service discovery configurations.

object[]

metricRelabelings defines the metricRelabelings to apply to samples before ingestion.

  • minItems: 1
metricsPath
string

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

  • minLength: 1
nameEscapingScheme
string

nameEscapingScheme defines the metric name escaping mode to request through content negotiation. It requires Prometheus >= v3.4.0.

  • enum: ["AllowUTF8","Underscores","Dots","Values"]
nameValidationScheme
string

nameValidationScheme defines the validation scheme for metric and label names. It requires Prometheus >= v3.0.0.

  • enum: ["UTF8","Legacy"]
nativeHistogramBucketLimit
integer

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.

  • format: int64
  • minimum: 0
integer | string

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.

  • pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  • x-kubernetes-int-or-string: true
noProxy
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.

object[]

nomadSDConfigs defines a list of Nomad service discovery configurations.

object

oauth2 defines the configuration to use on every scrape request.

object[]

openstackSDConfigs defines a list of OpenStack service discovery configurations.

object[]

ovhcloudSDConfigs defines a list of OVHcloud service discovery configurations.

map[string]string[]

params defines optional HTTP URL parameters

  • x-kubernetes-map-type: "atomic"
map[string]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.

  • x-kubernetes-map-type: "atomic"
proxyFromEnvironment
boolean

proxyFromEnvironment defines 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)://.+$
object[]

puppetDBSDConfigs defines a list of PuppetDB service discovery configurations.

object[]

relabelings defines how to rewrite the target's labels 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

  • minItems: 1
sampleLimit
integer

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

  • format: int64
  • minimum: 0
object[]

scalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations.

scheme
string

scheme defines the protocol scheme used for requests.

  • enum: ["http","https","HTTP","HTTPS"]
scrapeClass
string

scrapeClass defines the scrape class to apply.

  • minLength: 1
scrapeClassicHistograms
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.

scrapeInterval
string

scrapeInterval defines the interval between consecutive scrapes.

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

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

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.

  • minItems: 1
  • x-kubernetes-list-type: "set"
scrapeTimeout
string

scrapeTimeout defines the number of seconds to wait until a scrape request times out. 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)?)$
object[]

staticConfigs defines a list of static targets with a common label set.

targetLimit
integer

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

  • format: int64
  • minimum: 0
object

tlsConfig defines the TLS configuration to use on every scrape request

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.