Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenTelemetry.AWSXRay.Baggage

Description

Functions for dealing with Baggage

We ported specs about Baggage from the Java Propagator:

https://github.com/open-telemetry/opentelemetry-java-contrib/blob/04a2a481934be614e73e41194107ffdd767bc507/aws-xray-propagator/src/test/java/io/opentelemetry/contrib/awsxray/propagator/AwsXrayPropagatorTest.java#L227-L238

And using the obvious encodeBaggageHeader/decodeBaggageHeader functions fails them. So, we roll our own stuff here.

Synopsis

decode :: [(ByteString, ByteString)] -> Maybe Baggage
encode :: Baggage -> [(ByteString, ByteString)]
data Token
data Element
data Baggage

Documentation

decode :: [(ByteString, ByteString)] -> Maybe Baggage Source #

Only returns Just if the Baggage is not empty

encode :: Baggage -> [(ByteString, ByteString)] Source #

data Token #

A key for a baggage entry, restricted to the set of valid characters specified in the token definition of RFC 2616:

https://www.rfc-editor.org/rfc/rfc2616#section-2.2

Instances

Instances details

Show Token
Instance details Defined in OpenTelemetry.Baggage Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
Eq Token
Instance details Defined in OpenTelemetry.Baggage Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Ord Token
Instance details Defined in OpenTelemetry.Baggage Methods compare :: Token -> Token -> Ordering # (<) :: Token -> Token -> Bool # (<=) :: Token -> Token -> Bool # (>) :: Token -> Token -> Bool # (>=) :: Token -> Token -> Bool # max :: Token -> Token -> Token # min :: Token -> Token -> Token #
Hashable Token
Instance details Defined in OpenTelemetry.Baggage Methods hashWithSalt :: Int -> Token -> Int # hash :: Token -> Int #
Lift Token
Instance details Defined in OpenTelemetry.Baggage Methods lift :: Quote m => Token -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Token -> Code m Token #

data Element #

An entry into the baggage

Instances

Instances details

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

data Baggage #

Baggage is used to annotate telemetry, adding context and information to metrics, traces, and logs. It is a set of name/value pairs describing user-defined properties. Each name in Baggage is associated with exactly one value.

Instances

Instances details

Semigroup Baggage
Instance details Defined in OpenTelemetry.Baggage Methods (<>) :: Baggage -> Baggage -> Baggage # sconcat :: NonEmpty Baggage -> Baggage # stimes :: Integral b => b -> Baggage -> Baggage #
Show Baggage
Instance details Defined in OpenTelemetry.Baggage Methods showsPrec :: Int -> Baggage -> ShowS # show :: Baggage -> String # showList :: [Baggage] -> ShowS #
Eq Baggage
Instance details Defined in OpenTelemetry.Baggage Methods (==) :: Baggage -> Baggage -> Bool # (/=) :: Baggage -> Baggage -> Bool #