NAME
IO::K8s::PrometheusOperator::V1::ProbeSpec - spec defines the specification of desired Ingress selection for target discovery by Prometheus.
VERSION
version 1.108
authorization
authorization configures the Authorization header credentials used by the client.
Cannot be set at the same time as `basicAuth`, `bearerTokenSecret` or `oauth2`.
basicAuth
basicAuth defines the Basic Authentication credentials used by the client.
Cannot be set at the same time as `authorization`, `bearerTokenSecret` or `oauth2`.
bearerTokenSecret
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.
convertClassicHistogramsToNHCB
convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.
enableHttp2
enableHttp2 can be used to disable HTTP2.
fallbackScrapeProtocol
fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
It requires Prometheus >= v3.0.0.
followRedirects
followRedirects defines whether the client should follow HTTP 3xx redirects.
interval
interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.
jobName
jobName assigned to scraped metrics by default.
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.
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.
metricRelabelings
metricRelabelings defines the RelabelConfig to apply to samples before ingestion.
module
module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml
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.
oauth2
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`.
params
params defines the list of HTTP query parameters for the scrape. Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.
prober
prober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
sampleLimit
sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
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.
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 timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
targetLimit
targetLimit defines a limit on the number of scraped targets that will be accepted.
targets
targets defines a set of static or dynamically discovered targets to probe.
tlsConfig
tlsConfig defines the TLS configuration used by the client.
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