core / pragma.logging / RequestBaggagePlugin /

RequestBaggagePlugin #

interface RequestBaggagePlugin

Request Baggage represents additional metadata that will be included in logs during rpc processing. Request baggage is forwarded alongside service requests that will provide consistent, shared, context for logs throughout chained requests within the platform. The name baggage is borrowed from Open Telemetry to indicate that this represents additional, non-essential data.

PERFORMANCE NOTE - Because this feature involves additional processing, memory, and network pressure on every request, every effort should be made to minimize the processing overhead and size of payload. For this reason, the platform enforces (configurable) limits to constrain the size of request baggage.

Functions #

NameSummary

getForExternalRequest

abstract fun getForExternalRequest(request: ExternalRequest, session: RpcExecutionContext): MutableRequestBaggage

Provides an opportunity to add request baggage while processing RPCs from player, partner, and operator sessions.

getForServiceRpc

abstract fun <Request : Request> getForServiceRpc(current: RequestBaggage, request: Request, pragmaSession: PragmaSession): MutableRequestBaggage

Provides an opportunity to add request baggage during service-to-service message flow. Existing request baggage will be provided and must be included added to the method result to prevent these values from being dropped / overridden.

Inheritors #

Name

DefaultRequestBaggagePlugin