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

KubernetesSdConfig1.1.2

Overview
Properties
Methods

class KubernetesSdConfig

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

link

role: "pod"|"service"|"node"|"endpoints"|"ingress"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.

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.