NAME

IO::K8s::PrometheusOperator::V1alpha1::ScrapeConfigSpec - spec defines the specification of ScrapeConfigSpec.

VERSION

version 1.108

authorization

authorization defines the header to use on every scrape request.

azureSDConfigs

azureSDConfigs defines a list of Azure service discovery configurations.

basicAuth

basicAuth defines information to use on every scrape request.

bodySizeLimit

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.

consulSDConfigs

consulSDConfigs defines a list of Consul service discovery configurations.

convertClassicHistogramsToNHCB

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

digitalOceanSDConfigs

digitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.

dnsSDConfigs

dnsSDConfigs defines a list of DNS service discovery configurations.

dockerSDConfigs

dockerSDConfigs defines a list of Docker service discovery configurations.

dockerSwarmSDConfigs

dockerSwarmSDConfigs defines a list of Dockerswarm service discovery configurations.

ec2SDConfigs

ec2SDConfigs defines a list of EC2 service discovery configurations.

enableCompression

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

enableHTTP2 defines whether to enable HTTP2.

eurekaSDConfigs

eurekaSDConfigs defines a list of Eureka service discovery configurations.

fallbackScrapeProtocol

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

It requires Prometheus >= v3.0.0.

fileSDConfigs

fileSDConfigs defines a list of file service discovery configurations.

gceSDConfigs

gceSDConfigs defines a list of GCE service discovery configurations.

hetznerSDConfigs

hetznerSDConfigs defines a list of Hetzner service discovery configurations.

honorLabels

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

honorTimestamps

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

httpSDConfigs

httpSDConfigs defines a list of HTTP service discovery configurations.

ionosSDConfigs

ionosSDConfigs defines a list of IONOS service discovery configurations.

jobName

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.

keepDroppedTargets

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.

kubernetesSDConfigs

kubernetesSDConfigs defines a list of Kubernetes service discovery configurations.

kumaSDConfigs

kumaSDConfigs defines a list of Kuma service discovery configurations.

labelLimit

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.

labelNameLengthLimit

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.

labelValueLengthLimit

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.

lightSailSDConfigs

lightSailSDConfigs defines a list of Lightsail service discovery configurations.

linodeSDConfigs

linodeSDConfigs defines a list of Linode service discovery configurations.

metricRelabelings

metricRelabelings defines the metricRelabelings to apply to samples before ingestion.

metricsPath

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

nameEscapingScheme

nameEscapingScheme defines the metric name escaping mode to request through content negotiation.

It requires Prometheus >= v3.4.0.

nameValidationScheme

nameValidationScheme defines the validation scheme for metric and label names.

It requires Prometheus >= v3.0.0.

nativeHistogramBucketLimit

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.

nativeHistogramMinBucketFactor

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.

noProxy

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.

nomadSDConfigs

nomadSDConfigs defines a list of Nomad service discovery configurations.

oauth2

oauth2 defines the configuration to use on every scrape request.

openstackSDConfigs

openstackSDConfigs defines a list of OpenStack service discovery configurations.

ovhcloudSDConfigs

ovhcloudSDConfigs defines a list of OVHcloud service discovery configurations.

params

params defines optional HTTP URL parameters

proxyConnectHeader

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

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

proxyUrl defines the HTTP proxy server to use.

puppetDBSDConfigs

puppetDBSDConfigs defines a list of PuppetDB service discovery configurations.

relabelings

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

sampleLimit

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

scalewaySDConfigs

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

scheme

scheme defines the protocol scheme used for requests.

scrapeClass

scrapeClass defines the scrape class to apply.

scrapeClassicHistograms

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

scrapeInterval defines the interval between consecutive scrapes.

scrapeNativeHistograms

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

scrapeProtocols

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.

scrapeTimeout

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.

staticConfigs

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

targetLimit

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

tlsConfig

tlsConfig defines the TLS configuration to use on every scrape request

trackTimestampsStaleness

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.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/pplu/io-k8s-p5/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHORS

  • Torsten Raudssus <getty@cpan.org>

  • Jose Luis Martinez Torres <jlmartin@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2026 by Jose Luis Martinez Torres <jlmartin@cpan.org>.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004