org.typelevel.otel4s.context.propagation

Members list

Type members

Classlikes

sealed trait ContextPropagators[Ctx]

A container of the registered propagators for every supported format.

A container of the registered propagators for every supported format.

Type parameters

Ctx

the type of the Context

Attributes

Companion
object
Source
ContextPropagators.scala
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion
trait
Source
ContextPropagators.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class PassThroughPropagator[Ctx, K <: (Key)] extends TextMapPropagator[Ctx]

A TextMapPropagator that extracts a specified collection of fields and stores them in a context, and extracts them from a context later for injection.

A TextMapPropagator that extracts a specified collection of fields and stores them in a context, and extracts them from a context later for injection. It does not interact with telemetry.

Attributes

Companion
object
Source
PassThroughPropagator.scala
Supertypes
trait TextMapPropagator[Ctx]
class Object
trait Matchable
class Any

Attributes

Companion
class
Source
PassThroughPropagator.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait TextMapGetter[A]

Offers a way to get a string value associated with a given key.

Offers a way to get a string value associated with a given key.

A type class can be implemented for any data structure that stores key-value pairs.

Implicit instances of TextMapGetter are provided for scala.collection.Map and scala.collection.Seq types. The behavior of TextMapGetter[Seq[(String, String)]] when duplicate keys are present is unspecified, and may change at any time. In particular, if the behavior of Seq types with duplicate keys is ever specified by open telemetry, the behavior of such implicit instances will be made to match the specification.

Type parameters

A

the type of the key-value carrier

Attributes

See also

See TextMapUpdater to update values of an immutable carrier

Companion
object
Source
TextMapGetter.scala
Supertypes
class Object
trait Matchable
class Any
object TextMapGetter

Attributes

Companion
trait
Source
TextMapGetter.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait TextMapPropagator[Ctx]

The process of propagating data across process boundaries involves injecting and extracting values in the form of text into carriers that travel in-band.

The process of propagating data across process boundaries involves injecting and extracting values in the form of text into carriers that travel in-band.

The encoding used for this process is expected to conform to HTTP Header Field semantics, and values are commonly encoded as request headers for RPC/HTTP requests.

The carriers used for propagating the data are typically HTTP requests, and the process is often implemented using library-specific request interceptors. On the client side, values are injected into the carriers, while on the server side, values are extracted from them.

Type parameters

Ctx

the context to use to extract or inject data

Attributes

Companion
object
Source
TextMapPropagator.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class PassThroughPropagator[Ctx, K]

Attributes

Companion
trait
Source
TextMapPropagator.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait TextMapUpdater[A]

Offers a way to store a string value associated with a given key to an immutable carrier type.

Offers a way to store a string value associated with a given key to an immutable carrier type.

Implicit instances of TextMapUpdater are provided for scala.collection.immutable.Map and scala.collection.immutable.Seq types.The behavior of TextMapUpdater[Seq[(String, String)]] when duplicate keys are present is unspecified, and may change at any time. In particular, if the behavior of Seq types with duplicate keys is ever specified by open telemetry, the behavior of such implicit instances will be made to match the specification.

Type parameters

A

the type of the carrier

Attributes

See also

See TextMapGetter to get a value from the carrier

Companion
object
Source
TextMapUpdater.scala
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion
trait
Source
TextMapUpdater.scala
Supertypes
class Object
trait Matchable
class Any
Self type