Struct sc_rpc_server::middleware::RpcMetrics

pub struct RpcMetrics { /* private fields */ }

Metrics for RPC middleware storing information about the number of requests started/completed, calls started/completed and their timings.

Implementations

impl RpcMetrics

pub fn new(
    metrics_registry: Option<&Registry>
) -> Result<Option<Self>, PrometheusError>

Create an instance of metrics

Trait Implementations

impl Clone for RpcMetrics

fn clone(&self) -> RpcMetrics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RpcMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Logger for RpcMetrics

type Instant = Instant

Intended to carry timestamp of a request, for example std::time::Instant. How the trait measures time, if at all, is entirely up to the implementation.

fn on_connect(
    &self,
    _remote_addr: SocketAddr,
    _request: &HttpRequest,
    transport: TransportProtocol
)

Called when a new client connects

fn on_request(&self, transport: TransportProtocol) -> Self::Instant

Called when a new JSON-RPC request comes to the server.

fn on_call(
    &self,
    name: &str,
    params: Params<'_>,
    kind: MethodKind,
    transport: TransportProtocol
)

Called on each JSON-RPC method call, batch requests will trigger on_call multiple times.

fn on_result(
    &self,
    name: &str,
    success: bool,
    started_at: Self::Instant,
    transport: TransportProtocol
)

Called on each JSON-RPC method completion, batch requests will trigger on_result multiple times.

fn on_response(
    &self,
    result: &str,
    started_at: Self::Instant,
    transport: TransportProtocol
)

Called once the JSON-RPC request is finished and response is sent to the output buffer.

fn on_disconnect(&self, _remote_addr: SocketAddr, transport: TransportProtocol)

Called when a client disconnects