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

RemoteReadConfig1.3.0

Properties
Methods

class RemoteReadConfig extends HttpClientConfig

Known subtypes:
Known usages:: Configuration
All versions:: 1.3.0, 1.2.0, 1.1.3, 1.1.2, 1.1.1, 1.1.0, 1.0.0

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

url: String Source

The URL of the endpoint to query from.
link

name: String?Source

Name of the remote read config, which if specified must be unique among remote read configs.

The name will be used in metrics and logging in place of a generated value to help users distinguish between remote read configs.
link

required_matchers: Labels?Source

An optional list of equality matchers which have to be present in a selector to query the remote read endpoint.
link

remote_timeout: Duration?Source

Timeout for requests to the remote read endpoint.

Default if omitted: 1.min
link

read_recent: Boolean?Source

Whether reads should be made for queries for time ranges that the local storage should have complete data for.

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.