Class OpenTelemetryLifecycleObserver

java.lang.Object

com.soklet.otel.OpenTelemetryLifecycleObserver

All Implemented Interfaces:

LifecycleObserver, AutoCloseable

@ThreadSafe
public final class OpenTelemetryLifecycleObserver
extends Object
implements LifecycleObserver, AutoCloseable

OpenTelemetry-backed LifecycleObserver that emits server spans for Soklet lifecycle events.

This type complements OpenTelemetryMetricsCollector: metrics remain low-cardinality aggregate telemetry, while this observer emits per-request and per-stream spans.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenTelemetryLifecycleObserver.Builder

Method Summary

Modifier and Type	Method	Description
static @NonNull OpenTelemetryLifecycleObserver.Builder	builder()
void	close()
void	didCreateMcpSession(@NonNull Request request, @NonNull Class<? extends McpEndpoint> endpointClass, @NonNull String sessionId)
void	didEstablishMcpSseStream(@NonNull McpSseStream stream)
void	didEstablishSseConnection(@NonNull SseConnection sseConnection)
void	didFailToWriteSseComment(@NonNull SseConnection sseConnection, @NonNull SseComment sseComment, @NonNull Duration writeDuration, @NonNull Throwable throwable)
void	didFailToWriteSseEvent(@NonNull SseConnection sseConnection, @NonNull SseEvent sseEvent, @NonNull Duration writeDuration, @NonNull Throwable throwable)
void	didFinishMcpRequestHandling(@NonNull Request request, @NonNull Class<? extends McpEndpoint> endpointClass, @Nullable String sessionId, @NonNull String jsonRpcMethod, @Nullable McpJsonRpcRequestId jsonRpcRequestId, @NonNull McpRequestOutcome requestOutcome, @Nullable McpJsonRpcError jsonRpcError, @NonNull Duration duration, @NonNull List<@NonNull Throwable> throwables)
void	didFinishRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration duration, @NonNull List<@NonNull Throwable> throwables)
void	didStartMcpRequestHandling(@NonNull Request request, @NonNull Class<? extends McpEndpoint> endpointClass, @Nullable String sessionId, @NonNull String jsonRpcMethod, @Nullable McpJsonRpcRequestId jsonRpcRequestId)
void	didStartRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod)
void	didTerminateMcpSseStream(@NonNull McpSseStream stream, @NonNull StreamTermination termination)
void	didTerminateResponseStream(@NonNull StreamingResponseHandle streamingResponse, @NonNull StreamTermination termination)
void	didTerminateSseConnection(@NonNull SseConnection sseConnection, @NonNull StreamTermination termination)
void	didWriteSseComment(@NonNull SseConnection sseConnection, @NonNull SseComment sseComment, @NonNull Duration writeDuration)
void	didWriteSseEvent(@NonNull SseConnection sseConnection, @NonNull SseEvent sseEvent, @NonNull Duration writeDuration)
static @NonNull OpenTelemetryLifecycleObserver	fromOpenTelemetry(@NonNull OpenTelemetry openTelemetry)
static @NonNull OpenTelemetryLifecycleObserver	fromTracer(@NonNull Tracer tracer)
@NonNull Integer	getActiveSpanCount()
static @NonNull OpenTelemetryLifecycleObserver.Builder	withOpenTelemetry(@NonNull OpenTelemetry openTelemetry)
static @NonNull OpenTelemetryLifecycleObserver.Builder	withTracer(@NonNull Tracer tracer)

Methods inherited from class Object

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

Methods inherited from interface LifecycleObserver

didAcceptConnection, didAcceptRequest, didFailToAcceptConnection, didFailToAcceptRequest, didFailToEstablishSseConnection, didFailToReadRequest, didFailToStartHttpServer, didFailToStartMcpServer, didFailToStartSoklet, didFailToStartSseServer, didFailToStopHttpServer, didFailToStopMcpServer, didFailToStopSoklet, didFailToStopSseServer, didFailToWriteResponse, didReadRequest, didReceiveLogEvent, didStartHttpServer, didStartMcpServer, didStartSoklet, didStartSseServer, didStopHttpServer, didStopMcpServer, didStopSoklet, didStopSseServer, didTerminateMcpSession, didWriteResponse, willAcceptConnection, willAcceptRequest, willEstablishSseConnection, willReadRequest, willStartHttpServer, willStartMcpServer, willStartSoklet, willStartSseServer, willStopHttpServer, willStopMcpServer, willStopSoklet, willStopSseServer, willTerminateMcpSseStream, willTerminateResponseStream, willTerminateSseConnection, willWriteResponse, willWriteSseComment, willWriteSseEvent

Method Details

builder

public static @NonNull OpenTelemetryLifecycleObserver.Builder builder()

withOpenTelemetry

public static @NonNull OpenTelemetryLifecycleObserver.Builder withOpenTelemetry(@NonNull OpenTelemetry openTelemetry)

withTracer

public static @NonNull OpenTelemetryLifecycleObserver.Builder withTracer(@NonNull Tracer tracer)

fromOpenTelemetry

public static @NonNull OpenTelemetryLifecycleObserver fromOpenTelemetry(@NonNull OpenTelemetry openTelemetry)

fromTracer

public static @NonNull OpenTelemetryLifecycleObserver fromTracer(@NonNull Tracer tracer)

getActiveSpanCount

public @NonNull Integer getActiveSpanCount()

close

public void close()

Specified by:

close in interface AutoCloseable

didStartRequestHandling

public void didStartRequestHandling(@NonNull ServerType serverType,
 @NonNull Request request,
 @Nullable ResourceMethod resourceMethod)

Specified by:

didStartRequestHandling in interface LifecycleObserver

didFinishRequestHandling

public void didFinishRequestHandling(@NonNull ServerType serverType,
 @NonNull Request request,
 @Nullable ResourceMethod resourceMethod,
 @NonNull MarshaledResponse marshaledResponse,
 @NonNull Duration duration,
 @NonNull List<@NonNull Throwable> throwables)

Specified by:

didFinishRequestHandling in interface LifecycleObserver

didTerminateResponseStream

public void didTerminateResponseStream(@NonNull StreamingResponseHandle streamingResponse,
 @NonNull StreamTermination termination)

Specified by:

didTerminateResponseStream in interface LifecycleObserver

didEstablishSseConnection

public void didEstablishSseConnection(@NonNull SseConnection sseConnection)

Specified by:

didEstablishSseConnection in interface LifecycleObserver

didWriteSseEvent

public void didWriteSseEvent(@NonNull SseConnection sseConnection,
 @NonNull SseEvent sseEvent,
 @NonNull Duration writeDuration)

Specified by:

didWriteSseEvent in interface LifecycleObserver

didFailToWriteSseEvent

public void didFailToWriteSseEvent(@NonNull SseConnection sseConnection,
 @NonNull SseEvent sseEvent,
 @NonNull Duration writeDuration,
 @NonNull Throwable throwable)

Specified by:

didFailToWriteSseEvent in interface LifecycleObserver

didWriteSseComment

public void didWriteSseComment(@NonNull SseConnection sseConnection,
 @NonNull SseComment sseComment,
 @NonNull Duration writeDuration)

Specified by:

didWriteSseComment in interface LifecycleObserver

didFailToWriteSseComment

public void didFailToWriteSseComment(@NonNull SseConnection sseConnection,
 @NonNull SseComment sseComment,
 @NonNull Duration writeDuration,
 @NonNull Throwable throwable)

Specified by:

didFailToWriteSseComment in interface LifecycleObserver

didTerminateSseConnection

public void didTerminateSseConnection(@NonNull SseConnection sseConnection,
 @NonNull StreamTermination termination)

Specified by:

didTerminateSseConnection in interface LifecycleObserver

didStartMcpRequestHandling

public void didStartMcpRequestHandling(@NonNull Request request,
 @NonNull Class<? extends McpEndpoint> endpointClass,
 @Nullable String sessionId,
 @NonNull String jsonRpcMethod,
 @Nullable McpJsonRpcRequestId jsonRpcRequestId)

Specified by:

didStartMcpRequestHandling in interface LifecycleObserver

didFinishMcpRequestHandling

public void didFinishMcpRequestHandling(@NonNull Request request,
 @NonNull Class<? extends McpEndpoint> endpointClass,
 @Nullable String sessionId,
 @NonNull String jsonRpcMethod,
 @Nullable McpJsonRpcRequestId jsonRpcRequestId,
 @NonNull McpRequestOutcome requestOutcome,
 @Nullable McpJsonRpcError jsonRpcError,
 @NonNull Duration duration,
 @NonNull List<@NonNull Throwable> throwables)

Specified by:

didFinishMcpRequestHandling in interface LifecycleObserver

didCreateMcpSession

public void didCreateMcpSession(@NonNull Request request,
 @NonNull Class<? extends McpEndpoint> endpointClass,
 @NonNull String sessionId)

Specified by:

didCreateMcpSession in interface LifecycleObserver

didEstablishMcpSseStream

public void didEstablishMcpSseStream(@NonNull McpSseStream stream)

Specified by:

didEstablishMcpSseStream in interface LifecycleObserver

didTerminateMcpSseStream

public void didTerminateMcpSseStream(@NonNull McpSseStream stream,
 @NonNull StreamTermination termination)

Specified by:

didTerminateMcpSseStream in interface LifecycleObserver