Packages > pkg.pkl-lang.org/pkl-pantry/io.prometheus > io.prometheus.Configuration

ScrapeConfig1.2.0

Overview
Properties
Methods

open class ScrapeConfig extends HttpClientConfig

A set of targets and parameters describing how to scrape them.

Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

ProxyConfig.proxy_url: String? (io.prometheus.Configuration)Source

Optional proxy URL.
link

ProxyConfig.no_proxy: String? (io.prometheus.Configuration)Source

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

ProxyConfig.proxy_from_environment: Boolean? (io.prometheus.Configuration)Source

Use proxy URL indicated by environment variables (HTTP_PROXY, https_proxy, HTTPs_PROXY, https_proxy, and no_proxy)
link

ProxyConfig.proxy_connect_haeder: Mapping<String, Listing<String>>? (io.prometheus.Configuration)Source

Specifies headers to send to proxies during CONNECT requests.
link

HttpClientConfig.basic_auth: BasicAuth?(atMostOneSet(List(this, authorization, oauth2, bearer_token, bearer_token_file))) (io.prometheus.Configuration)Source

Sets the Authorization header on every request with the configured username and password.
link

HttpClientConfig.bearer_token: String? (io.prometheus.Configuration)Source

Deprecated:
Deprecated in favor of Authorization.credentials

Sets the Authorization header on every scrape request with the configured bearer token.
Mutually exclusive with bearer_token_file.
link

HttpClientConfig.bearer_token_file: String? (io.prometheus.Configuration)Source

Deprecated:
Deprecated in favor of Authorization.credentials_file

Sets the Authorization header on every scrape request with the bearer token read from the configured file.
Mutually exclusive with bearer_token.
link

HttpClientConfig.authorization: Authorization? (io.prometheus.Configuration)Source

Sets the Authorization header on every request with the configured credentials.
link

HttpClientConfig.oauth2: OAuth2? (io.prometheus.Configuration)Source

Optional OAuth 2.0 configuration. Cannot be used at the same time as basic_auth or authorization.
link

HttpClientConfig.tls_config: TLSConfig? (io.prometheus.Configuration)Source

Configures the remote read request's TLS settings.
link

HttpClientConfig.follow_redirects: Boolean? (io.prometheus.Configuration)Source

Configure whether scrape requests follow HTTP 3xx redirects.

Defaults to true
link

HttpClientConfig.enable_http2: Boolean? (io.prometheus.Configuration)Source

Whether to enable HTTP2.

Defaults to true
link

job_name: String Source

The job name assigned to scraped metrics by default.
link

scrape_interval: Duration?Source

How frequently to scrape targets from this job.

Default if omitted: GlobalConfig.scrape_interval
link

scrape_timeout: Duration?Source

Per-scrape timeout when scraping this job.

Default if omitted: GlobalConfig.scrape_timeout
link

metrics_path: String?Source

The HTTP resource path on which to fetch metrics from targets.

Default if omitted: "/metrics"
link

honor_labels: Boolean?Source

Controls how Prometheus handles conflicts between labels that are already present in scraped data and labels that Prometheus would attach server-side ("job" and "instance" labels, manually configured target labels, and labels generated by service discovery implementations).

If true, label conflicts are resolved by keeping label values from the scraped data and ignoring the conflicting server-side labels.

If false, label conflicts are resolved by renaming conflicting labels in the scraped data to "exported_" (for example "exported_instance", "exported_job") and then attaching server-side labels.

Setting honor_labels to true is useful for use cases such as federation and scraping the Pushgateway, where all labels specified in the target should be preserved.

Note that any globally configured GlobalConfig.external_labels are unaffected by this setting. In communication with external systems, they are always applied only when a time series does not have a given label yet and are ignored otherwise.

Default if omitted: false
link

honor_timestamps: Boolean?Source

Controls whether Prometheus respects the timestamps present in scraped data.

If true, the timestamps of the metrics exposed by the target will be used.

If false, the timestamps of the metrics exposed by the target will be ignored.

Default if omitted: true
link

scheme: Scheme?Source

Configures the protocol scheme used for requests.

Default if omitted: "http"
link

params: Mapping<String, Listing<String>>?Source

Optional HTTP URL parameters.
link

http_sd_configs: Listing<HttpSdConfig>?Source

List of HTTP service discovery configurations.
link

kubernetes_sd_configs: Listing<KubernetesSdConfig>?Source

List of Kubernetes service discovery configurations.
link

file_sd_configs: Listing<FileSdConfig>?Source

List of file service discovery configurations.
link

dns_sd_configs: Listing<DnsSdConfig>?Source

List of DNS-based service discovery configurations.
link

static_configs: Listing<StaticConfig>?Source

List of labeled statically configured targets for this job.
link

relabel_configs: Listing<RelabelConfig>?Source

List of target relabel configurations.
link

metric_relabel_configs: Listing<RelabelConfig>?Source

List of metric relabel configurations.
link

sample_limit: UInt?Source

Per-scrape limit on number of scraped samples that will be accepted.

If more than this number of samples are present after metric relabeling, the entire scrape will be treated as failed. 0 means no limit.

Default if omitted: 0
link

target_limit: UInt?Source

Per-scrape config limit on number of unique targets that will be accepted.

If more than this number of targets are present after target relabeling, Prometheus will mark the targets as failed without scraping them. 0 means no limit.

This is an experimental feature, this behaviour could change in the future.

Default if omitted: 0

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.