@lodestar/utils 1.14.0-dev.d52fb94cbf → 1.14.0-dev.ea49409f51

package/lib/index.d.ts

@@ -8,6 +8,7 @@ export * from "./format.js";
 export * from "./logger.js";
 export * from "./map.js";
 export * from "./math.js";
+export * from "./metrics.js";
 export * from "./objects.js";
 export { retry, type RetryOptions } from "./retry.js";
 export * from "./notNullish.js";

package/lib/index.js

@@ -8,6 +8,7 @@ export * from "./format.js";
 export * from "./logger.js";
 export * from "./map.js";
 export * from "./math.js";
+export * from "./metrics.js";
 export * from "./objects.js";
 export { retry } from "./retry.js";
 export * from "./notNullish.js";

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAoB,MAAM,YAAY,CAAC;AACpD,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAwB,OAAO,EAAC,MAAM,YAAY,CAAC;AAC1D,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAoB,MAAM,YAAY,CAAC;AACpD,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAwB,OAAO,EAAC,MAAM,YAAY,CAAC;AAC1D,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC"}

package/lib/metrics.d.ts

@@ -0,0 +1,57 @@
+export type NoLabels = Record<string, never>;
+export type LabelsGeneric = Record<string, string | number>;
+export type LabelKeys<Labels extends LabelsGeneric> = Extract<keyof Labels, string>;
+export type CollectFn<Labels extends LabelsGeneric> = (metric: Gauge<Labels>) => void;
+export interface Gauge<Labels extends LabelsGeneric = NoLabels> {
+    inc: NoLabels extends Labels ? (value?: number) => void : (labels: Labels, value?: number) => void;
+    dec: NoLabels extends Labels ? (value?: number) => void : (labels: Labels, value?: number) => void;
+    set: NoLabels extends Labels ? (value: number) => void : (labels: Labels, value: number) => void;
+    collect?(): void;
+}
+export interface GaugeExtra<Labels extends LabelsGeneric = NoLabels> extends Omit<Gauge<Labels>, "collect"> {
+    addCollect(collectFn: CollectFn<Labels>): void;
+}
+export interface Histogram<Labels extends LabelsGeneric = NoLabels> {
+    startTimer(): NoLabels extends Labels ? () => number : (labels: Labels) => number;
+    startTimer<L extends Partial<Labels>>(labels?: NoLabels extends Labels ? never : L): keyof Omit<Labels, keyof L> extends never ? () => number : (labels: Omit<Labels, keyof L>) => number;
+    observe: NoLabels extends Labels ? (value: number) => void : (labels: Labels, value: number) => void;
+    reset(): void;
+}
+export interface AvgMinMax<Labels extends LabelsGeneric = NoLabels> {
+    addGetValuesFn(getValuesFn: () => number[]): void;
+    set: NoLabels extends Labels ? (values: number[]) => void : (labels: Labels, values: number[]) => void;
+}
+export interface Counter<Labels extends LabelsGeneric = NoLabels> {
+    inc: NoLabels extends Labels ? (value?: number) => void : (labels: Labels, value?: number) => void;
+}
+export type GaugeConfig<Labels extends LabelsGeneric> = {
+    name: string;
+    help: string;
+} & (NoLabels extends Labels ? {
+    labelNames?: never;
+} : {
+    labelNames: [LabelKeys<Labels>, ...LabelKeys<Labels>[]];
+});
+export type HistogramConfig<Labels extends LabelsGeneric> = GaugeConfig<Labels> & {
+    buckets?: number[];
+};
+export type AvgMinMaxConfig<Labels extends LabelsGeneric> = GaugeConfig<Labels>;
+export type CounterConfig<Labels extends LabelsGeneric> = GaugeConfig<Labels>;
+export type StaticConfig<Labels extends LabelsGeneric> = {
+    name: GaugeConfig<Labels>["name"];
+    help: GaugeConfig<Labels>["help"];
+    value: Record<LabelKeys<Labels>, string>;
+};
+export interface MetricsRegister {
+    gauge<Labels extends LabelsGeneric = NoLabels>(config: GaugeConfig<Labels>): Gauge<Labels>;
+    histogram<Labels extends LabelsGeneric = NoLabels>(config: HistogramConfig<Labels>): Histogram<Labels>;
+    counter<Labels extends LabelsGeneric = NoLabels>(config: CounterConfig<Labels>): Counter<Labels>;
+}
+export interface MetricsRegisterExtra extends MetricsRegister {
+    gauge<Labels extends LabelsGeneric = NoLabels>(config: GaugeConfig<Labels>): GaugeExtra<Labels>;
+}
+export interface MetricsRegisterCustom extends MetricsRegisterExtra {
+    avgMinMax<Labels extends LabelsGeneric = NoLabels>(config: AvgMinMaxConfig<Labels>): AvgMinMax<Labels>;
+    static<Labels extends LabelsGeneric = NoLabels>(config: StaticConfig<Labels>): void;
+}
+//# sourceMappingURL=metrics.d.ts.map

package/lib/metrics.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=metrics.js.map

package/lib/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../src/metrics.ts"],"names":[],"mappings":""}

package/package.json

@@ -11,7 +11,7 @@
   "bugs": {
     "url": "https://github.com/ChainSafe/lodestar/issues"
   },
-  "version": "1.14.0-dev.d52fb94cbf",
+  "version": "1.14.0-dev.ea49409f51",
   "type": "module",
   "exports": "./lib/index.js",
   "files": [
@@ -27,7 +27,7 @@
     "build:watch": "yarn run build --watch",
     "build:release": "yarn clean && yarn build",
     "check-build": "node -e \"(async function() { await import('./lib/index.js') })()\"",
-    "check-types": "tsc",
+    "check-types": "tsc && vitest --run --typecheck --dir test/types/",
     "lint": "eslint --color --ext .ts src/ test/",
     "lint:fix": "yarn run lint --fix",
     "pretest": "yarn run check-types",
@@ -50,6 +50,7 @@
   "devDependencies": {
     "@types/js-yaml": "^4.0.5",
     "@types/triple-beam": "^1.3.2",
+    "prom-client": "^15.1.0",
     "triple-beam": "^1.3.0"
   },
   "keywords": [
@@ -58,5 +59,5 @@
     "beacon",
     "blockchain"
   ],
-  "gitHead": "d2eb909e0d3ba23ab6b98fb62e8ba81a52f79b53"
+  "gitHead": "b4a1ba3d37844de16f97c1905575d4a06c878a25"
 }