OpenTelemetry.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.

Note: if you are trying to add data annotations specific to a single trace span, you should use addAttribute and addAttributes

Constructing Baggage structures

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

Semigroup Baggage

Defined in OpenTelemetry.Baggage

Methods

(<>) :: Baggage -> Baggage -> Baggage

sconcat :: NonEmpty Baggage -> Baggage

stimes :: Integral b => b -> Baggage -> Baggage

Show Baggage

Defined in OpenTelemetry.Baggage

Methods

showsPrec :: Int -> Baggage -> ShowS

show :: Baggage -> String

showList :: [Baggage] -> ShowS

Eq Baggage

Defined in OpenTelemetry.Baggage

Methods

(==) :: Baggage -> Baggage -> Bool

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

empty :: Baggage

An empty initial baggage value

fromHashMap :: HashMap Token Element -> Baggage

Convert a HashMap into Baggage

values :: Baggage -> HashMap Token Element

Returns the namevalue pairs in the Baggage. The order of namevalue pairs is not significant.

Since: 0.0.1.0

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

Show Token

Defined in OpenTelemetry.Baggage

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

Eq Token

Defined in OpenTelemetry.Baggage

Methods

(==) :: Token -> Token -> Bool

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

Ord Token

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

Defined in OpenTelemetry.Baggage

Methods

hashWithSalt :: Int -> Token -> Int

hash :: Token -> Int

Lift Token

Defined in OpenTelemetry.Baggage

Methods

lift :: Quote m => Token -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Token -> Code m Token

token :: QuasiQuoter

mkToken :: Text -> Maybe Token

tokenValue :: Token -> ByteString

Convert a Token into a ByteString

data Element

An entry into the baggage

Constructors

Element

Fields

• value :: Text
• properties :: [Property]

Instances

Show Element

Defined in OpenTelemetry.Baggage

Methods

showsPrec :: Int -> Element -> ShowS

show :: Element -> String

showList :: [Element] -> ShowS

Eq Element

Defined in OpenTelemetry.Baggage

Methods

(==) :: Element -> Element -> Bool

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

element :: Text -> Element

property :: Token -> Maybe Text -> Property

data InvalidBaggage

Constructors

BaggageTooLong

MemberTooLong

TooManyListMembers

Empty

Modifying Baggage

insert

Arguments

:: Token

The name for which to set the value

-> Element

The value to set. Use element to construct a well-formed element value.

-> Baggage

-> Baggage

delete :: Token -> Baggage -> Baggage

Delete a key/value pair from the baggage.

Encoding and decoding Baggage

encodeBaggageHeader :: Baggage -> ByteString

encodeBaggageHeaderB :: Baggage -> Builder

decodeBaggageHeader :: ByteString -> Either String Baggage

decodeBaggageHeaderP :: Parser Baggage