@lidofinance/api-metrics 0.0.2

package/README.md

@@ -0,0 +1,55 @@
+# @lidofinance/api-metrics
+
+Utils to work with common tracked metrics
+
+## Installation
+
+1. Authenticate to use GitHub registry as described in parent [README.md](../../../README.md).
+2. `yarn add @lidofinance/api-metrics`.
+
+## Getting started
+
+### collectStartupMetrics
+
+Just call it in the same place where you call `collectDefaultMetrics`.
+
+```ts
+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();
+
+if (process.env.NODE_ENV === 'production') {
+  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](../rpc/README.md)
+and [@lidofinance/eth-api-providers](../../eth/api/providers/README.md), 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](https://www.robustperception.io/cardinality-is-key/),
+e.g. you should collect '2xx' instead of '200', '201', ... and other HTTP response statuses, because in most cases it
+doesn't matter.

package/dist/index.cjs

@@ -0,0 +1,147 @@
+var $7tm02$promclient = require("prom-client");
+
+function $parcel$exportWildcard(dest, source) {
+  Object.keys(source).forEach(function(key) {
+    if (key === 'default' || key === '__esModule' || dest.hasOwnProperty(key)) {
+      return;
+    }
+
+    Object.defineProperty(dest, key, {
+      enumerable: true,
+      get: function get() {
+        return source[key];
+      }
+    });
+  });
+
+  return dest;
+}
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $4773eaec24f907ac$exports = {};
+
+$parcel$export($4773eaec24f907ac$exports, "chainConfigFactory", () => $4773eaec24f907ac$export$3912f78fe5436ec0);
+$parcel$export($4773eaec24f907ac$exports, "buildInfoFactory", () => $4773eaec24f907ac$export$c71d26d8163583e2);
+$parcel$export($4773eaec24f907ac$exports, "collectStartupMetrics", () => $4773eaec24f907ac$export$ee77f8ab9c4e7a05);
+
+const $4773eaec24f907ac$export$3912f78fe5436ec0 = (prefix)=>new (0, $7tm02$promclient.Gauge)({
+        name: prefix + "chain_config_info",
+        help: "Default network and supported networks",
+        labelNames: [
+            "default_chain",
+            "supported_chains"
+        ],
+        registers: []
+    });
+const $4773eaec24f907ac$export$c71d26d8163583e2 = (prefix)=>new (0, $7tm02$promclient.Gauge)({
+        name: prefix + "build_info",
+        help: "Version, branch and commit of the current build",
+        labelNames: [
+            "version",
+            "commit",
+            "branch"
+        ],
+        registers: []
+    });
+const $4773eaec24f907ac$export$ee77f8ab9c4e7a05 = ({ prefix: prefix , registry: registry , defaultChain: defaultChain , supportedChains: supportedChains , version: version , commit: commit , branch: branch  })=>{
+    const chainConfig = $4773eaec24f907ac$export$3912f78fe5436ec0(prefix);
+    registry.registerMetric(chainConfig);
+    chainConfig.labels({
+        default_chain: defaultChain
+    }).set(1);
+    supportedChains.forEach((chain)=>{
+        chainConfig.labels({
+            supported_chains: chain
+        }).set(1);
+    });
+    const buildInfo = $4773eaec24f907ac$export$c71d26d8163583e2(prefix);
+    registry.registerMetric(buildInfo);
+    buildInfo.labels(version, commit, branch).set(1);
+};
+
+
+var $c4da43e18c6d237f$exports = {};
+
+$parcel$export($c4da43e18c6d237f$exports, "rpcRequestCountFactory", () => $c4da43e18c6d237f$export$ef58728a4fe523fc);
+$parcel$export($c4da43e18c6d237f$exports, "rpcResponseTimeFactory", () => $c4da43e18c6d237f$export$43dc308e64f0b05d);
+$parcel$export($c4da43e18c6d237f$exports, "rpcRequestMethodsFactory", () => $c4da43e18c6d237f$export$2178a8960eec76eb);
+$parcel$export($c4da43e18c6d237f$exports, "rpcMetricsFactory", () => $c4da43e18c6d237f$export$d6ea70e849062acd);
+
+const $c4da43e18c6d237f$export$ef58728a4fe523fc = (prefix)=>new (0, $7tm02$promclient.Counter)({
+        name: prefix + "rpc_service_request_count",
+        help: "RPC service request count",
+        labelNames: [
+            "chainId",
+            "provider"
+        ],
+        registers: []
+    });
+const $c4da43e18c6d237f$export$43dc308e64f0b05d = (prefix)=>new (0, $7tm02$promclient.Histogram)({
+        name: prefix + "rpc_service_response_time",
+        help: "RPC service response time seconds",
+        buckets: [
+            0.1,
+            0.2,
+            0.3,
+            0.6,
+            1,
+            1.5,
+            2,
+            5
+        ],
+        labelNames: [
+            "chainId",
+            "provider",
+            "status"
+        ],
+        registers: []
+    });
+const $c4da43e18c6d237f$export$2178a8960eec76eb = (prefix)=>new (0, $7tm02$promclient.Counter)({
+        name: prefix + "rpc_service_request_methods",
+        help: "RPC service request methods",
+        labelNames: [
+            "method"
+        ],
+        registers: []
+    });
+let $c4da43e18c6d237f$var$cache = null;
+const $c4da43e18c6d237f$export$d6ea70e849062acd = (prefix, registry)=>{
+    if ($c4da43e18c6d237f$var$cache == null) {
+        const rpcRequestCount = $c4da43e18c6d237f$export$ef58728a4fe523fc(prefix);
+        registry.registerMetric(rpcRequestCount);
+        const rpcRequestMethods = $c4da43e18c6d237f$export$2178a8960eec76eb(prefix);
+        registry.registerMetric(rpcRequestMethods);
+        const rpcResponseTime = $c4da43e18c6d237f$export$43dc308e64f0b05d(prefix);
+        registry.registerMetric(rpcResponseTime);
+        $c4da43e18c6d237f$var$cache = {
+            rpcRequestCount: rpcRequestCount,
+            rpcRequestMethods: rpcRequestMethods,
+            rpcResponseTime: rpcResponseTime
+        };
+    }
+    return $c4da43e18c6d237f$var$cache;
+};
+
+
+var $d7531565112499b5$exports = {};
+
+$parcel$export($d7531565112499b5$exports, "getStatusLabel", () => $d7531565112499b5$export$489c297e3a119321);
+$parcel$export($d7531565112499b5$exports, "getProviderLabel", () => $d7531565112499b5$export$f40021662990adcd);
+const $d7531565112499b5$export$489c297e3a119321 = (status)=>{
+    if (status == null || status < 100 || status > 600) return "xxx";
+    const majorStatus = Math.trunc(status / 100);
+    return `${majorStatus}xx`;
+};
+const $d7531565112499b5$export$f40021662990adcd = (providerURL)=>{
+    const parsedUrl = new URL(providerURL);
+    return parsedUrl.hostname.split(".").slice(-2).join(".");
+};
+
+
+$parcel$exportWildcard(module.exports, $4773eaec24f907ac$exports);
+$parcel$exportWildcard(module.exports, $c4da43e18c6d237f$exports);
+$parcel$exportWildcard(module.exports, $d7531565112499b5$exports);
+
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;ACAA;AAEO,MAAM,yCAAkB,GAAG,CAAC,MAAc,GAC/C,IAAI,CAAA,GAAA,uBAAK,CAAA,CAAC;QACR,IAAI,EAAE,MAAM,GAAG,mBAAmB;QAClC,IAAI,EAAE,wCAAwC;QAC9C,UAAU,EAAE;YAAC,eAAe;YAAE,kBAAkB;SAAC;QACjD,SAAS,EAAE,EAAE;KACd,CAAC;AAEG,MAAM,yCAAgB,GAAG,CAAC,MAAc,GAC7C,IAAI,CAAA,GAAA,uBAAK,CAAA,CAAC;QACR,IAAI,EAAE,MAAM,GAAG,YAAY;QAC3B,IAAI,EAAE,iDAAiD;QACvD,UAAU,EAAE;YAAC,SAAS;YAAE,QAAQ;YAAE,QAAQ;SAAC;QAC3C,SAAS,EAAE,EAAE;KACd,CAAC;AAWG,MAAM,yCAAqB,GAAG,CAAC,UACpC,MAAM,CAAA,YACN,QAAQ,CAAA,gBACR,YAAY,CAAA,mBACZ,eAAe,CAAA,WACf,OAAO,CAAA,UACP,MAAM,CAAA,UACN,MAAM,CAAA,EACwB,GAAK;IACnC,MAAM,WAAW,GAAG,yCAAkB,CAAC,MAAM,CAAC;IAC9C,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC;IACpC,WAAW,CAAC,MAAM,CAAC;QAAE,aAAa,EAAE,YAAY;KAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,eAAe,CAAC,OAAO,CAAC,CAAC,KAAK,GAAK;QACjC,WAAW,CAAC,MAAM,CAAC;YAAE,gBAAgB,EAAE,KAAK;SAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACvD,CAAC;IAEF,MAAM,SAAS,GAAG,yCAAgB,CAAC,MAAM,CAAC;IAC1C,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC;IAClC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CACjD;;AD9CD;;;;;;;AEAA;AAEO,MAAM,yCAAsB,GAAG,CAAC,MAAc,GACnD,IAAI,CAAA,GAAA,yBAAO,CAAA,CAAC;QACV,IAAI,EAAE,MAAM,GAAG,2BAA2B;QAC1C,IAAI,EAAE,2BAA2B;QACjC,UAAU,EAAE;YAAC,SAAS;YAAE,UAAU;SAAC;QACnC,SAAS,EAAE,EAAE;KACd,CAAC;AAEG,MAAM,yCAAsB,GAAG,CAAC,MAAc,GACnD,IAAI,CAAA,GAAA,2BAAS,CAAA,CAAC;QACZ,IAAI,EAAE,MAAM,GAAG,2BAA2B;QAC1C,IAAI,EAAE,mCAAmC;QACzC,OAAO,EAAE;AAAC,eAAG;AAAE,eAAG;AAAE,eAAG;AAAE,eAAG;AAAE,aAAC;AAAE,eAAG;AAAE,aAAC;AAAE,aAAC;SAAC;QAC3C,UAAU,EAAE;YAAC,SAAS;YAAE,UAAU;YAAE,QAAQ;SAAC;QAC7C,SAAS,EAAE,EAAE;KACd,CAAC;AAEG,MAAM,yCAAwB,GAAG,CAAC,MAAc,GACrD,IAAI,CAAA,GAAA,yBAAO,CAAA,CAAC;QACV,IAAI,EAAE,MAAM,GAAG,6BAA6B;QAC5C,IAAI,EAAE,6BAA6B;QACnC,UAAU,EAAE;YAAC,QAAQ;SAAC;QACtB,SAAS,EAAE,EAAE;KACd,CAAC;AAEJ,IAAI,2BAAK,GAIE,IAAI;AAER,MAAM,yCAAiB,GAAG,CAAC,MAAc,EAAE,QAAkB,GAAK;IACvE,IAAI,2BAAK,IAAI,IAAI,EAAE;QACjB,MAAM,eAAe,GAAG,yCAAsB,CAAC,MAAM,CAAC;QACtD,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC;QAExC,MAAM,iBAAiB,GAAG,yCAAwB,CAAC,MAAM,CAAC;QAC1D,QAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC;QAE1C,MAAM,eAAe,GAAG,yCAAsB,CAAC,MAAM,CAAC;QACtD,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC;QAExC,2BAAK,GAAG;6BACN,eAAe;+BACf,iBAAiB;6BACjB,eAAe;SAChB;KACF;IAED,OAAO,2BAAK,CAAA;CACb;;;;;;;AC5CM,MAAM,yCAAc,GAAG,CAAC,MAA0B,GAAK;IAC5D,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,GAAG,GAAG,IAAI,MAAM,GAAG,GAAG,EAChD,OAAO,KAAK,CAAA;IAEd,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;IAC5C,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CAAA;CAC1B;AAWM,MAAM,yCAAgB,GAAG,CAAC,WAAmB,GAAK;IACvD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC;IACtC,OAAO,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;CACzD;;","sources":["packages/api/metrics/src/index.ts","packages/api/metrics/src/collectStartupMetrics.ts","packages/api/metrics/src/rpcMetricsFactory.ts","packages/api/metrics/src/rpcMetricsUtils.ts"],"sourcesContent":["export * from './collectStartupMetrics'\nexport * from './rpcMetricsFactory'\nexport * from './rpcMetricsUtils'\n","import { Gauge, Registry } from 'prom-client'\n\nexport const chainConfigFactory = (prefix: string) =>\n  new Gauge({\n    name: prefix + 'chain_config_info',\n    help: 'Default network and supported networks',\n    labelNames: ['default_chain', 'supported_chains'],\n    registers: [],\n  })\n\nexport const buildInfoFactory = (prefix: string) =>\n  new Gauge({\n    name: prefix + 'build_info',\n    help: 'Version, branch and commit of the current build',\n    labelNames: ['version', 'commit', 'branch'],\n    registers: [],\n  })\n\nexport type TrackStartupMetricsParameters = {\n  prefix: string\n  registry: Registry\n  defaultChain: string\n  supportedChains: string[]\n  version: string\n  commit: string\n  branch: string\n}\nexport const collectStartupMetrics = ({\n  prefix,\n  registry,\n  defaultChain,\n  supportedChains,\n  version,\n  commit,\n  branch,\n}: TrackStartupMetricsParameters) => {\n  const chainConfig = chainConfigFactory(prefix)\n  registry.registerMetric(chainConfig)\n  chainConfig.labels({ default_chain: defaultChain }).set(1)\n  supportedChains.forEach((chain) => {\n    chainConfig.labels({ supported_chains: chain }).set(1)\n  })\n\n  const buildInfo = buildInfoFactory(prefix)\n  registry.registerMetric(buildInfo)\n  buildInfo.labels(version, commit, branch).set(1)\n}\n","import { Counter, Histogram, Registry } from 'prom-client'\n\nexport const rpcRequestCountFactory = (prefix: string) =>\n  new Counter({\n    name: prefix + 'rpc_service_request_count',\n    help: 'RPC service request count',\n    labelNames: ['chainId', 'provider'],\n    registers: [],\n  })\n\nexport const rpcResponseTimeFactory = (prefix: string) =>\n  new Histogram({\n    name: prefix + 'rpc_service_response_time',\n    help: 'RPC service response time seconds',\n    buckets: [0.1, 0.2, 0.3, 0.6, 1, 1.5, 2, 5],\n    labelNames: ['chainId', 'provider', 'status'],\n    registers: [],\n  })\n\nexport const rpcRequestMethodsFactory = (prefix: string) =>\n  new Counter({\n    name: prefix + 'rpc_service_request_methods',\n    help: 'RPC service request methods',\n    labelNames: ['method'],\n    registers: [],\n  })\n\nlet cache: {\n  rpcRequestCount: ReturnType<typeof rpcRequestCountFactory>\n  rpcRequestMethods: ReturnType<typeof rpcRequestMethodsFactory>\n  rpcResponseTime: ReturnType<typeof rpcResponseTimeFactory>\n} | null = null\n\nexport const rpcMetricsFactory = (prefix: string, registry: Registry) => {\n  if (cache == null) {\n    const rpcRequestCount = rpcRequestCountFactory(prefix)\n    registry.registerMetric(rpcRequestCount)\n\n    const rpcRequestMethods = rpcRequestMethodsFactory(prefix)\n    registry.registerMetric(rpcRequestMethods)\n\n    const rpcResponseTime = rpcResponseTimeFactory(prefix)\n    registry.registerMetric(rpcResponseTime)\n\n    cache = {\n      rpcRequestCount,\n      rpcRequestMethods,\n      rpcResponseTime,\n    }\n  }\n\n  return cache\n}\n","/*\n * We need to limit how many statuses reported to prometheus, because of cardinality\n *\n * Examples:\n * getStatusLabel(200) => '2xx'\n * getStatusLabel(404) => '4xx'\n * getStatusLabel(undefined) => 'xxx'\n */\nexport const getStatusLabel = (status: number | undefined) => {\n  if (status == null || status < 100 || status > 600) {\n    return 'xxx'\n  }\n  const majorStatus = Math.trunc(status / 100)\n  return `${majorStatus}xx`\n}\n\n/*\n * We also need to limit cardinality of provider labels reported to prometheus, but here\n * we don't need to check if provider is included in the list of available providers,\n * because we get provider from this list itself, but not from user.\n *\n * Examples:\n * getProviderLabel('https://eth-mainnet.alchemyapi.io/v2/...') => 'alchemyapi.io'\n * getProviderLabel('https://goerli.infura.io/v3/...') => 'infura.io'\n */\nexport const getProviderLabel = (providerURL: string) => {\n  const parsedUrl = new URL(providerURL)\n  return parsedUrl.hostname.split('.').slice(-2).join('.')\n}\n"],"names":[],"version":3,"file":"index.cjs.map","sourceRoot":"../../../../"}

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { Gauge, Registry, Counter, Histogram } from "prom-client";
+export const chainConfigFactory: (prefix: string) => Gauge<"default_chain" | "supported_chains">;
+export const buildInfoFactory: (prefix: string) => Gauge<"version" | "commit" | "branch">;
+export type TrackStartupMetricsParameters = {
+    prefix: string;
+    registry: Registry;
+    defaultChain: string;
+    supportedChains: string[];
+    version: string;
+    commit: string;
+    branch: string;
+};
+export const collectStartupMetrics: ({ prefix, registry, defaultChain, supportedChains, version, commit, branch, }: TrackStartupMetricsParameters) => void;
+export const rpcRequestCountFactory: (prefix: string) => Counter<"chainId" | "provider">;
+export const rpcResponseTimeFactory: (prefix: string) => Histogram<"chainId" | "provider" | "status">;
+export const rpcRequestMethodsFactory: (prefix: string) => Counter<"method">;
+export const rpcMetricsFactory: (prefix: string, registry: Registry) => {
+    rpcRequestCount: ReturnType<typeof rpcRequestCountFactory>;
+    rpcRequestMethods: ReturnType<typeof rpcRequestMethodsFactory>;
+    rpcResponseTime: ReturnType<typeof rpcResponseTimeFactory>;
+};
+export const getStatusLabel: (status: number | undefined) => string;
+export const getProviderLabel: (providerURL: string) => string;
+
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"mappings":";AAEA,OAAO,MAAM,6BAA8B,MAAM,gDAM7C,CAAA;AAEJ,OAAO,MAAM,2BAA4B,MAAM,2CAM3C,CAAA;AAEJ,4CAA4C;IAC1C,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,eAAe,EAAE,MAAM,EAAE,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AACD,OAAO,MAAM,uGAQV,6BAA6B,SAW/B,CAAA;AC5CD,OAAO,MAAM,iCAAkC,MAAM,oCAMjD,CAAA;AAEJ,OAAO,MAAM,iCAAkC,MAAM,iDAOjD,CAAA;AAEJ,OAAO,MAAM,mCAAoC,MAAM,sBAMnD,CAAA;AAQJ,OAAO,MAAM,4BAA6B,MAAM,YAAY,QAAQ;qBALjD,WAAW,6BAA6B,CAAC;uBACvC,WAAW,+BAA+B,CAAC;qBAC7C,WAAW,6BAA6B,CAAC;CAsB3D,CAAA;AC5CD,OAAO,MAAM,yBAA0B,MAAM,GAAG,SAAS,WAMxD,CAAA;AAWD,OAAO,MAAM,gCAAiC,MAAM,WAGnD,CAAA","sources":["packages/api/metrics/src/src/collectStartupMetrics.ts","packages/api/metrics/src/src/rpcMetricsFactory.ts","packages/api/metrics/src/src/rpcMetricsUtils.ts","packages/api/metrics/src/src/index.ts","packages/api/metrics/src/index.ts"],"sourcesContent":[null,null,null,null,"export * from './collectStartupMetrics'\nexport * from './rpcMetricsFactory'\nexport * from './rpcMetricsUtils'\n"],"names":[],"version":3,"file":"index.d.ts.map","sourceRoot":"../../../../"}

package/dist/index.mjs

@@ -0,0 +1,129 @@
+import {Gauge as $h0jCT$Gauge, Counter as $h0jCT$Counter, Histogram as $h0jCT$Histogram} from "prom-client";
+
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $47a0dd68c3055fb6$exports = {};
+
+$parcel$export($47a0dd68c3055fb6$exports, "chainConfigFactory", () => $47a0dd68c3055fb6$export$3912f78fe5436ec0);
+$parcel$export($47a0dd68c3055fb6$exports, "buildInfoFactory", () => $47a0dd68c3055fb6$export$c71d26d8163583e2);
+$parcel$export($47a0dd68c3055fb6$exports, "collectStartupMetrics", () => $47a0dd68c3055fb6$export$ee77f8ab9c4e7a05);
+
+const $47a0dd68c3055fb6$export$3912f78fe5436ec0 = (prefix)=>new (0, $h0jCT$Gauge)({
+        name: prefix + "chain_config_info",
+        help: "Default network and supported networks",
+        labelNames: [
+            "default_chain",
+            "supported_chains"
+        ],
+        registers: []
+    });
+const $47a0dd68c3055fb6$export$c71d26d8163583e2 = (prefix)=>new (0, $h0jCT$Gauge)({
+        name: prefix + "build_info",
+        help: "Version, branch and commit of the current build",
+        labelNames: [
+            "version",
+            "commit",
+            "branch"
+        ],
+        registers: []
+    });
+const $47a0dd68c3055fb6$export$ee77f8ab9c4e7a05 = ({ prefix: prefix , registry: registry , defaultChain: defaultChain , supportedChains: supportedChains , version: version , commit: commit , branch: branch  })=>{
+    const chainConfig = $47a0dd68c3055fb6$export$3912f78fe5436ec0(prefix);
+    registry.registerMetric(chainConfig);
+    chainConfig.labels({
+        default_chain: defaultChain
+    }).set(1);
+    supportedChains.forEach((chain)=>{
+        chainConfig.labels({
+            supported_chains: chain
+        }).set(1);
+    });
+    const buildInfo = $47a0dd68c3055fb6$export$c71d26d8163583e2(prefix);
+    registry.registerMetric(buildInfo);
+    buildInfo.labels(version, commit, branch).set(1);
+};
+
+
+var $7dd20a662708807a$exports = {};
+
+$parcel$export($7dd20a662708807a$exports, "rpcRequestCountFactory", () => $7dd20a662708807a$export$ef58728a4fe523fc);
+$parcel$export($7dd20a662708807a$exports, "rpcResponseTimeFactory", () => $7dd20a662708807a$export$43dc308e64f0b05d);
+$parcel$export($7dd20a662708807a$exports, "rpcRequestMethodsFactory", () => $7dd20a662708807a$export$2178a8960eec76eb);
+$parcel$export($7dd20a662708807a$exports, "rpcMetricsFactory", () => $7dd20a662708807a$export$d6ea70e849062acd);
+
+const $7dd20a662708807a$export$ef58728a4fe523fc = (prefix)=>new (0, $h0jCT$Counter)({
+        name: prefix + "rpc_service_request_count",
+        help: "RPC service request count",
+        labelNames: [
+            "chainId",
+            "provider"
+        ],
+        registers: []
+    });
+const $7dd20a662708807a$export$43dc308e64f0b05d = (prefix)=>new (0, $h0jCT$Histogram)({
+        name: prefix + "rpc_service_response_time",
+        help: "RPC service response time seconds",
+        buckets: [
+            0.1,
+            0.2,
+            0.3,
+            0.6,
+            1,
+            1.5,
+            2,
+            5
+        ],
+        labelNames: [
+            "chainId",
+            "provider",
+            "status"
+        ],
+        registers: []
+    });
+const $7dd20a662708807a$export$2178a8960eec76eb = (prefix)=>new (0, $h0jCT$Counter)({
+        name: prefix + "rpc_service_request_methods",
+        help: "RPC service request methods",
+        labelNames: [
+            "method"
+        ],
+        registers: []
+    });
+let $7dd20a662708807a$var$cache = null;
+const $7dd20a662708807a$export$d6ea70e849062acd = (prefix, registry)=>{
+    if ($7dd20a662708807a$var$cache == null) {
+        const rpcRequestCount = $7dd20a662708807a$export$ef58728a4fe523fc(prefix);
+        registry.registerMetric(rpcRequestCount);
+        const rpcRequestMethods = $7dd20a662708807a$export$2178a8960eec76eb(prefix);
+        registry.registerMetric(rpcRequestMethods);
+        const rpcResponseTime = $7dd20a662708807a$export$43dc308e64f0b05d(prefix);
+        registry.registerMetric(rpcResponseTime);
+        $7dd20a662708807a$var$cache = {
+            rpcRequestCount: rpcRequestCount,
+            rpcRequestMethods: rpcRequestMethods,
+            rpcResponseTime: rpcResponseTime
+        };
+    }
+    return $7dd20a662708807a$var$cache;
+};
+
+
+var $5ad633af864064eb$exports = {};
+
+$parcel$export($5ad633af864064eb$exports, "getStatusLabel", () => $5ad633af864064eb$export$489c297e3a119321);
+$parcel$export($5ad633af864064eb$exports, "getProviderLabel", () => $5ad633af864064eb$export$f40021662990adcd);
+const $5ad633af864064eb$export$489c297e3a119321 = (status)=>{
+    if (status == null || status < 100 || status > 600) return "xxx";
+    const majorStatus = Math.trunc(status / 100);
+    return `${majorStatus}xx`;
+};
+const $5ad633af864064eb$export$f40021662990adcd = (providerURL)=>{
+    const parsedUrl = new URL(providerURL);
+    return parsedUrl.hostname.split(".").slice(-2).join(".");
+};
+
+
+
+
+export {$47a0dd68c3055fb6$export$3912f78fe5436ec0 as chainConfigFactory, $47a0dd68c3055fb6$export$c71d26d8163583e2 as buildInfoFactory, $47a0dd68c3055fb6$export$ee77f8ab9c4e7a05 as collectStartupMetrics, $7dd20a662708807a$export$ef58728a4fe523fc as rpcRequestCountFactory, $7dd20a662708807a$export$43dc308e64f0b05d as rpcResponseTimeFactory, $7dd20a662708807a$export$2178a8960eec76eb as rpcRequestMethodsFactory, $7dd20a662708807a$export$d6ea70e849062acd as rpcMetricsFactory, $5ad633af864064eb$export$489c297e3a119321 as getStatusLabel, $5ad633af864064eb$export$f40021662990adcd as getProviderLabel};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;ACAA;AAEO,MAAM,yCAAkB,GAAG,CAAC,MAAc,GAC/C,IAAI,CAAA,GAAA,YAAK,CAAA,CAAC;QACR,IAAI,EAAE,MAAM,GAAG,mBAAmB;QAClC,IAAI,EAAE,wCAAwC;QAC9C,UAAU,EAAE;YAAC,eAAe;YAAE,kBAAkB;SAAC;QACjD,SAAS,EAAE,EAAE;KACd,CAAC;AAEG,MAAM,yCAAgB,GAAG,CAAC,MAAc,GAC7C,IAAI,CAAA,GAAA,YAAK,CAAA,CAAC;QACR,IAAI,EAAE,MAAM,GAAG,YAAY;QAC3B,IAAI,EAAE,iDAAiD;QACvD,UAAU,EAAE;YAAC,SAAS;YAAE,QAAQ;YAAE,QAAQ;SAAC;QAC3C,SAAS,EAAE,EAAE;KACd,CAAC;AAWG,MAAM,yCAAqB,GAAG,CAAC,UACpC,MAAM,CAAA,YACN,QAAQ,CAAA,gBACR,YAAY,CAAA,mBACZ,eAAe,CAAA,WACf,OAAO,CAAA,UACP,MAAM,CAAA,UACN,MAAM,CAAA,EACwB,GAAK;IACnC,MAAM,WAAW,GAAG,yCAAkB,CAAC,MAAM,CAAC;IAC9C,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC;IACpC,WAAW,CAAC,MAAM,CAAC;QAAE,aAAa,EAAE,YAAY;KAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,eAAe,CAAC,OAAO,CAAC,CAAC,KAAK,GAAK;QACjC,WAAW,CAAC,MAAM,CAAC;YAAE,gBAAgB,EAAE,KAAK;SAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACvD,CAAC;IAEF,MAAM,SAAS,GAAG,yCAAgB,CAAC,MAAM,CAAC;IAC1C,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC;IAClC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CACjD;;AD9CD;;;;;;;AEAA;AAEO,MAAM,yCAAsB,GAAG,CAAC,MAAc,GACnD,IAAI,CAAA,GAAA,cAAO,CAAA,CAAC;QACV,IAAI,EAAE,MAAM,GAAG,2BAA2B;QAC1C,IAAI,EAAE,2BAA2B;QACjC,UAAU,EAAE;YAAC,SAAS;YAAE,UAAU;SAAC;QACnC,SAAS,EAAE,EAAE;KACd,CAAC;AAEG,MAAM,yCAAsB,GAAG,CAAC,MAAc,GACnD,IAAI,CAAA,GAAA,gBAAS,CAAA,CAAC;QACZ,IAAI,EAAE,MAAM,GAAG,2BAA2B;QAC1C,IAAI,EAAE,mCAAmC;QACzC,OAAO,EAAE;AAAC,eAAG;AAAE,eAAG;AAAE,eAAG;AAAE,eAAG;AAAE,aAAC;AAAE,eAAG;AAAE,aAAC;AAAE,aAAC;SAAC;QAC3C,UAAU,EAAE;YAAC,SAAS;YAAE,UAAU;YAAE,QAAQ;SAAC;QAC7C,SAAS,EAAE,EAAE;KACd,CAAC;AAEG,MAAM,yCAAwB,GAAG,CAAC,MAAc,GACrD,IAAI,CAAA,GAAA,cAAO,CAAA,CAAC;QACV,IAAI,EAAE,MAAM,GAAG,6BAA6B;QAC5C,IAAI,EAAE,6BAA6B;QACnC,UAAU,EAAE;YAAC,QAAQ;SAAC;QACtB,SAAS,EAAE,EAAE;KACd,CAAC;AAEJ,IAAI,2BAAK,GAIE,IAAI;AAER,MAAM,yCAAiB,GAAG,CAAC,MAAc,EAAE,QAAkB,GAAK;IACvE,IAAI,2BAAK,IAAI,IAAI,EAAE;QACjB,MAAM,eAAe,GAAG,yCAAsB,CAAC,MAAM,CAAC;QACtD,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC;QAExC,MAAM,iBAAiB,GAAG,yCAAwB,CAAC,MAAM,CAAC;QAC1D,QAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC;QAE1C,MAAM,eAAe,GAAG,yCAAsB,CAAC,MAAM,CAAC;QACtD,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC;QAExC,2BAAK,GAAG;6BACN,eAAe;+BACf,iBAAiB;6BACjB,eAAe;SAChB;KACF;IAED,OAAO,2BAAK,CAAA;CACb;;;;;;;AC5CM,MAAM,yCAAc,GAAG,CAAC,MAA0B,GAAK;IAC5D,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,GAAG,GAAG,IAAI,MAAM,GAAG,GAAG,EAChD,OAAO,KAAK,CAAA;IAEd,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;IAC5C,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CAAA;CAC1B;AAWM,MAAM,yCAAgB,GAAG,CAAC,WAAmB,GAAK;IACvD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC;IACtC,OAAO,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;CACzD;;","sources":["packages/api/metrics/src/index.ts","packages/api/metrics/src/collectStartupMetrics.ts","packages/api/metrics/src/rpcMetricsFactory.ts","packages/api/metrics/src/rpcMetricsUtils.ts"],"sourcesContent":["export * from './collectStartupMetrics'\nexport * from './rpcMetricsFactory'\nexport * from './rpcMetricsUtils'\n","import { Gauge, Registry } from 'prom-client'\n\nexport const chainConfigFactory = (prefix: string) =>\n  new Gauge({\n    name: prefix + 'chain_config_info',\n    help: 'Default network and supported networks',\n    labelNames: ['default_chain', 'supported_chains'],\n    registers: [],\n  })\n\nexport const buildInfoFactory = (prefix: string) =>\n  new Gauge({\n    name: prefix + 'build_info',\n    help: 'Version, branch and commit of the current build',\n    labelNames: ['version', 'commit', 'branch'],\n    registers: [],\n  })\n\nexport type TrackStartupMetricsParameters = {\n  prefix: string\n  registry: Registry\n  defaultChain: string\n  supportedChains: string[]\n  version: string\n  commit: string\n  branch: string\n}\nexport const collectStartupMetrics = ({\n  prefix,\n  registry,\n  defaultChain,\n  supportedChains,\n  version,\n  commit,\n  branch,\n}: TrackStartupMetricsParameters) => {\n  const chainConfig = chainConfigFactory(prefix)\n  registry.registerMetric(chainConfig)\n  chainConfig.labels({ default_chain: defaultChain }).set(1)\n  supportedChains.forEach((chain) => {\n    chainConfig.labels({ supported_chains: chain }).set(1)\n  })\n\n  const buildInfo = buildInfoFactory(prefix)\n  registry.registerMetric(buildInfo)\n  buildInfo.labels(version, commit, branch).set(1)\n}\n","import { Counter, Histogram, Registry } from 'prom-client'\n\nexport const rpcRequestCountFactory = (prefix: string) =>\n  new Counter({\n    name: prefix + 'rpc_service_request_count',\n    help: 'RPC service request count',\n    labelNames: ['chainId', 'provider'],\n    registers: [],\n  })\n\nexport const rpcResponseTimeFactory = (prefix: string) =>\n  new Histogram({\n    name: prefix + 'rpc_service_response_time',\n    help: 'RPC service response time seconds',\n    buckets: [0.1, 0.2, 0.3, 0.6, 1, 1.5, 2, 5],\n    labelNames: ['chainId', 'provider', 'status'],\n    registers: [],\n  })\n\nexport const rpcRequestMethodsFactory = (prefix: string) =>\n  new Counter({\n    name: prefix + 'rpc_service_request_methods',\n    help: 'RPC service request methods',\n    labelNames: ['method'],\n    registers: [],\n  })\n\nlet cache: {\n  rpcRequestCount: ReturnType<typeof rpcRequestCountFactory>\n  rpcRequestMethods: ReturnType<typeof rpcRequestMethodsFactory>\n  rpcResponseTime: ReturnType<typeof rpcResponseTimeFactory>\n} | null = null\n\nexport const rpcMetricsFactory = (prefix: string, registry: Registry) => {\n  if (cache == null) {\n    const rpcRequestCount = rpcRequestCountFactory(prefix)\n    registry.registerMetric(rpcRequestCount)\n\n    const rpcRequestMethods = rpcRequestMethodsFactory(prefix)\n    registry.registerMetric(rpcRequestMethods)\n\n    const rpcResponseTime = rpcResponseTimeFactory(prefix)\n    registry.registerMetric(rpcResponseTime)\n\n    cache = {\n      rpcRequestCount,\n      rpcRequestMethods,\n      rpcResponseTime,\n    }\n  }\n\n  return cache\n}\n","/*\n * We need to limit how many statuses reported to prometheus, because of cardinality\n *\n * Examples:\n * getStatusLabel(200) => '2xx'\n * getStatusLabel(404) => '4xx'\n * getStatusLabel(undefined) => 'xxx'\n */\nexport const getStatusLabel = (status: number | undefined) => {\n  if (status == null || status < 100 || status > 600) {\n    return 'xxx'\n  }\n  const majorStatus = Math.trunc(status / 100)\n  return `${majorStatus}xx`\n}\n\n/*\n * We also need to limit cardinality of provider labels reported to prometheus, but here\n * we don't need to check if provider is included in the list of available providers,\n * because we get provider from this list itself, but not from user.\n *\n * Examples:\n * getProviderLabel('https://eth-mainnet.alchemyapi.io/v2/...') => 'alchemyapi.io'\n * getProviderLabel('https://goerli.infura.io/v3/...') => 'infura.io'\n */\nexport const getProviderLabel = (providerURL: string) => {\n  const parsedUrl = new URL(providerURL)\n  return parsedUrl.hostname.split('.').slice(-2).join('.')\n}\n"],"names":[],"version":3,"file":"index.mjs.map","sourceRoot":"../../../../"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@lidofinance/api-metrics",
+  "description": "Common api metrics",
+  "repository": "git@github.com:lidofinance/lido-ui-blocks.git",
+  "license": "MIT",
+  "version": "0.0.2",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">= 16"
+  },
+  "source": "./src/index.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "parcel build",
+    "format": "prettier --check src",
+    "format:fix": "yarn format --write",
+    "types": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "prom-client": "^14.0.0"
+  },
+  "devDependencies": {
+    "@lidofinance/config-prettier": "0.0.1",
+    "prom-client": "^14.0.0"
+  }
+}