OpenTelemetry.Metrics_Internal

This is an internal module. The public interface is re-exported by OpenTelemetry.Eventlog

This module implements the instruments of the metrics portion of the OpenTelemetry API. It is reexported by OpenTelemetry.Eventlog and should be used by importing that.

The way to use the Instrument type is throught the add, record or observe functions (depending on the instrument type) which capture metrics on a given instrument.

Usage:

import OpenTelemetry.Eventlog

aCounter :: Counter
aCounter = Counter "myCounter"

anObserver :: ValueObserver
anObserver = ValueObserver "myObserver"

main :: IO ()
main = do
  add aCounter 3
  record anObserver 40

Documentation

data Instrument (s :: Synchronicity) (a :: Additivity) (m :: Monotonicity) where

An OpenTelemetry instrument as defined in the OpenTelemetry Metrics API (https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/metrics/api.md)

Constructors

Counter :: InstrumentName -> InstrumentId -> Counter

UpDownCounter :: InstrumentName -> InstrumentId -> UpDownCounter

ValueRecorder :: InstrumentName -> InstrumentId -> ValueRecorder

SumObserver :: InstrumentName -> InstrumentId -> SumObserver

UpDownSumObserver :: InstrumentName -> InstrumentId -> UpDownSumObserver

ValueObserver :: InstrumentName -> InstrumentId -> ValueObserver

Instances

Eq (Instrument s a m)

Defined in OpenTelemetry.Metrics_Internal

Methods

(==) :: Instrument s a m -> Instrument s a m -> Bool

(/=) :: Instrument s a m -> Instrument s a m -> Bool

Show (Instrument s a m)

Defined in OpenTelemetry.Metrics_Internal

Methods

showsPrec :: Int -> Instrument s a m -> ShowS

show :: Instrument s a m -> String

showList :: [Instrument s a m] -> ShowS

Hashable (Instrument s a m)

Defined in OpenTelemetry.Metrics_Internal

Methods

hashWithSalt :: Int -> Instrument s a m -> Int

hash :: Instrument s a m -> Int

data SomeInstrument

Existential wrapper for Instrument. Use when the exact type of Instrument does not matter.

Constructors

SomeInstrument (Instrument s a m)

Instances

Eq SomeInstrument

Defined in OpenTelemetry.Metrics_Internal

Methods

(==) :: SomeInstrument -> SomeInstrument -> Bool

(/=) :: SomeInstrument -> SomeInstrument -> Bool

Show SomeInstrument

Defined in OpenTelemetry.Metrics_Internal

Methods

showsPrec :: Int -> SomeInstrument -> ShowS

show :: SomeInstrument -> String

showList :: [SomeInstrument] -> ShowS

Hashable SomeInstrument

Defined in OpenTelemetry.Metrics_Internal

Methods

hashWithSalt :: Int -> SomeInstrument -> Int

hash :: SomeInstrument -> Int

Synonyms for specific types of Instrument

type Counter = Instrument Synchronous Additive Monotonic

type UpDownCounter = Instrument Synchronous Additive NonMonotonic

type ValueRecorder = Instrument Synchronous NonAdditive NonMonotonic

type SumObserver = Instrument Asynchronous Additive Monotonic

type UpDownSumObserver = Instrument Asynchronous Additive NonMonotonic

type ValueObserver = Instrument Asynchronous NonAdditive NonMonotonic

Used for indexing Instrument. All possible combinations are covered

data Synchronicity

Constructors

Synchronous

Asynchronous

data Additivity

Constructors

Additive

NonAdditive

data Monotonicity

Constructors

Monotonic

NonMonotonic

type InstrumentName = ByteString

type InstrumentId = Word64

instrumentName :: Instrument s a m -> InstrumentName

instrumentId :: Instrument s a m -> InstrumentId