Safe Haskell	None
Language	Haskell2010

OpenTelemetry.Common

Synopsis

type Timestamp = Word64
newtype SpanName = SpanName Text
newtype TagName = TagName Text
newtype TagVal = TagVal Text
newtype EventName = EventName Text
newtype EventVal = EventVal Text
data TagValue
- = StringTagValue !TagVal
- | BoolTagValue !Bool
- | IntTagValue !Int
- | DoubleTagValue !Double
class ToTagValue a where
- toTagValue :: a -> TagValue
data Span = Span {
- spanContext :: !SpanContext
- spanOperation :: Text
- spanThreadId :: Word32
- spanStartedAt :: !Timestamp
- spanFinishedAt :: !Timestamp
- spanTags :: !(HashMap TagName TagValue)
- spanEvents :: [SpanEvent]
- spanStatus :: !SpanStatus
- spanParentId :: Maybe SpanId
- spanNanosecondsSpentInGC :: !Word64
}
data InstrumentType
- = CounterType
- | UpDownCounterType
- | ValueRecorderType
- | SumObserverType
- | UpDownSumObserverType
- | ValueObserverType
data CaptureInstrument = CaptureInstrument {
- instrumentType :: !InstrumentType
- instrumentName :: !ByteString
}
data Metric = Metric {
- instrument :: !CaptureInstrument
- datapoints :: ![MetricDatapoint Int]
}
data AggregatedMetric = AggregatedMetric {
- instrument :: !CaptureInstrument
- datapoint :: !(MetricDatapoint Int)
}
data MetricDatapoint a = MetricDatapoint {
- timestamp :: !Timestamp
- value :: !a
}
spanTraceId :: Span -> TraceId
spanId :: Span -> SpanId
data SpanEvent = SpanEvent {
- spanEventTimestamp :: !Timestamp
- spanEventKey :: !EventName
- spanEventValue :: !EventVal
}
data SpanStatus = OK
data Event = Event Text Timestamp
data SpanProcessor = SpanProcessor {
- onStart :: Span -> IO ()
- onEnd :: Span -> IO ()
}
data OpenTelemetryConfig = OpenTelemetryConfig {
- otcSpanExporter :: Exporter Span
}
data ExportResult
- = ExportSuccess
- | ExportFailedRetryable
- | ExportFailedNotRetryable
data Exporter thing = Exporter {
- export :: [thing] -> IO ExportResult
- shutdown :: IO ()
}
readInstrumentTag :: Int8 -> Maybe InstrumentType
additive :: InstrumentType -> Bool
noopExporter :: Exporter whatever
aggregated :: Exporter AggregatedMetric -> IO (Exporter Metric)
now64 :: IO Timestamp

Documentation

type Timestamp = Word64 Source #

newtype SpanName Source #

Constructors

SpanName Text

Instances

Eq SpanName Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: SpanName -> SpanName -> Bool # (/=) :: SpanName -> SpanName -> Bool #
Show SpanName Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> SpanName -> ShowS # show :: SpanName -> String # showList :: [SpanName] -> ShowS #
Generic SpanName Source #
Instance details Defined in OpenTelemetry.Common Associated Types type Rep SpanName :: Type -> Type # Methods from :: SpanName -> Rep SpanName x # to :: Rep SpanName x -> SpanName #
type Rep SpanName Source #
Instance details Defined in OpenTelemetry.Common type Rep SpanName = D1 (MetaData "SpanName" "OpenTelemetry.Common" "opentelemetry-extra-0.6.1-FScfpIqnq1Q3XlqEbIlE01" True) (C1 (MetaCons "SpanName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype TagName Source #

Constructors

TagName Text

Instances

Eq TagName Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: TagName -> TagName -> Bool # (/=) :: TagName -> TagName -> Bool #
Show TagName Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> TagName -> ShowS # show :: TagName -> String # showList :: [TagName] -> ShowS #
IsString TagName Source #
Instance details Defined in OpenTelemetry.Common Methods fromString :: String -> TagName #
Generic TagName Source #
Instance details Defined in OpenTelemetry.Common Associated Types type Rep TagName :: Type -> Type # Methods from :: TagName -> Rep TagName x # to :: Rep TagName x -> TagName #
Hashable TagName Source #
Instance details Defined in OpenTelemetry.Common Methods hashWithSalt :: Int -> TagName -> Int # hash :: TagName -> Int #
ToJSONKey TagName Source #
Instance details Defined in OpenTelemetry.Common Methods toJSONKey :: ToJSONKeyFunction TagName # toJSONKeyList :: ToJSONKeyFunction [TagName] #
type Rep TagName Source #
Instance details Defined in OpenTelemetry.Common type Rep TagName = D1 (MetaData "TagName" "OpenTelemetry.Common" "opentelemetry-extra-0.6.1-FScfpIqnq1Q3XlqEbIlE01" True) (C1 (MetaCons "TagName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype TagVal Source #

Constructors

TagVal Text

Instances

Eq TagVal Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: TagVal -> TagVal -> Bool # (/=) :: TagVal -> TagVal -> Bool #
Show TagVal Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> TagVal -> ShowS # show :: TagVal -> String # showList :: [TagVal] -> ShowS #
Generic TagVal Source #
Instance details Defined in OpenTelemetry.Common Associated Types type Rep TagVal :: Type -> Type # Methods from :: TagVal -> Rep TagVal x # to :: Rep TagVal x -> TagVal #
ToJSON TagVal Source #
Instance details Defined in OpenTelemetry.Common Methods toJSON :: TagVal -> Value # toEncoding :: TagVal -> Encoding # toJSONList :: [TagVal] -> Value # toEncodingList :: [TagVal] -> Encoding #
ToTagValue TagVal Source #
Instance details Defined in OpenTelemetry.Common Methods toTagValue :: TagVal -> TagValue Source #
type Rep TagVal Source #
Instance details Defined in OpenTelemetry.Common type Rep TagVal = D1 (MetaData "TagVal" "OpenTelemetry.Common" "opentelemetry-extra-0.6.1-FScfpIqnq1Q3XlqEbIlE01" True) (C1 (MetaCons "TagVal" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype EventName Source #

Constructors

EventName Text

Instances

Eq EventName Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: EventName -> EventName -> Bool # (/=) :: EventName -> EventName -> Bool #
Show EventName Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> EventName -> ShowS # show :: EventName -> String # showList :: [EventName] -> ShowS #
Generic EventName Source #
Instance details Defined in OpenTelemetry.Common Associated Types type Rep EventName :: Type -> Type # Methods from :: EventName -> Rep EventName x # to :: Rep EventName x -> EventName #
type Rep EventName Source #
Instance details Defined in OpenTelemetry.Common type Rep EventName = D1 (MetaData "EventName" "OpenTelemetry.Common" "opentelemetry-extra-0.6.1-FScfpIqnq1Q3XlqEbIlE01" True) (C1 (MetaCons "EventName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype EventVal Source #

Constructors

EventVal Text

Instances

Eq EventVal Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: EventVal -> EventVal -> Bool # (/=) :: EventVal -> EventVal -> Bool #
Show EventVal Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> EventVal -> ShowS # show :: EventVal -> String # showList :: [EventVal] -> ShowS #
Generic EventVal Source #
Instance details Defined in OpenTelemetry.Common Associated Types type Rep EventVal :: Type -> Type # Methods from :: EventVal -> Rep EventVal x # to :: Rep EventVal x -> EventVal #
ToJSON EventVal Source #
Instance details Defined in OpenTelemetry.Common Methods toJSON :: EventVal -> Value # toEncoding :: EventVal -> Encoding # toJSONList :: [EventVal] -> Value # toEncodingList :: [EventVal] -> Encoding #
type Rep EventVal Source #
Instance details Defined in OpenTelemetry.Common type Rep EventVal = D1 (MetaData "EventVal" "OpenTelemetry.Common" "opentelemetry-extra-0.6.1-FScfpIqnq1Q3XlqEbIlE01" True) (C1 (MetaCons "EventVal" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data TagValue Source #

Constructors

StringTagValue !TagVal
BoolTagValue !Bool
IntTagValue !Int
DoubleTagValue !Double

Instances

Eq TagValue Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: TagValue -> TagValue -> Bool # (/=) :: TagValue -> TagValue -> Bool #
Show TagValue Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> TagValue -> ShowS # show :: TagValue -> String # showList :: [TagValue] -> ShowS #

class ToTagValue a where Source #

Methods

toTagValue :: a -> TagValue Source #

Instances

ToTagValue Bool Source #
Instance details Defined in OpenTelemetry.Common Methods toTagValue :: Bool -> TagValue Source #
ToTagValue Int Source #
Instance details Defined in OpenTelemetry.Common Methods toTagValue :: Int -> TagValue Source #
ToTagValue Text Source #
Instance details Defined in OpenTelemetry.Common Methods toTagValue :: Text -> TagValue Source #
ToTagValue String Source #
Instance details Defined in OpenTelemetry.Common Methods toTagValue :: String -> TagValue Source #
ToTagValue TagVal Source #
Instance details Defined in OpenTelemetry.Common Methods toTagValue :: TagVal -> TagValue Source #

data Span Source #

Constructors

Span
Fields spanContext :: !SpanContext spanOperation :: Text spanThreadId :: Word32 spanStartedAt :: !Timestamp spanFinishedAt :: !Timestamp spanTags :: !(HashMap TagName TagValue) spanEvents :: [SpanEvent] spanStatus :: !SpanStatus spanParentId :: Maybe SpanId spanNanosecondsSpentInGC :: !Word64

Instances

Eq Span Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: Span -> Span -> Bool # (/=) :: Span -> Span -> Bool #
Show Span Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> Span -> ShowS # show :: Span -> String # showList :: [Span] -> ShowS #

data InstrumentType Source #

Reflects the constructors of Instrument

Constructors

CounterType
UpDownCounterType
ValueRecorderType
SumObserverType
UpDownSumObserverType
ValueObserverType

Instances

Enum InstrumentType Source #
Instance details Defined in OpenTelemetry.Common Methods succ :: InstrumentType -> InstrumentType # pred :: InstrumentType -> InstrumentType # toEnum :: Int -> InstrumentType # fromEnum :: InstrumentType -> Int # enumFrom :: InstrumentType -> [InstrumentType] # enumFromThen :: InstrumentType -> InstrumentType -> [InstrumentType] # enumFromTo :: InstrumentType -> InstrumentType -> [InstrumentType] # enumFromThenTo :: InstrumentType -> InstrumentType -> InstrumentType -> [InstrumentType] #
Eq InstrumentType Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: InstrumentType -> InstrumentType -> Bool # (/=) :: InstrumentType -> InstrumentType -> Bool #
Show InstrumentType Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> InstrumentType -> ShowS # show :: InstrumentType -> String # showList :: [InstrumentType] -> ShowS #
Generic InstrumentType Source #
Instance details Defined in OpenTelemetry.Common Associated Types type Rep InstrumentType :: Type -> Type # Methods from :: InstrumentType -> Rep InstrumentType x # to :: Rep InstrumentType x -> InstrumentType #
Hashable InstrumentType Source #
Instance details Defined in OpenTelemetry.Common Methods hashWithSalt :: Int -> InstrumentType -> Int # hash :: InstrumentType -> Int #
type Rep InstrumentType Source #
Instance details Defined in OpenTelemetry.Common type Rep InstrumentType = D1 (MetaData "InstrumentType" "OpenTelemetry.Common" "opentelemetry-extra-0.6.1-FScfpIqnq1Q3XlqEbIlE01" False) ((C1 (MetaCons "CounterType" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "UpDownCounterType" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ValueRecorderType" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "SumObserverType" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "UpDownSumObserverType" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ValueObserverType" PrefixI False) (U1 :: Type -> Type))))

data CaptureInstrument Source #

Constructors

CaptureInstrument
Fields instrumentType :: !InstrumentType instrumentName :: !ByteString

Instances

Eq CaptureInstrument Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: CaptureInstrument -> CaptureInstrument -> Bool # (/=) :: CaptureInstrument -> CaptureInstrument -> Bool #
Show CaptureInstrument Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> CaptureInstrument -> ShowS # show :: CaptureInstrument -> String # showList :: [CaptureInstrument] -> ShowS #
Generic CaptureInstrument Source #
Instance details Defined in OpenTelemetry.Common Associated Types type Rep CaptureInstrument :: Type -> Type # Methods from :: CaptureInstrument -> Rep CaptureInstrument x # to :: Rep CaptureInstrument x -> CaptureInstrument #
Hashable CaptureInstrument Source #
Instance details Defined in OpenTelemetry.Common Methods hashWithSalt :: Int -> CaptureInstrument -> Int # hash :: CaptureInstrument -> Int #
type Rep CaptureInstrument Source #
Instance details Defined in OpenTelemetry.Common type Rep CaptureInstrument = D1 (MetaData "CaptureInstrument" "OpenTelemetry.Common" "opentelemetry-extra-0.6.1-FScfpIqnq1Q3XlqEbIlE01" False) (C1 (MetaCons "CaptureInstrument" PrefixI True) (S1 (MetaSel (Just "instrumentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InstrumentType) :*: S1 (MetaSel (Just "instrumentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ByteString)))

data Metric Source #

Based on https://github.com/open-telemetry/opentelemetry-proto/blob/1a931b4b57c34e7fd8f7dddcaa9b7587840e9c08/opentelemetry/proto/metrics/v1/metrics.proto#L96-L107

Constructors

Metric
Fields instrument :: !CaptureInstrument datapoints :: ![MetricDatapoint Int]

Instances

Eq Metric Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: Metric -> Metric -> Bool # (/=) :: Metric -> Metric -> Bool #
Show Metric Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> Metric -> ShowS # show :: Metric -> String # showList :: [Metric] -> ShowS #

data AggregatedMetric Source #

Constructors

AggregatedMetric
Fields instrument :: !CaptureInstrument datapoint :: !(MetricDatapoint Int)

Instances

Eq AggregatedMetric Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: AggregatedMetric -> AggregatedMetric -> Bool # (/=) :: AggregatedMetric -> AggregatedMetric -> Bool #
Show AggregatedMetric Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> AggregatedMetric -> ShowS # show :: AggregatedMetric -> String # showList :: [AggregatedMetric] -> ShowS #

data MetricDatapoint a Source #

Constructors

MetricDatapoint
Fields timestamp :: !Timestamp value :: !a

Instances

Functor MetricDatapoint Source #
Instance details Defined in OpenTelemetry.Common Methods fmap :: (a -> b) -> MetricDatapoint a -> MetricDatapoint b # (<$) :: a -> MetricDatapoint b -> MetricDatapoint a #
Eq a => Eq (MetricDatapoint a) Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: MetricDatapoint a -> MetricDatapoint a -> Bool # (/=) :: MetricDatapoint a -> MetricDatapoint a -> Bool #
Show a => Show (MetricDatapoint a) Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> MetricDatapoint a -> ShowS # show :: MetricDatapoint a -> String # showList :: [MetricDatapoint a] -> ShowS #

spanTraceId :: Span -> TraceId Source #

spanId :: Span -> SpanId Source #

data SpanEvent Source #

Constructors

SpanEvent
Fields spanEventTimestamp :: !Timestamp spanEventKey :: !EventName spanEventValue :: !EventVal

Instances

Eq SpanEvent Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: SpanEvent -> SpanEvent -> Bool # (/=) :: SpanEvent -> SpanEvent -> Bool #
Show SpanEvent Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> SpanEvent -> ShowS # show :: SpanEvent -> String # showList :: [SpanEvent] -> ShowS #

data SpanStatus Source #

Constructors

OK

Instances

Eq SpanStatus Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: SpanStatus -> SpanStatus -> Bool # (/=) :: SpanStatus -> SpanStatus -> Bool #
Show SpanStatus Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> SpanStatus -> ShowS # show :: SpanStatus -> String # showList :: [SpanStatus] -> ShowS #

data Event Source #

Constructors

Event Text Timestamp

Instances

Eq Event Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Show Event Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #

data SpanProcessor Source #

Constructors

SpanProcessor
Fields onStart :: Span -> IO () onEnd :: Span -> IO ()

data OpenTelemetryConfig Source #

Constructors

OpenTelemetryConfig
Fields otcSpanExporter :: Exporter Span

data ExportResult Source #

Constructors

ExportSuccess
ExportFailedRetryable
ExportFailedNotRetryable

Instances

Eq ExportResult Source #
Instance details Defined in OpenTelemetry.Common Methods (==) :: ExportResult -> ExportResult -> Bool # (/=) :: ExportResult -> ExportResult -> Bool #
Show ExportResult Source #
Instance details Defined in OpenTelemetry.Common Methods showsPrec :: Int -> ExportResult -> ShowS # show :: ExportResult -> String # showList :: [ExportResult] -> ShowS #

data Exporter thing Source #

Constructors

Exporter
Fields export :: [thing] -> IO ExportResult shutdown :: IO ()

readInstrumentTag :: Int8 -> Maybe InstrumentType Source #

additive :: InstrumentType -> Bool Source #

noopExporter :: Exporter whatever Source #

aggregated :: Exporter AggregatedMetric -> IO (Exporter Metric) Source #

now64 :: IO Timestamp Source #