Observe.Event.Render.Prometheus

Documentation

prometheusEventBackend :: forall es s. EventMetrics es => Registry -> RenderSelectorPrometheus s es -> IO (EventBackend IO PrometheusReference s)

An EventBackend that populates a Registry.

All metrics are registered before the backend is returned.

class (EventMetric (Counter es), EventMetric (Gauge es), EventHistogram (Histogram es)) => EventMetrics es

A specification of a collection of prometheus metrics.

Note that due to limitations in the underlying prometheus client library, summaries are not yet supported.

Associated Types

type Counter es

The counters

type Gauge es

The gauges

type Histogram es

The histograms

class (Ord a, Enum a, Bounded a) => EventMetric a where

A specification of a single prometheus metric of any type

Must satisfy ∀ x : a, x `elem` [minBound .. maxBound]

Methods

metricName :: a -> Name

The name of the metric

metricLabels :: a -> Labels

The labels of the metric

class EventMetric h => EventHistogram h where

A specification of a prometheus histogram

Methods

metricBounds :: h -> [UpperBound]

The upper bounds of the histogram buckets.

type RenderSelectorPrometheus s es = forall f. s f -> PrometheusRendered f es

Render all events selectable by s to prometheus metrics according to EventMetrics es

We may want to add functionality for easily combining RenderSelectorPrometheuss and EventMetrics from nested selector types, possibly with additional labels layered on top.

data PrometheusRendered f es

How to render a specific Event according to EventMetrics es

Constructors

PrometheusRendered

Fields

• onStart :: !([f] -> EventDuration -> [MetricModification es])

  Modify metrics at event start

  Passed the newEventInitialFields.

• onField :: !(f -> [MetricModification es])

  Modify metrics when a field is added

  Only called for events added with addField

• onFinalize :: !(Maybe SomeException -> [f] -> [MetricModification es])

  Modify metrics when an event finishes.

  Passed all event fields (both initial fields and those added during the event lifetime).

  This is not called if the event is Immediate.

data MetricModification es

DSL for modifying metrics specified in EventMetrics es

Constructors

ModifyCounter !CounterModification !(Counter es)

Modify the specified counter

ModifyGauge !GaugeModification !(Gauge es)

Modify the specified gauge

ModifyHistogram !HistogramModification !(Histogram es)

Modify the specified histogram

data CounterModification

DSL for modifying a counter metric

Constructors

AddCounter !Int

Add a value to a counter

IncCounter

Increment a counter

data GaugeModification

DSL for modifying a gauge metric

Constructors

AddGauge !Double

Add a value to a gauge

Sub !Double

Subtract a value from a gauge

IncGauge

Increment a gauge

Dec

Decrement a gauge

Set !Double

Set the value of a gauge

data HistogramModification

DSL for modifying a histogram metric

Constructors

Observe !Double

Record an observation

data EventDuration

What duration event is this?

Constructors

Immediate

A immediately finalized event

Extended

An event with an extended lifetime

data PrometheusReference

Reference type for prometheusEventBackend

Prometheus can't make use of references, so this carries no information.

Constructors

PrometheusReference

data NonExhaustiveMetricEnumeration

Exception thrown if we encounter an element of an EventMetric that is not in [minBound .. maxBound]

Constructors

NonExhaustiveMetricEnumeration

Instances

Exception NonExhaustiveMetricEnumeration

Defined in Observe.Event.Render.Prometheus

Methods

toException :: NonExhaustiveMetricEnumeration -> SomeException

fromException :: SomeException -> Maybe NonExhaustiveMetricEnumeration

displayException :: NonExhaustiveMetricEnumeration -> String

Show NonExhaustiveMetricEnumeration

Defined in Observe.Event.Render.Prometheus

Methods

showsPrec :: Int -> NonExhaustiveMetricEnumeration -> ShowS

show :: NonExhaustiveMetricEnumeration -> String

showList :: [NonExhaustiveMetricEnumeration] -> ShowS