com.avioconsulting.mule.opentelemetry.api.traces

Interface ComponentEventContext

All Known Implementing Classes:

TraceComponent

public interface ComponentEventContext

Event context associated with the component. Event Context Id is a time-based unique identifier with a UUID and identity hash appended for nested scopes.

Example of event context id - `964c53f0-e73d-11ee-a9a1-ca89f39a1b64_2028655840_1690157502_1540340657` where `964c53f0-e73d-11ee-a9a1-ca89f39a1b64` represents a primary id and each value separated by `_` is an identity hash representing a nested child event.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
default String	contextCopedPath(String path, int prevLevel) Prefixes given path with the event context id trimmed by provided levels.
default int	contextNestingLevel() Number of levels in event context id.
default String	contextScopedLocation() Get component location prefixed with the event context id.
static String	contextScopedLocationFor(String eventContextId, String location)
default String	contextScopedPath(String path) Prefix the given path with event context id
String	getEventContextId()
default String	getEventContextPrimaryId() Gets the primary event context id which is the part before first `_` character.
String	getLocation()
default Optional<String>	prevContextScopedPath(String path)

Method Detail

getEventContextId

String getEventContextId()

getLocation

String getLocation()

getEventContextPrimaryId

default String getEventContextPrimaryId()

Gets the primary event context id which is the part before first `_` character.

Returns:

String

contextNestingLevel

default int contextNestingLevel()

Number of levels in event context id. For example `58660cf1-e735-11ee-bd25-ca89f39a1b64_493033029_784814100_894835844_515059234` will have 5 levels (split by _ ).

Returns:

int

contextScopedPath

default String contextScopedPath(String path)

Prefix the given path with event context id

Parameters:

path - to prefix

Returns:

String

See Also:

getEventContextId()

contextCopedPath

default String contextCopedPath(String path,
                                int prevLevel)

Prefixes given path with the event context id trimmed by provided levels.

For example, given a context event id `58660cf1-e735-11ee-bd25-ca89f39a1b64_493033029_784814100_894835844_515059234` and path `test-location-path`, if prevLevel = 2, the last two identity has scopes `_894835844_515059234` will be dropped and value `58660cf1-e735-11ee-bd25-ca89f39a1b64_493033029_784814100/test-location-path` will be returned.

Parameters:

path - String to prefix event context id

prevLevel - int levels to remove

Returns:

String

prevContextScopedPath

default Optional<String> prevContextScopedPath(String path)

contextScopedLocation

default String contextScopedLocation()

Get component location prefixed with the event context id. This helps to get a request based unique path to a component location.

Returns:

String

contextScopedLocationFor

static String contextScopedLocationFor(String eventContextId,
                                       String location)