Reference¶

grpc_accesslog¶

gRPC access log interceptor.

class grpc_accesslog.AccessLogInterceptor(level=20, name='grpc_accesslog._server', handlers=[<function peer>, <function time_received.<locals>.inner>, <function request>, <function status>, <function response_size>, <function user_agent>], separator=' ', propagate=False, logger=None)¶

Generate a log line for each RPC invocation.

Parameters:

level (int)
name (str)
handlers (List[Callable[[LogContext], str]])
separator (str)
propagate (bool)
logger (Logger | None)

intercept_service(continuation, handler_call_details)¶

Intercept an RPC.

Parameters:

continuation (Callable[[HandlerCallDetails], RpcMethodHandler | None])
handler_call_details (HandlerCallDetails)

Return type:

RpcMethodHandler | None

class grpc_accesslog.AsyncAccessLogInterceptor(level=20, name='grpc_accesslog._server', handlers=[<function peer>, <function time_received.<locals>.inner>, <function request>, <function status>, <function response_size>, <function user_agent>], separator=' ', propagate=False, logger=None)¶

Generate a log line for each RPC invocation.

Parameters:

level (int)
name (str)
handlers (List[Callable[[LogContext], str]])
separator (str)
propagate (bool)
logger (Logger | None)

async intercept_service(continuation, handler_call_details)¶

Intercept an RPC.

Parameters:

continuation (Callable[[HandlerCallDetails], Awaitable[RpcMethodHandler]])
handler_call_details (HandlerCallDetails)

Return type:

RpcMethodHandler

class grpc_accesslog.LogContext(server_context, method_name, request, response, start, end)¶

Data available to gRPC log handlers.

Parameters:

server_context (ServicerContext)
method_name (str)
request (Any)
response (Any)
start (datetime)
end (datetime)

end: datetime¶: Alias for field number 5

method_name: str¶: Alias for field number 1

request: Any¶: Alias for field number 2

response: Any¶: Alias for field number 3

server_context: ServicerContext¶: Alias for field number 0

start: datetime¶: Alias for field number 4