System.Remote.Gauge

This module defines a type for mutable, integer-valued gauges. Gauges are variable values and can be used to track e.g. the current number of concurrent connections. All operations on gauges are thread-safe.

N.B. This module exists to maintain backwards compatibility with older versions of this library. New code should use the System.Metrics.Gauge module from the ekg-core package instead.

Documentation

data Gauge :: *

A mutable, integer-valued gauge.

inc :: Gauge -> IO ()

Increase the gauge by one.

dec :: Gauge -> IO ()

Decrease the gauge by one.

add :: Gauge -> Int64 -> IO ()

Increase the gauge by the given amount.

subtract :: Gauge -> Int64 -> IO ()

Decrease the gauge by the given amount.

set :: Gauge -> Int64 -> IO ()

Set the gauge to the given value.