OpenTelemetry.Trace.Id

Trace and Span Id generation

No Aeson instances are provided since they've got the potential to be transport-specific in format. Use newtypes for serialisation instead.

Working with TraceIds

data TraceId

A valid trace identifier is a 16-byte array with at least one non-zero byte.

Instances

Eq TraceId

Defined in OpenTelemetry.Trace.Id

Methods

(==) :: TraceId -> TraceId -> Bool

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

Ord TraceId

Defined in OpenTelemetry.Trace.Id

Methods

compare :: TraceId -> TraceId -> Ordering

(<) :: TraceId -> TraceId -> Bool

(<=) :: TraceId -> TraceId -> Bool

(>) :: TraceId -> TraceId -> Bool

(>=) :: TraceId -> TraceId -> Bool

max :: TraceId -> TraceId -> TraceId

min :: TraceId -> TraceId -> TraceId

Show TraceId

Defined in OpenTelemetry.Trace.Id

Methods

showsPrec :: Int -> TraceId -> ShowS

show :: TraceId -> String

showList :: [TraceId] -> ShowS

IsString TraceId

Defined in OpenTelemetry.Trace.Id

Methods

fromString :: String -> TraceId

Hashable TraceId

Defined in OpenTelemetry.Trace.Id

Methods

hashWithSalt :: Int -> TraceId -> Int

hash :: TraceId -> Int

Creating TraceIds

newTraceId :: MonadIO m => IdGenerator -> m TraceId

Generate a TraceId using the provided IdGenerator

This function is generally called by the hs-opentelemetry-sdk, but may be useful in some testing situations.

Since: 0.1.0.0

Checking TraceIds for validity

isEmptyTraceId :: TraceId -> Bool

Check whether all bytes in the TraceId are zero.

Since: 0.1.0.0

Encoding / decoding TraceId from bytes

traceIdBytes :: TraceId -> ByteString

Access the byte-level representation of the provided TraceId

Since: 0.1.0.0

bytesToTraceId :: ByteString -> Either String TraceId

Convert a ByteString to a TraceId. Will fail if the ByteString is not exactly 16 bytes long.

Since: 0.1.0.0

Encoding / decoding TraceId from a given Base encoding

baseEncodedToTraceId :: Base -> ByteString -> Either String TraceId

Convert a ByteString of a specified base-encoding into a TraceId. Will fail if the decoded value is not exactly 16 bytes long.

Since: 0.1.0.0

traceIdBaseEncodedBuilder :: Base -> TraceId -> Builder

Output a TraceId into a base-encoded bytestring Builder.

Since: 0.1.0.0

traceIdBaseEncodedByteString :: Base -> TraceId -> ByteString

Output a TraceId into a base-encoded ByteString.

Since: 0.1.0.0

traceIdBaseEncodedText :: Base -> TraceId -> Text

Output a TraceId into a base-encoded Text.

Since: 0.1.0.0

Working with SpanIds

data SpanId

A valid span identifier is an 8-byte array with at least one non-zero byte.

Instances

Eq SpanId

Defined in OpenTelemetry.Trace.Id

Methods

(==) :: SpanId -> SpanId -> Bool

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

Ord SpanId

Defined in OpenTelemetry.Trace.Id

Methods

compare :: SpanId -> SpanId -> Ordering

(<) :: SpanId -> SpanId -> Bool

(<=) :: SpanId -> SpanId -> Bool

(>) :: SpanId -> SpanId -> Bool

(>=) :: SpanId -> SpanId -> Bool

max :: SpanId -> SpanId -> SpanId

min :: SpanId -> SpanId -> SpanId

Show SpanId

Defined in OpenTelemetry.Trace.Id

Methods

showsPrec :: Int -> SpanId -> ShowS

show :: SpanId -> String

showList :: [SpanId] -> ShowS

IsString SpanId

Defined in OpenTelemetry.Trace.Id

Methods

fromString :: String -> SpanId

Hashable SpanId

Defined in OpenTelemetry.Trace.Id

Methods

hashWithSalt :: Int -> SpanId -> Int

hash :: SpanId -> Int

Creating SpanIds

newSpanId :: MonadIO m => IdGenerator -> m SpanId

Generate a SpanId using the provided IdGenerator

This function is generally called by the hs-opentelemetry-sdk, but may be useful in some testing situations.

Since: 0.1.0.0

Checking SpanIds for validity

isEmptySpanId :: SpanId -> Bool

Check whether all bytes in the SpanId are zero.

Since: 0.1.0.0

Encoding / decoding SpanId from bytes

spanIdBytes :: SpanId -> ByteString

Access the byte-level representation of the provided SpanId

Since: 0.1.0.0

bytesToSpanId :: ByteString -> Either String SpanId

Convert a ByteString of a specified base-encoding into a SpanId. Will fail if the decoded value is not exactly 8 bytes long.

Since: 0.1.0.0

Encoding / decoding SpanId from a given Base encoding

data Base

The different bases that can be used.

See RFC4648 for details. In particular, Base64 can be standard or URL-safe. URL-safe encoding is often used in other specifications without padding characters.

RFC 2045 defines a separate Base64 encoding, which is not supported. This format requires a newline at least every 76 encoded characters, which works around limitations of older email programs that could not handle long lines. Be aware that other languages, such as Ruby, encode the RFC 2045 version by default. To decode their ouput, remove all newlines before decoding.

Examples

A quick example to show the differences:

>>> let input = "Is 3 > 2?" :: ByteString
>>> let convertedTo base = convertToBase base input :: ByteString
>>> convertedTo Base16
"49732033203e20323f"
>>> convertedTo Base32
"JFZSAMZAHYQDEPY="
>>> convertedTo Base64
"SXMgMyA+IDI/"
>>> convertedTo Base64URLUnpadded
"SXMgMyA-IDI_"
>>> convertedTo Base64OpenBSD
"QVKeKw.8GBG9"

Constructors

Base16

similar to hexadecimal

Base32

Base64

standard Base64

Base64URLUnpadded

unpadded URL-safe Base64

Base64OpenBSD

Base64 as used in OpenBSD password encoding (such as bcrypt)

Instances

Eq Base

Defined in Data.ByteArray.Encoding

Methods

(==) :: Base -> Base -> Bool

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

Show Base

Defined in Data.ByteArray.Encoding

Methods

showsPrec :: Int -> Base -> ShowS

show :: Base -> String

showList :: [Base] -> ShowS

baseEncodedToSpanId :: Base -> ByteString -> Either String SpanId

Convert a ByteString of a specified base-encoding into a SpanId. Will fail if the decoded value is not exactly 8 bytes long.

Since: 0.1.0.0

spanIdBaseEncodedBuilder :: Base -> SpanId -> Builder

Output a SpanId into a base-encoded bytestring Builder.

Since: 0.1.0.0

spanIdBaseEncodedByteString :: Base -> SpanId -> ByteString

Output a SpanId into a base-encoded ByteString.

Since: 0.1.0.0

spanIdBaseEncodedText :: Base -> SpanId -> Text

Output a SpanId into a base-encoded Text.

Since: 0.1.0.0