Interface McpMetricsEvent

All Known Implementing Classes:

McpMetricsEvent.CancelationSignaled, McpMetricsEvent.ConnectionAccepted, McpMetricsEvent.ConnectionRejected, McpMetricsEvent.HandlerCapacityRejected, McpMetricsEvent.HandlerDequeued, McpMetricsEvent.HandlerExecutionFinished, McpMetricsEvent.HandlerExecutionStarted, McpMetricsEvent.HandlerQueued, McpMetricsEvent.KeepAliveEmitted, McpMetricsEvent.ProgressEmitted, McpMetricsEvent.ProtocolError, McpMetricsEvent.RequestAccepted, McpMetricsEvent.RequestFinished, McpMetricsEvent.RequestRejected, McpMetricsEvent.RequestStarted, McpMetricsEvent.RequestStreamClosed, McpMetricsEvent.RequestStreamOpened, McpMetricsEvent.ServerStarted, McpMetricsEvent.ServerStopped, McpMetricsEvent.SubscriptionClosed, McpMetricsEvent.SubscriptionMaintenance, McpMetricsEvent.SubscriptionOpened, McpMetricsEvent.TransportFailure, McpMetricsEvent.UnknownMirroredHeader

@ThreadSafe
public sealed interface McpMetricsEvent
permits McpMetricsEvent.ServerStarted, McpMetricsEvent.ConnectionAccepted, McpMetricsEvent.ConnectionRejected, McpMetricsEvent.RequestAccepted, McpMetricsEvent.RequestRejected, McpMetricsEvent.RequestStarted, McpMetricsEvent.RequestFinished, McpMetricsEvent.RequestStreamOpened, McpMetricsEvent.RequestStreamClosed, McpMetricsEvent.SubscriptionOpened, McpMetricsEvent.SubscriptionClosed, McpMetricsEvent.SubscriptionMaintenance, McpMetricsEvent.CancelationSignaled, McpMetricsEvent.ProgressEmitted, McpMetricsEvent.KeepAliveEmitted, McpMetricsEvent.ProtocolError, McpMetricsEvent.UnknownMirroredHeader, McpMetricsEvent.HandlerExecutionStarted, McpMetricsEvent.HandlerExecutionFinished, McpMetricsEvent.HandlerQueued, McpMetricsEvent.HandlerDequeued, McpMetricsEvent.HandlerCapacityRejected, McpMetricsEvent.TransportFailure, McpMetricsEvent.ServerStopped

A Soklet-owned immutable semantic event delivered to a MetricsCollector.

The hierarchy deliberately has no generic value, label map, or bag of optional fields. Each event exposes only the dimensions meaningful for its transition. Framework-produced endpoint paths are finite registered declarations, and framework-produced method values are recognized names or UNRECOGNIZED_JSON_RPC_METHOD. Public event factories enforce only the documented value shape; applications construct events through these factories and own the confidentiality and cardinality of supplied values. No raw unrecognized method, operation name, resource URI, principal, header, trace data, argument, or result is a framework-produced built-in metric dimension.

This type may gain reviewed permitted subtypes in Soklet 4.x; use a forward-compatible default when switching over its values.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	McpMetricsEvent.CancelationSignaled	Cooperative request cancelation was signaled.
static final class	McpMetricsEvent.ConnectionAccepted	A successfully accepted TCP connection was admitted within the configured connection-capacity bound.
static final class	McpMetricsEvent.ConnectionRejected	A successfully accepted TCP connection was rejected because the configured maximum-connection capacity was full.
static final class	McpMetricsEvent.HandlerCapacityRejected	Handler dispatch was rejected because the bounded queue was full.
static final class	McpMetricsEvent.HandlerDequeued	An application handler request left the bounded queue.
static final class	McpMetricsEvent.HandlerExecutionFinished	A reserved application-handler execution slot was released after actual handler exit or failed executor submission.
static final class	McpMetricsEvent.HandlerExecutionStarted	An application handler acquired an execution slot.
static final class	McpMetricsEvent.HandlerQueued	An application handler request entered the bounded queue.
static final class	McpMetricsEvent.KeepAliveEmitted	A keep-alive comment was accepted for delivery.
static final class	McpMetricsEvent.ProgressEmitted	A progress notification was accepted for delivery.
static final class	McpMetricsEvent.ProtocolError	A fixed JSON-RPC or MCP protocol error was produced.
static final class	McpMetricsEvent.RequestAccepted	An HTTP request was accepted into the bounded protocol processor.
static final class	McpMetricsEvent.RequestFinished	An admitted semantic request reached its client-visible terminal outcome.
static final class	McpMetricsEvent.RequestRejected	A request was rejected before admitted semantic handling began.
static final class	McpMetricsEvent.RequestStarted	An admitted semantic request started.
static final class	McpMetricsEvent.RequestStreamClosed	A request response stream closed.
static final class	McpMetricsEvent.RequestStreamOpened	A request response stream opened.
static final class	McpMetricsEvent.ServerStarted	A listener generation started successfully.
static final class	McpMetricsEvent.ServerStopped	A real listener stop completed with one fixed outcome.
static final class	McpMetricsEvent.SubscriptionClosed	An MCP subscription terminated.
static final class	McpMetricsEvent.SubscriptionMaintenance	One bounded subscription-authorization, catalog-projection, or reconciliation maintenance outcome.
static final class	McpMetricsEvent.SubscriptionOpened	An MCP subscription became active.
static final class	McpMetricsEvent.TransportFailure	The dedicated MCP transport recorded a bounded failure reason.
static final class	McpMetricsEvent.UnknownMirroredHeader	An unknown mirrored-header occurrence was counted without its name.

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull String	UNRECOGNIZED_JSON_RPC_METHOD	Fixed bounded-cardinality method dimension used for every unrecognized or attacker-supplied JSON-RPC method.

Method Summary

Static Methods

Modifier and Type	Method	Description
static @NonNull McpMetricsEvent.CancelationSignaled	cancelationSignaled(@NonNull String endpointPath, @NonNull String jsonRpcMethod)	Creates an event indicating that cooperative cancelation was signaled.
static @NonNull McpMetricsEvent.ConnectionAccepted	connectionAccepted()
static @NonNull McpMetricsEvent.ConnectionRejected	connectionRejected()
static @NonNull McpMetricsEvent.HandlerCapacityRejected	handlerCapacityRejected()
static @NonNull McpMetricsEvent.HandlerDequeued	handlerDequeued()
static @NonNull McpMetricsEvent.HandlerExecutionFinished	handlerExecutionFinished()
static @NonNull McpMetricsEvent.HandlerExecutionStarted	handlerExecutionStarted()
static @NonNull McpMetricsEvent.HandlerQueued	handlerQueued()
static @NonNull McpMetricsEvent.KeepAliveEmitted	keepAliveEmitted()
static @NonNull McpMetricsEvent.ProgressEmitted	progressEmitted(@NonNull String endpointPath, @NonNull String jsonRpcMethod)	Creates an event indicating that a progress notification was emitted.
static @NonNull McpMetricsEvent.ProtocolError	protocolError(@NonNull Integer code)	Creates an event indicating that a fixed protocol error was produced.
static @NonNull McpMetricsEvent.RequestAccepted	requestAccepted()
static @NonNull McpMetricsEvent.RequestFinished	requestFinished(@NonNull String endpointPath, @NonNull String jsonRpcMethod, @NonNull McpRequestOutcome requestOutcome, @NonNull Duration requestDuration)	Creates an event indicating that an admitted semantic request finished.
static @NonNull McpMetricsEvent.RequestRejected	requestRejected()
static @NonNull McpMetricsEvent.RequestStarted	requestStarted(@NonNull String endpointPath, @NonNull String jsonRpcMethod)	Creates an event indicating that an admitted semantic request started.
static @NonNull McpMetricsEvent.RequestStreamClosed	requestStreamClosed(@NonNull String endpointPath, @NonNull String jsonRpcMethod, @NonNull McpStreamTerminationReason streamTerminationReason, @NonNull Duration streamDuration)	Creates an event indicating that a request response stream closed.
static @NonNull McpMetricsEvent.RequestStreamOpened	requestStreamOpened(@NonNull String endpointPath, @NonNull String jsonRpcMethod)	Creates an event indicating that a request response stream opened.
static @NonNull McpMetricsEvent.ServerStarted	serverStarted()
static @NonNull McpMetricsEvent.ServerStopped	serverStopped(@NonNull ShutdownComponentDisposition shutdownComponentDisposition)	Creates an event indicating that a real listener stop completed.
static @NonNull McpMetricsEvent.SubscriptionClosed	subscriptionClosed(@NonNull String endpointPath, @NonNull McpStreamTerminationReason streamTerminationReason, @NonNull Duration subscriptionDuration)	Creates an event indicating that an MCP subscription terminated.
static @NonNull McpMetricsEvent.SubscriptionMaintenance	subscriptionMaintenance(@NonNull String endpointPath, @NonNull McpMetricsEvent.SubscriptionMaintenance.Work maintenanceWork, @NonNull McpMetricsEvent.SubscriptionMaintenance.Outcome maintenanceOutcome)	Creates an event describing one bounded subscription-maintenance outcome.
static @NonNull McpMetricsEvent.SubscriptionOpened	subscriptionOpened(@NonNull String endpointPath)	Creates an event indicating that an MCP subscription became active.
static @NonNull McpMetricsEvent.TransportFailure	transportFailure(@NonNull MetricsCollector.TransportFailureReason reason)	Creates an event indicating that the transport recorded a failure.
static @NonNull McpMetricsEvent.UnknownMirroredHeader	unknownMirroredHeader(@NonNull String endpointPath, @NonNull String jsonRpcMethod)	Creates an event indicating that an unknown mirrored header was counted.

Field Details

UNRECOGNIZED_JSON_RPC_METHOD

static final @NonNull String UNRECOGNIZED_JSON_RPC_METHOD

Fixed bounded-cardinality method dimension used for every unrecognized or attacker-supplied JSON-RPC method.

See Also:

• Constant Field Values

Method Details

serverStarted

static @NonNull McpMetricsEvent.ServerStarted serverStarted()

Returns:

event indicating that a listener generation started

connectionAccepted

static @NonNull McpMetricsEvent.ConnectionAccepted connectionAccepted()

Returns:

event indicating that a TCP connection was accepted

connectionRejected

static @NonNull McpMetricsEvent.ConnectionRejected connectionRejected()

Returns:

event indicating that a TCP connection was rejected

requestAccepted

static @NonNull McpMetricsEvent.RequestAccepted requestAccepted()

Returns:

event indicating that an HTTP request was accepted

requestRejected

static @NonNull McpMetricsEvent.RequestRejected requestRejected()

Returns:

event indicating that a request was rejected

requestStarted

static @NonNull McpMetricsEvent.RequestStarted requestStarted(@NonNull String endpointPath,
 @NonNull String jsonRpcMethod)

Creates an event indicating that an admitted semantic request started.

Parameters:

endpointPath - finite registered endpoint-path declaration

jsonRpcMethod - bounded JSON-RPC method dimension

Returns:

request-started event

requestFinished

static @NonNull McpMetricsEvent.RequestFinished requestFinished(@NonNull String endpointPath,
 @NonNull String jsonRpcMethod,
 @NonNull McpRequestOutcome requestOutcome,
 @NonNull Duration requestDuration)

Creates an event indicating that an admitted semantic request finished.

Parameters:

endpointPath - finite registered endpoint-path declaration

jsonRpcMethod - bounded JSON-RPC method dimension

requestOutcome - fixed terminal outcome

requestDuration - nonnegative request duration

Returns:

request-finished event

requestStreamOpened

static @NonNull McpMetricsEvent.RequestStreamOpened requestStreamOpened(@NonNull String endpointPath,
 @NonNull String jsonRpcMethod)

Creates an event indicating that a request response stream opened.

Parameters:

endpointPath - finite registered endpoint-path declaration

jsonRpcMethod - bounded JSON-RPC method dimension

Returns:

request-stream-opened event

requestStreamClosed

static @NonNull McpMetricsEvent.RequestStreamClosed requestStreamClosed(@NonNull String endpointPath,
 @NonNull String jsonRpcMethod,
 @NonNull McpStreamTerminationReason streamTerminationReason,
 @NonNull Duration streamDuration)

Creates an event indicating that a request response stream closed.

Parameters:

endpointPath - finite registered endpoint-path declaration

jsonRpcMethod - bounded JSON-RPC method dimension

streamTerminationReason - fixed stream termination reason

streamDuration - nonnegative stream duration

Returns:

request-stream-closed event

subscriptionOpened

static @NonNull McpMetricsEvent.SubscriptionOpened subscriptionOpened(@NonNull String endpointPath)

Creates an event indicating that an MCP subscription became active.

Parameters:

endpointPath - finite registered endpoint-path declaration

Returns:

subscription-opened event

subscriptionClosed

static @NonNull McpMetricsEvent.SubscriptionClosed subscriptionClosed(@NonNull String endpointPath,
 @NonNull McpStreamTerminationReason streamTerminationReason,
 @NonNull Duration subscriptionDuration)

Creates an event indicating that an MCP subscription terminated.

Parameters:

endpointPath - finite registered endpoint-path declaration

streamTerminationReason - fixed stream termination reason

subscriptionDuration - nonnegative subscription duration

Returns:

subscription-closed event

subscriptionMaintenance

static @NonNull McpMetricsEvent.SubscriptionMaintenance subscriptionMaintenance(@NonNull String endpointPath,
 @NonNull McpMetricsEvent.SubscriptionMaintenance.Work maintenanceWork,
 @NonNull McpMetricsEvent.SubscriptionMaintenance.Outcome maintenanceOutcome)

Creates an event describing one bounded subscription-maintenance outcome.

Parameters:

endpointPath - finite registered endpoint-path declaration

maintenanceWork - fixed maintenance work family

maintenanceOutcome - fixed maintenance outcome

Returns:

subscription-maintenance event

cancelationSignaled

static @NonNull McpMetricsEvent.CancelationSignaled cancelationSignaled(@NonNull String endpointPath,
 @NonNull String jsonRpcMethod)

Creates an event indicating that cooperative cancelation was signaled.

Parameters:

endpointPath - finite registered endpoint-path declaration

jsonRpcMethod - bounded JSON-RPC method dimension

Returns:

cancelation-signaled event

progressEmitted

static @NonNull McpMetricsEvent.ProgressEmitted progressEmitted(@NonNull String endpointPath,
 @NonNull String jsonRpcMethod)

Creates an event indicating that a progress notification was emitted.

Parameters:

endpointPath - finite registered endpoint-path declaration

jsonRpcMethod - bounded JSON-RPC method dimension

Returns:

progress-emitted event

keepAliveEmitted

static @NonNull McpMetricsEvent.KeepAliveEmitted keepAliveEmitted()

Returns:

event indicating that a keep-alive was emitted

protocolError

static @NonNull McpMetricsEvent.ProtocolError protocolError(@NonNull Integer code)

Creates an event indicating that a fixed protocol error was produced.

Parameters:

code - fixed JSON-RPC error code

Returns:

protocol-error event

unknownMirroredHeader

static @NonNull McpMetricsEvent.UnknownMirroredHeader unknownMirroredHeader(@NonNull String endpointPath,
 @NonNull String jsonRpcMethod)

Creates an event indicating that an unknown mirrored header was counted.

Parameters:

endpointPath - finite registered endpoint-path declaration

jsonRpcMethod - bounded JSON-RPC method dimension

Returns:

unknown-mirrored-header event

handlerExecutionStarted

static @NonNull McpMetricsEvent.HandlerExecutionStarted handlerExecutionStarted()

Returns:

event indicating that handler execution started

handlerExecutionFinished

static @NonNull McpMetricsEvent.HandlerExecutionFinished handlerExecutionFinished()

Returns:

event indicating that handler execution finished

handlerQueued

static @NonNull McpMetricsEvent.HandlerQueued handlerQueued()

Returns:

event indicating that a handler request entered the queue

handlerDequeued

static @NonNull McpMetricsEvent.HandlerDequeued handlerDequeued()

Returns:

event indicating that a handler request left the queue

handlerCapacityRejected

static @NonNull McpMetricsEvent.HandlerCapacityRejected handlerCapacityRejected()

Returns:

event indicating that handler dispatch was rejected

transportFailure

static @NonNull McpMetricsEvent.TransportFailure transportFailure(@NonNull MetricsCollector.TransportFailureReason reason)

Creates an event indicating that the transport recorded a failure.

Parameters:

reason - fixed low-level transport failure reason

Returns:

transport-failure event

serverStopped

static @NonNull McpMetricsEvent.ServerStopped serverStopped(@NonNull ShutdownComponentDisposition shutdownComponentDisposition)

Creates an event indicating that a real listener stop completed.

Parameters:

shutdownComponentDisposition - fixed listener shutdown-component disposition

Returns:

server-stopped event