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

io.prometheus.Rule1.2.0

Overview
Properties
Methods
Classes
Type Aliases

open module io.prometheus.Rule extends io.prometheus.PrometheusObject

Prometheus supports two types of rules which may be configured and then evaluated at regular intervals: recording rules and alerting rules.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/io.prometheus@1.2.0#/Rule.pkl
Pkl version:: 0.25.0 or higher
Source code:: Rule.pkl
Known subtypes:
Known usages:
All versions:: 1.2.0, 1.1.3, 1.1.2, 1.1.1, 1.1.0, 1.0.0

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

groups: Listing<RuleGroup>?Source

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

RecordingRuleGroup Source
link

class

AlertingRuleGroup Source
link

class

AlertingRule Source

Alerting rules allow you to define alert conditions based on Prometheus expression language expressions and to send notifications about firing alerts to an external service.
link

class

RecordingRule Source

Recording rules allow you to precompute frequently needed or computationally expensive expressions and save their result as a new set of time series.

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

RuleGroup = AlertingRuleGroup|RecordingRuleGroup Source