Trace Correlation Context

Trace correlation context APIs provide a way to put custom data in tracing context. All the data in the context will be propagated with the in-wire process automatically.

• Use TraceContext.putCorrelation() API to put custom data in tracing context.

Optional<String> previous = TraceContext.putCorrelation("customKey", "customValue");

CorrelationContext will remove the item when the value is null or empty.

• Use TraceContext.getCorrelation() API to get custom data.

Optional<String> value = TraceContext.getCorrelation("customKey");

CorrelationContext configuration descriptions could be found in the agent configuration documentation, with correlation. as the prefix. Sample codes only