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

AlertingRule1.0.0

Overview
Properties
Methods

class AlertingRule

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.

Known subtypes:
Known usages:: AlertingRuleGroup
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

alert: String Source

The name of the alert. Must be a valid label value.
link

expr: String Source

The PromQL expression to evaluate.

Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
link

`for`: Duration?Source

Alerts are considered firing once they have been returned for this long.

Alerts which have not yet fired for long enough are considered pending.

Default if omitted: 0.s
link

labels: Labels?Source

Labels to add or overwrite for each alert.
link

annotations: Mapping<String, String>?Source

Annotations to add to each alert.

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.