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

KubernetesSdConfig1.2.0

Overview
Properties
Methods

class KubernetesSdConfig extends HttpClientConfig

Allow retrieving scrape targets from Kubernetes' REST API and always staying synchronized with the cluster state.

Known subtypes:
Known usages:: AlertManagerConfig, ScrapeConfig
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

role: KubernetesSdConfigRole Source

The Kubernetes role of entities that should be discovered.
link

namespaces: NamespaceSpec?Source

Optional namespace discovery.

Default if omitted: all namespaces are used
link

api_server: String?Source

The API server addresses.

If left empty, Prometheus is assumed to run inside of the cluster and will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
link

selectors: Listing<KubernetesSdConfigSelector>?Source

Optional label and field selectors to limit the discovery process to a subset of available resources.

See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/ and https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ to learn more about the possible filters that can be used. Endpoints role supports pod, service and endpoints selectors, other roles only support selectors matching the role itself (e.g. node role can only contain node selectors).

Note: When making decision about using field/label selector, make sure that this is the best approach - it will prevent Prometheus from reusing single list/watch for all scrape configs. This might result in a bigger load on the Kubernetes API, because per each selector combination there will be additional LIST/WATCH. On the other hand, if you just want to monitor small subset of pods in large cluster, it's recommended to use selectors. If selectors should be used or not depends on the particular situation.
link

attach_metadata: KubernetesSdConfigAttachMetadata(node?.implies(role is KubernetesSdConfigRoleWithNodeMetadata) || true)?Source

Optional metadata to attach to discovered targets. If omitted, no additional metadata is attached.

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.