io.opencensus.trace.propagation

Class PropagationComponent

java.lang.Object

io.opencensus.trace.propagation.PropagationComponent

public abstract class PropagationComponent
extends Object

Container class for all the supported propagation formats. Currently supports only Binary format (see BinaryFormat) and B3 Text format (see TextFormat) but more formats will be added.

Since:

0.5

Constructor Summary

Constructors

Constructor and Description
PropagationComponent()

Method Summary

Modifier and Type	Method and Description
abstract TextFormat	getB3Format() Returns the B3 TextFormat with the provided implementations.
abstract BinaryFormat	getBinaryFormat() Returns the BinaryFormat with the provided implementations.
static PropagationComponent	getNoopPropagationComponent() Returns an instance that contains no-op implementations for all the instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropagationComponent

public PropagationComponent()

Method Detail

getBinaryFormat

public abstract BinaryFormat getBinaryFormat()

Returns the BinaryFormat with the provided implementations. If no implementation is provided then no-op implementation will be used.

Returns:

the BinaryFormat implementation.

Since:

0.5

getB3Format

@ExperimentalApi
public abstract TextFormat getB3Format()

Returns the B3 TextFormat with the provided implementations. See b3-propagation for more information. If no implementation is provided then no-op implementation will be used.

Returns:

the B3 TextFormat implementation for B3.

Since:

0.11.0

getNoopPropagationComponent

public static PropagationComponent getNoopPropagationComponent()

Returns an instance that contains no-op implementations for all the instances.

Returns:

an instance that contains no-op implementations for all the instances.

Since:

0.5