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

io.prometheus.Configuration1.2.0

Overview
Properties
Methods
Classes
Type Aliases

open module io.prometheus.Configuration extends io.prometheus.PrometheusObject

Prometheus is configured via command-line flags and a configuration file.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/io.prometheus@1.2.0#/Configuration.pkl
Pkl version:: 0.25.0 or higher
Source code:: Configuration.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

global: GlobalConfig?Source

The global configuration specifies parameters that are valid in all other configuration contexts.

They also serve as defaults for other configuration sections.
link

alerting: AlertingConfig?Source

Alerting specifies settings related to the Alertmanager.
link

scrape_configs: Listing<ScrapeConfig>?Source

A list of scrape configurations.
link

remote_write: Listing<RemoteWriteConfig>?Source

Settings related to the remote write feature.
link

remote_read: Listing<RemoteReadConfig>?Source

Settings related to the remote read feature.
link

rule_files: Listing<String>?Source

A list of globs. Rules and alerts are read from all matching files.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```

Classes

link

class

GlobalConfig Source
link

open class

ScrapeConfig extends HttpClientConfig Source

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

class

KubernetesSdConfig extends HttpClientConfig Source

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

class

KubernetesSdConfigSelector Source
link

class

KubernetesSdConfigAttachMetadata Source
link

class

FileSdConfig Source

File-based service discovery provides a more generic way to configure static targets and serves as an interface to plug in custom service discovery mechanisms.
link

class

DnsSdConfig Source

DNS-based service discovery configuration allows specifying a set of DNS domain names which are periodically queried to discover a list of targets.
link

class

NamespaceSpec Source
link

class

HttpSdConfig extends HttpClientConfig Source

HTTP-based service discovery provides a more generic way to configure static targets and serves as an interface to plug in custom service discovery mechanisms.
link

class

RelabelConfig Source

Relabeling is a powerful tool to dynamically rewrite the label set of a target before it gets scraped.
link

class

StaticConfig Source

Allows specifying a list of targets and a common label set for them.
link

class

RemoteWriteConfig extends HttpClientConfig Source

write_relabel_configs is relabeling applied to samples before sending them to the remote endpoint.
link

class

MetadataConfig Source
link

class

QueueConfig Source
link

class

AlertingConfig Source
link

class

AlertManagerConfig extends HttpClientConfig Source

Specifies Alertmanager instances the Prometheus server sends alerts to.
link

class

RemoteReadConfig extends HttpClientConfig Source
link

class

Sigv4Config Source
link

abstract class

ProxyConfig Source
link

abstract class

HttpClientConfig extends ProxyConfig Source
link

class

BasicAuth Source
link

class

Authorization Source
link

class

OAuth2 extends ProxyConfig Source
link

class

TLSConfig Source

Allows configuring TLS connections.

Type Aliases(show inherited)

link

typealias

MetricNameFormat = String(matches(Regex(#"[a-zA-Z_:][a-zA-Z0-9_:]*"#))) (io.prometheus.PrometheusObject)
link

typealias

LabelNameFormat = String(matches(Regex(#"[a-zA-Z_][a-zA-Z0-9_]*"#))) (io.prometheus.PrometheusObject)
link

typealias

Labels = Mapping<LabelNameFormat, (String|Number|Boolean)> (io.prometheus.PrometheusObject)
link

typealias

Scheme = "http"|"https" (io.prometheus.PrometheusObject)
link

typealias

KubernetesSdConfigRole = "pod"|"service"|"node"|"endpoints"|"endpointslice"|"ingress"Source
link

typealias

KubernetesSdConfigRoleWithNodeMetadata = "pod"|"endpoints"|"endpointslice"Source

KubernetesSdConfig.role values that KubernetesSdConfigAttachMetadata.node may be enabled with
link

typealias
RelabelAction = "replace"|"keep"|"drop"|"hashmod"|"labelmap"|"labeldrop"|"labelkeep"Source

Which relabel action to perform.
- "replace": Match regex against the concatenated source_labels. Then, set target_label to replacement, with match group references (${1}, ${2}, ...) in replacement substituted by their value. If regex does not match, no replacement takes place.
- "keep": Drop targets for which regex does not match the concatenated source_labels.
- "drop": Drop targets for which regex matches the concatenated source_labels.
- "hashmod": Set target_label to the modulus of a hash of the concatenated source_labels.
- "labelmap": Match regex against all label names. Then copy the values of the matching labels to label names given by replacement with match group references (${1}, ${2}, ...) in replacement substituted by their value.
- "labeldrop": Match regex against all label names. Any label that matches will be removed from the set of labels.
- "labelkeep": Match regex against all label names.
link

typealias

TLSVersion = "TLS10"|"TLS11"|"TLS12"|"TLS13"Source