Class OpenTelemetryMetricsCollector

java.lang.Object

com.soklet.otel.OpenTelemetryMetricsCollector

All Implemented Interfaces:

MetricsCollector

@ThreadSafe
public final class OpenTelemetryMetricsCollector
extends Object
implements MetricsCollector

OpenTelemetry-backed MetricsCollector for Soklet HTTP and SSE telemetry.

This implementation records counters/histograms via OpenTelemetry's metrics API and is designed to be lightweight, thread-safe, and non-blocking in request hot paths.

By default, standard HTTP metrics use OpenTelemetry Semantic Convention names. Soklet-specific concepts (for example SSE queue/drop/broadcast details) are emitted with soklet.* names.

See https://soklet.com/docs/metrics-collection for Soklet's metrics/telemetry documentation.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenTelemetryMetricsCollector.Builder	Builder used to construct instances of OpenTelemetryMetricsCollector.
static enum	OpenTelemetryMetricsCollector.MetricNamingStrategy	Naming strategy for HTTP metric instrument names.

Nested classes/interfaces inherited from interface MetricsCollector

MetricsCollector.Histogram, MetricsCollector.HistogramSnapshot, MetricsCollector.MetricsFormat, MetricsCollector.RequestReadFailureKey, MetricsCollector.RequestRejectionKey, MetricsCollector.RouteType, MetricsCollector.ServerRouteKey, MetricsCollector.ServerRouteStatusKey, MetricsCollector.ServerSentEventCommentRouteDropKey, MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey, MetricsCollector.ServerSentEventCommentRouteKey, MetricsCollector.ServerSentEventDropReason, MetricsCollector.ServerSentEventEnqueueOutcome, MetricsCollector.ServerSentEventRouteDropKey, MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey, MetricsCollector.ServerSentEventRouteHandshakeFailureKey, MetricsCollector.ServerSentEventRouteKey, MetricsCollector.ServerSentEventRouteTerminationKey, MetricsCollector.Snapshot, MetricsCollector.SnapshotTextOptions

Method Summary

Modifier and Type	Method	Description
static @NonNull OpenTelemetryMetricsCollector.Builder	builder()	Acquires a builder for OpenTelemetryMetricsCollector instances, using GlobalOpenTelemetry by default.
void	didAcceptConnection(@NonNull ServerType serverType, @Nullable InetSocketAddress remoteAddress)
void	didAcceptRequest(@NonNull ServerType serverType, @Nullable InetSocketAddress remoteAddress, @Nullable String requestTarget)
void	didBroadcastServerSentEvent(@NonNull ResourcePathDeclaration route, int attempted, int enqueued, int dropped)
void	didBroadcastServerSentEventComment(@NonNull ResourcePathDeclaration route, @NonNull ServerSentEventComment.CommentType commentType, int attempted, int enqueued, int dropped)
void	didDropServerSentEvent(@NonNull ServerSentEventConnection serverSentEventConnection, @NonNull ServerSentEvent serverSentEvent, @NonNull MetricsCollector.ServerSentEventDropReason reason, @Nullable Integer payloadBytes, @Nullable Integer queueDepth)
void	didDropServerSentEventComment(@NonNull ServerSentEventConnection serverSentEventConnection, @NonNull ServerSentEventComment serverSentEventComment, @NonNull MetricsCollector.ServerSentEventDropReason reason, @Nullable Integer payloadBytes, @Nullable Integer queueDepth)
void	didEstablishServerSentEventConnection(@NonNull ServerSentEventConnection serverSentEventConnection)
void	didFailToAcceptConnection(@NonNull ServerType serverType, @Nullable InetSocketAddress remoteAddress, @NonNull ConnectionRejectionReason reason, @Nullable Throwable throwable)
void	didFailToAcceptRequest(@NonNull ServerType serverType, @Nullable InetSocketAddress remoteAddress, @Nullable String requestTarget, @NonNull RequestRejectionReason reason, @Nullable Throwable throwable)
void	didFailToEstablishServerSentEventConnection(@NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull ServerSentEventConnection.HandshakeFailureReason reason, @Nullable Throwable throwable)
void	didFailToReadRequest(@NonNull ServerType serverType, @Nullable InetSocketAddress remoteAddress, @Nullable String requestTarget, @NonNull RequestReadFailureReason reason, @Nullable Throwable throwable)
void	didFailToWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration responseWriteDuration, @NonNull Throwable throwable)
void	didFailToWriteServerSentEvent(@NonNull ServerSentEventConnection serverSentEventConnection, @NonNull ServerSentEvent serverSentEvent, @NonNull Duration writeDuration, @NonNull Throwable throwable, @Nullable Duration deliveryLag, @Nullable Integer payloadBytes, @Nullable Integer queueDepth)
void	didFailToWriteServerSentEventComment(@NonNull ServerSentEventConnection serverSentEventConnection, @NonNull ServerSentEventComment serverSentEventComment, @NonNull Duration writeDuration, @NonNull Throwable throwable, @Nullable Duration deliveryLag, @Nullable Integer payloadBytes, @Nullable Integer queueDepth)
void	didFinishRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration duration, @NonNull List<@NonNull Throwable> throwables)
void	didStartRequestHandling(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod)
void	didTerminateServerSentEventConnection(@NonNull ServerSentEventConnection serverSentEventConnection, @NonNull Duration connectionDuration, @NonNull ServerSentEventConnection.TerminationReason terminationReason, @Nullable Throwable throwable)
void	didWriteResponse(@NonNull ServerType serverType, @NonNull Request request, @Nullable ResourceMethod resourceMethod, @NonNull MarshaledResponse marshaledResponse, @NonNull Duration responseWriteDuration)
void	didWriteServerSentEvent(@NonNull ServerSentEventConnection serverSentEventConnection, @NonNull ServerSentEvent serverSentEvent, @NonNull Duration writeDuration, @Nullable Duration deliveryLag, @Nullable Integer payloadBytes, @Nullable Integer queueDepth)
void	didWriteServerSentEventComment(@NonNull ServerSentEventConnection serverSentEventConnection, @NonNull ServerSentEventComment serverSentEventComment, @NonNull Duration writeDuration, @Nullable Duration deliveryLag, @Nullable Integer payloadBytes, @Nullable Integer queueDepth)
static @NonNull OpenTelemetryMetricsCollector	fromMeter(@NonNull Meter meter)	Creates an instance from a required Meter without additional customization.
static @NonNull OpenTelemetryMetricsCollector	fromOpenTelemetry(@NonNull OpenTelemetry openTelemetry)	Creates an instance from a required OpenTelemetry without additional customization.
static @NonNull OpenTelemetryMetricsCollector.Builder	withMeter(@NonNull Meter meter)	Acquires a builder seeded with a required Meter.
static @NonNull OpenTelemetryMetricsCollector.Builder	withOpenTelemetry(@NonNull OpenTelemetry openTelemetry)	Acquires a builder seeded with a required OpenTelemetry instance.

Methods inherited from class Object

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

Methods inherited from interface MetricsCollector

didReadRequest, reset, snapshot, snapshotText, willAcceptConnection, willAcceptRequest, willEstablishServerSentEventConnection, willReadRequest, willTerminateServerSentEventConnection, willWriteResponse, willWriteServerSentEvent, willWriteServerSentEventComment

Method Details

builder

public static @NonNull OpenTelemetryMetricsCollector.Builder builder()

Acquires a builder for OpenTelemetryMetricsCollector instances, using GlobalOpenTelemetry by default.

Returns:

the builder

withMeter

public static @NonNull OpenTelemetryMetricsCollector.Builder withMeter(@NonNull Meter meter)

Acquires a builder seeded with a required Meter.

Parameters:

meter - the meter used to build instruments

Returns:

the builder

withOpenTelemetry

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

Acquires a builder seeded with a required OpenTelemetry instance.

Parameters:

openTelemetry - the OpenTelemetry instance used to build a meter

Returns:

the builder

fromMeter

public static @NonNull OpenTelemetryMetricsCollector fromMeter(@NonNull Meter meter)

Creates an instance from a required Meter without additional customization.

Parameters:

meter - the meter used to build instruments

Returns:

an OpenTelemetryMetricsCollector instance

fromOpenTelemetry

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

Creates an instance from a required OpenTelemetry without additional customization.

Parameters:

openTelemetry - the OpenTelemetry instance used to build a meter

Returns:

an OpenTelemetryMetricsCollector instance

didAcceptConnection

public void didAcceptConnection(@NonNull ServerType serverType,
 @Nullable InetSocketAddress remoteAddress)

Specified by:

didAcceptConnection in interface MetricsCollector

didFailToAcceptConnection

public void didFailToAcceptConnection(@NonNull ServerType serverType,
 @Nullable InetSocketAddress remoteAddress,
 @NonNull ConnectionRejectionReason reason,
 @Nullable Throwable throwable)

Specified by:

didFailToAcceptConnection in interface MetricsCollector

didAcceptRequest

public void didAcceptRequest(@NonNull ServerType serverType,
 @Nullable InetSocketAddress remoteAddress,
 @Nullable String requestTarget)

Specified by:

didAcceptRequest in interface MetricsCollector

didFailToAcceptRequest

public void didFailToAcceptRequest(@NonNull ServerType serverType,
 @Nullable InetSocketAddress remoteAddress,
 @Nullable String requestTarget,
 @NonNull RequestRejectionReason reason,
 @Nullable Throwable throwable)

Specified by:

didFailToAcceptRequest in interface MetricsCollector

didFailToReadRequest

public void didFailToReadRequest(@NonNull ServerType serverType,
 @Nullable InetSocketAddress remoteAddress,
 @Nullable String requestTarget,
 @NonNull RequestReadFailureReason reason,
 @Nullable Throwable throwable)

Specified by:

didFailToReadRequest in interface MetricsCollector

didStartRequestHandling

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

Specified by:

didStartRequestHandling in interface MetricsCollector

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 MetricsCollector

didWriteResponse

public void didWriteResponse(@NonNull ServerType serverType,
 @NonNull Request request,
 @Nullable ResourceMethod resourceMethod,
 @NonNull MarshaledResponse marshaledResponse,
 @NonNull Duration responseWriteDuration)

Specified by:

didWriteResponse in interface MetricsCollector

didFailToWriteResponse

public void didFailToWriteResponse(@NonNull ServerType serverType,
 @NonNull Request request,
 @Nullable ResourceMethod resourceMethod,
 @NonNull MarshaledResponse marshaledResponse,
 @NonNull Duration responseWriteDuration,
 @NonNull Throwable throwable)

Specified by:

didFailToWriteResponse in interface MetricsCollector

didEstablishServerSentEventConnection

public void didEstablishServerSentEventConnection(@NonNull ServerSentEventConnection serverSentEventConnection)

Specified by:

didEstablishServerSentEventConnection in interface MetricsCollector

didFailToEstablishServerSentEventConnection

public void didFailToEstablishServerSentEventConnection(@NonNull Request request,
 @Nullable ResourceMethod resourceMethod,
 @NonNull ServerSentEventConnection.HandshakeFailureReason reason,
 @Nullable Throwable throwable)

Specified by:

didFailToEstablishServerSentEventConnection in interface MetricsCollector

didTerminateServerSentEventConnection

public void didTerminateServerSentEventConnection(@NonNull ServerSentEventConnection serverSentEventConnection,
 @NonNull Duration connectionDuration,
 @NonNull ServerSentEventConnection.TerminationReason terminationReason,
 @Nullable Throwable throwable)

Specified by:

didTerminateServerSentEventConnection in interface MetricsCollector

didWriteServerSentEvent

public void didWriteServerSentEvent(@NonNull ServerSentEventConnection serverSentEventConnection,
 @NonNull ServerSentEvent serverSentEvent,
 @NonNull Duration writeDuration,
 @Nullable Duration deliveryLag,
 @Nullable Integer payloadBytes,
 @Nullable Integer queueDepth)

Specified by:

didWriteServerSentEvent in interface MetricsCollector

didFailToWriteServerSentEvent

public void didFailToWriteServerSentEvent(@NonNull ServerSentEventConnection serverSentEventConnection,
 @NonNull ServerSentEvent serverSentEvent,
 @NonNull Duration writeDuration,
 @NonNull Throwable throwable,
 @Nullable Duration deliveryLag,
 @Nullable Integer payloadBytes,
 @Nullable Integer queueDepth)

Specified by:

didFailToWriteServerSentEvent in interface MetricsCollector

didDropServerSentEvent

public void didDropServerSentEvent(@NonNull ServerSentEventConnection serverSentEventConnection,
 @NonNull ServerSentEvent serverSentEvent,
 @NonNull MetricsCollector.ServerSentEventDropReason reason,
 @Nullable Integer payloadBytes,
 @Nullable Integer queueDepth)

Specified by:

didDropServerSentEvent in interface MetricsCollector

didWriteServerSentEventComment

public void didWriteServerSentEventComment(@NonNull ServerSentEventConnection serverSentEventConnection,
 @NonNull ServerSentEventComment serverSentEventComment,
 @NonNull Duration writeDuration,
 @Nullable Duration deliveryLag,
 @Nullable Integer payloadBytes,
 @Nullable Integer queueDepth)

Specified by:

didWriteServerSentEventComment in interface MetricsCollector

didFailToWriteServerSentEventComment

public void didFailToWriteServerSentEventComment(@NonNull ServerSentEventConnection serverSentEventConnection,
 @NonNull ServerSentEventComment serverSentEventComment,
 @NonNull Duration writeDuration,
 @NonNull Throwable throwable,
 @Nullable Duration deliveryLag,
 @Nullable Integer payloadBytes,
 @Nullable Integer queueDepth)

Specified by:

didFailToWriteServerSentEventComment in interface MetricsCollector

didDropServerSentEventComment

public void didDropServerSentEventComment(@NonNull ServerSentEventConnection serverSentEventConnection,
 @NonNull ServerSentEventComment serverSentEventComment,
 @NonNull MetricsCollector.ServerSentEventDropReason reason,
 @Nullable Integer payloadBytes,
 @Nullable Integer queueDepth)

Specified by:

didDropServerSentEventComment in interface MetricsCollector

didBroadcastServerSentEvent

public void didBroadcastServerSentEvent(@NonNull ResourcePathDeclaration route,
 int attempted,
 int enqueued,
 int dropped)

Specified by:

didBroadcastServerSentEvent in interface MetricsCollector

didBroadcastServerSentEventComment

public void didBroadcastServerSentEventComment(@NonNull ResourcePathDeclaration route,
 @NonNull ServerSentEventComment.CommentType commentType,
 int attempted,
 int enqueued,
 int dropped)

Specified by:

didBroadcastServerSentEventComment in interface MetricsCollector