Package org.atmosphere.metrics

Class AtmosphereTracing

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.metrics.AtmosphereTracing

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class AtmosphereTracing
extends AtmosphereInterceptorAdapter

OpenTelemetry tracing interceptor for Atmosphere requests.

Creates a trace span for each incoming request covering the full lifecycle from inspect through to disconnect. Requires io.opentelemetry:opentelemetry-api on the classpath (optional dependency).

Usage

 OpenTelemetry otel = GlobalOpenTelemetry.get(); // or your configured instance
 framework.interceptor(new AtmosphereTracing(otel));
 

Span attributes

• atmosphere.resource.uuid — the resource UUID
• atmosphere.transport — transport type (WEBSOCKET, SSE, etc.)
• atmosphere.action — the action result (CONTINUE, SUSPEND, etc.)
• atmosphere.broadcaster — the broadcaster ID
• atmosphere.disconnect.reason — reason for disconnect (if applicable)

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.interceptor.InvokationOrder

InvokationOrder.PRIORITY

Field Summary

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
AtmosphereTracing(io.opentelemetry.api.OpenTelemetry openTelemetry)	Create tracing interceptor with the given OpenTelemetry instance.
AtmosphereTracing(io.opentelemetry.api.trace.Tracer tracer)	Create tracing interceptor with a custom tracer.

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
void	postInspect(AtmosphereResource r)	Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.
io.opentelemetry.api.trace.Span	startRoomSpan(String operation, String roomName, String uuid)	Create a span for a room operation (join, leave, broadcast).
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, priority

Methods inherited from class java.lang.Object

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

Constructor Details

AtmosphereTracing

public AtmosphereTracing(io.opentelemetry.api.OpenTelemetry openTelemetry)

Create tracing interceptor with the given OpenTelemetry instance.

Parameters:

openTelemetry - the OpenTelemetry instance

AtmosphereTracing

public AtmosphereTracing(io.opentelemetry.api.trace.Tracer tracer)

Create tracing interceptor with a custom tracer.

Parameters:

tracer - the OpenTelemetry tracer

Method Details

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Overrides:

configure in class AtmosphereInterceptorAdapter

Parameters:

config - AtmosphereConfig

inspect

public Action inspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

inspect in interface AtmosphereInterceptor

Overrides:

inspect in class AtmosphereInterceptorAdapter

Parameters:

r - a AtmosphereResource

Returns:

Action.CONTINUE or Action.SUSPEND to dispatch the AtmosphereResource to other AtmosphereInterceptor or AtmosphereHandler. Return Action.TYPE.CANCELLED to stop the processing.

postInspect

public void postInspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

postInspect in interface AtmosphereInterceptor

Overrides:

postInspect in class AtmosphereInterceptorAdapter

Parameters:

r - a AtmosphereResource

startRoomSpan

public io.opentelemetry.api.trace.Span startRoomSpan(String operation,
 String roomName,
 String uuid)

Create a span for a room operation (join, leave, broadcast).

Parameters:

operation - the operation name (e.g., "join", "leave", "broadcast")

roomName - the room name

uuid - the resource UUID

Returns:

the span (caller must call span.end())

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter