Skip to content

workflow.v1alpha1.prometheus

"Prometheus is a prometheus metric to be emitted"

Index

Fields

fn withHelp

withHelp(help)

"Help is a string that describes the metric"

fn withLabels

withLabels(labels)

"Labels is a list of metric labels"

fn withLabelsMixin

withLabelsMixin(labels)

"Labels is a list of metric labels"

Note: This function appends passed data to existing values

fn withName

withName(name)

"Name is the name of the metric"

fn withWhen

withWhen(when)

"When is a conditional statement that decides when to emit the metric"

obj counter

"Counter is a Counter prometheus metric"

fn counter.withValue

withValue(value)

"Value is the value of the metric"

obj gauge

"Gauge is a Gauge prometheus metric"

fn gauge.withOperation

withOperation(operation)

"Operation defines the operation to apply with value and the metrics' current value"

fn gauge.withRealtime

withRealtime(realtime)

"Realtime emits this metric in real time if applicable"

fn gauge.withValue

withValue(value)

"Value is the value to be used in the operation with the metric's current value. If no operation is set, value is the value of the metric"

obj histogram

"Histogram is a Histogram prometheus metric"

fn histogram.withBuckets

withBuckets(buckets)

"Buckets is a list of bucket divisors for the histogram"

fn histogram.withBucketsMixin

withBucketsMixin(buckets)

"Buckets is a list of bucket divisors for the histogram"

Note: This function appends passed data to existing values

fn histogram.withValue

withValue(value)

"Value is the value of the metric"