io.opentelemetry.correlationcontext

Interface CorrelationContext

All Known Implementing Classes:

EmptyCorrelationContext

@Immutable
public interface CorrelationContext

A map from EntryKey to EntryValue and EntryMetadata that can be used to label anything that is associated with a specific operation.

For example, CorrelationContexts can be used to label stats, log messages, or debugging information.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CorrelationContext.Builder Builder for the CorrelationContext class.

Method Summary

Modifier and Type	Method and Description
Collection<Entry>	getEntries() Returns an immutable collection of the entries in this CorrelationContext.
EntryValue	getEntryValue(EntryKey entryKey) Returns the EntryValue associated with the given EntryKey.

Method Detail

getEntries

Collection<Entry> getEntries()

Returns an immutable collection of the entries in this CorrelationContext. Order of entries is not guaranteed.

Returns:

an immutable collection of the entries in this CorrelationContext.

Since:

0.1.0

getEntryValue

@Nullable
EntryValue getEntryValue(EntryKey entryKey)

Returns the EntryValue associated with the given EntryKey.

Parameters:

entryKey - entry key to return the value for.

Returns:

the EntryValue associated with the given EntryKey, or null if no Entry with the given entryKey is in this CorrelationContext.