@lidofinance/api-metrics
v0.46.0
Published
Utils to work with common API metrics
Downloads
1,641
Readme
@lidofinance/api-metrics
Utils to work with common API metrics
Installation
yarn add @lidofinance/api-metrics
Getting started
collectStartupMetrics
Just call it in the same place where you call collectDefaultMetrics
.
import { Registry, collectDefaultMetrics } from 'prom-client';
import getConfig from 'next/config';
import { METRICS_PREFIX } from 'config';
import buildInfoJson from 'build-info.json';
import { collectStartupMetrics } from '@lidofinance/api-metrics';
const { publicRuntimeConfig } = getConfig();
const { defaultChain, supportedChains } = publicRuntimeConfig;
export const registry = new Registry();
collectStartupMetrics({
prefix: METRICS_PREFIX,
registry,
defaultChain,
supportedChains: supportedChains.split(','),
version: process.env.npm_package_version ?? 'unversioned',
commit: buildInfoJson.commit,
branch: buildInfoJson.branch,
});
collectDefaultMetrics({ prefix: METRICS_PREFIX, register: registry });
rpcMetricsFactory
It's mostly internal util for @lidofinance/api-rpc and @lidofinance/eth-api-providers, but you should use it if you use RPC requests in some other way.
Take a look into the file itself to view exported metrics, it's quite simple.
rpcMetricsUtils
There is a list of utils, which helps to reduce cardinality, e.g. you should collect '2xx' instead of '200', '201', ... and other HTTP response statuses, because in most cases it doesn't matter.