OpenTelemetry Java 1.49.0 · io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator

Field Summary

Modifier and Type	Field and Description
private static final List<String>	FIELDS
private static final W3CTraceContextPropagator	INSTANCE
private static final Logger	logger
private static final int	SPAN_ID_HEX_SIZE
private static final int	SPAN_ID_OFFSET
private static final int	TRACE_ID_HEX_SIZE
private static final int	TRACE_ID_OFFSET
private static final int	TRACE_OPTION_HEX_SIZE
private static final int	TRACE_OPTION_OFFSET
pack-priv static final String	TRACE_PARENT
pack-priv static final String	TRACE_STATE
private static final char	TRACEPARENT_DELIMITER
private static final int	TRACEPARENT_DELIMITER_SIZE
private static final int	TRACEPARENT_HEADER_SIZE
private static final Set<String>	VALID_VERSIONS
private static final String	VERSION
private static final String	VERSION_00
private static final int	VERSION_SIZE

Constructor Summary

Access	Constructor and Description
private	W3CTraceContextPropagator()

Method Summary

Modifier and Type	Method and Description
public <C> Context	extract(Context the `Context` used to store the extracted value. context, C holds propagation fields. For example, an outgoing message or http request. carrier, TextMapGetter<C> invoked for each propagation key to get data from the carrier. getter) Implements io.opentelemetry.context.propagation.TextMapPropagator.extract. Extracts data from upstream.
private static SpanContext	extractContextFromTraceParent(String traceparent)
private static <C> SpanContext	extractImpl(C carrier, TextMapGetter<C> getter)
public Collection<String>	fields() Implements io.opentelemetry.context.propagation.TextMapPropagator.fields. The propagation fields defined.
public static W3CTraceContextPropagator	getInstance() Returns a singleton instance of a `TextMapPropagator` implementing the W3C TraceContext propagation.
public <C> void	inject(Context the `Context` containing the value to be injected. context, C holds propagation fields. For example, an outgoing message or http request. carrier, TextMapSetter<C> invoked for each propagation key to add or remove. setter) Implements io.opentelemetry.context.propagation.TextMapPropagator.inject. Injects data for downstream consumers, for example as HTTP headers.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

FIELDS	back to summary
private static final List<String> FIELDS

INSTANCE	back to summary
private static final W3CTraceContextPropagator INSTANCE

logger	back to summary
private static final Logger logger

SPAN_ID_HEX_SIZE	back to summary
private static final int SPAN_ID_HEX_SIZE

SPAN_ID_OFFSET	back to summary
private static final int SPAN_ID_OFFSET

TRACE_ID_HEX_SIZE	back to summary
private static final int TRACE_ID_HEX_SIZE

TRACE_ID_OFFSET	back to summary
private static final int TRACE_ID_OFFSET

TRACE_OPTION_HEX_SIZE	back to summary
private static final int TRACE_OPTION_HEX_SIZE

TRACE_OPTION_OFFSET	back to summary
private static final int TRACE_OPTION_OFFSET

TRACE_PARENT	back to summary
pack-priv static final String TRACE_PARENT

TRACE_STATE	back to summary
pack-priv static final String TRACE_STATE

TRACEPARENT_DELIMITER	back to summary
private static final char TRACEPARENT_DELIMITER

TRACEPARENT_DELIMITER_SIZE	back to summary
private static final int TRACEPARENT_DELIMITER_SIZE

TRACEPARENT_HEADER_SIZE	back to summary
private static final int TRACEPARENT_HEADER_SIZE

VALID_VERSIONS	back to summary
private static final Set<String> VALID_VERSIONS

VERSION	back to summary
private static final String VERSION

VERSION_00	back to summary
private static final String VERSION_00

VERSION_SIZE	back to summary
private static final int VERSION_SIZE

Constructor Detail

W3CTraceContextPropagator	back to summary
private W3CTraceContextPropagator()

Method Detail

extract back to summary

extract	back to summary
public <C> Context extract(Context context, C carrier, TextMapGetter<C> getter) Implements io.opentelemetry.context.propagation.TextMapPropagator.extract. Doc from io.opentelemetry.context.propagation.TextMapPropagator.extract. Extracts data from upstream. For example, from incoming http headers. The returned Context should contain the extracted data, if any, merged with the data from the passed-in Context. If the incoming information could not be parsed, implementations MUST return the original Context, unaltered. Parameters <C> the type of carrier of the propagation fields, such as an http request. context:Context the `Context` used to store the extracted value. carrier:C holds propagation fields. For example, an outgoing message or http request. getter:TextMapGetter<C> invoked for each propagation key to get data from the carrier. Returns:Context the `Context` containing the extracted data. Annotations @Override

public <C> Context extract(Context context, C carrier, TextMapGetter<C> getter)

Implements io.opentelemetry.context.propagation.TextMapPropagator.extract.

Doc from io.opentelemetry.context.propagation.TextMapPropagator.extract.

Extracts data from upstream. For example, from incoming http headers. The returned Context should contain the extracted data, if any, merged with the data from the passed-in Context.

If the incoming information could not be parsed, implementations MUST return the original Context, unaltered.

Parameters

<C>: the type of carrier of the propagation fields, such as an http request.
context:Context: the Context used to store the extracted value.
carrier:C: holds propagation fields. For example, an outgoing message or http request.
getter:TextMapGetter<C>: invoked for each propagation key to get data from the carrier.

Returns:Context

the Context containing the extracted data.

Annotations

@Override

extractContextFromTraceParent	back to summary
private static SpanContext extractContextFromTraceParent(String traceparent)

extractImpl	back to summary
private static <C> SpanContext extractImpl(C carrier, TextMapGetter<C> getter)

fields back to summary

fields	back to summary
public Collection<String> fields() Implements io.opentelemetry.context.propagation.TextMapPropagator.fields. Doc from io.opentelemetry.context.propagation.TextMapPropagator.fields. The propagation fields defined. If your carrier is reused, you should delete the fields here before calling `inject(Context, Object, TextMapSetter)` )}. For example, if the carrier is a single-use or immutable request object, you don't need to clear fields as they couldn't have been set before. If it is a mutable, retryable object, successive calls should clear these fields first. Some use cases for this are: Allow pre-allocation of fields, especially in systems like gRPC Metadata Allow a single-pass over an iterator Returns:Collection<String> the fields that will be used by this formatter. Annotations @Override

public Collection<String> fields()

Implements io.opentelemetry.context.propagation.TextMapPropagator.fields.

Doc from io.opentelemetry.context.propagation.TextMapPropagator.fields.

The propagation fields defined. If your carrier is reused, you should delete the fields here before calling inject(Context, Object, TextMapSetter) )}.

For example, if the carrier is a single-use or immutable request object, you don't need to clear fields as they couldn't have been set before. If it is a mutable, retryable object, successive calls should clear these fields first.

Some use cases for this are:

Allow pre-allocation of fields, especially in systems like gRPC Metadata
Allow a single-pass over an iterator

Returns:Collection<String>

the fields that will be used by this formatter.

Annotations

@Override

getInstance	back to summary
public static W3CTraceContextPropagator getInstance() Returns a singleton instance of a `TextMapPropagator` implementing the W3C TraceContext propagation.

inject back to summary

inject	back to summary
public <C> void inject(Context context, C carrier, TextMapSetter<C> setter) Implements io.opentelemetry.context.propagation.TextMapPropagator.inject. Doc from io.opentelemetry.context.propagation.TextMapPropagator.inject. Injects data for downstream consumers, for example as HTTP headers. The carrier may be null to facilitate calling this method with a lambda for the `TextMapSetter`, in which case that null will be passed to the `TextMapSetter` implementation. Parameters <C> carrier of propagation fields, such as an http request context:Context the `Context` containing the value to be injected. carrier:C holds propagation fields. For example, an outgoing message or http request. setter:TextMapSetter<C> invoked for each propagation key to add or remove. Annotations @Override

public <C> void inject(Context context, C carrier, TextMapSetter<C> setter)

Implements io.opentelemetry.context.propagation.TextMapPropagator.inject.

Doc from io.opentelemetry.context.propagation.TextMapPropagator.inject.

Injects data for downstream consumers, for example as HTTP headers. The carrier may be null to facilitate calling this method with a lambda for the TextMapSetter, in which case that null will be passed to the TextMapSetter implementation.

Parameters

<C>: carrier of propagation fields, such as an http request
context:Context: the Context containing the value to be injected.
carrier:C: holds propagation fields. For example, an outgoing message or http request.
setter:TextMapSetter<C>: invoked for each propagation key to add or remove.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public final Class W3CTraceContextPropagator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail