@lidofinance/api-rpc
v0.64.0
Published
FetchRpc extension for api
Readme
@lidofinance/api-rpc
Extension of fetchRpc, to track common RPC metrics.
Installation
yarn add @lidofinance/api-rpc
Getting started
It's only a factory, which extends fetchRpc, where you need to pass prom-client's registry and prefix for all
tracked metrics.
import { trackedFetchRpcFactory } from '@lidofinance/api-rpc'
import { registry } from './metrics'
import { METRICS_PREFIX } from '../config'
export const fetchRPC = trackedFetchRpcFactory({
registry,
prefix: METRICS_PREFIX,
})Metrics
Each call records:
rpc_service_request— Counter incremented on every attempt (before the fetch).rpc_service_request_methods— Counter per JSON-RPC method in the batch.rpc_service_response— Histogram of response latency withstatusbucket. Thrown requests (e.g. connect timeouts) are observed understatus='xxx'so failures don't go missing.rpc_service_response_result— Counter withresult='success' | 'failure'. Use it for explicit success/failure rate queries (e.g.rate(rpc_service_response_result_total{result="failure"}[5m])).
