moleculer/src/metrics/types/base.d.ts

Fast & powerful microservices framework for Node.JS

import type MetricRegistry = require("../registry");

declare namespace BaseMetric {
	export interface BaseMetricOptions {
		type: string;
		name: string;
		description?: string;
		labelNames?: string[];
		unit?: string;
		aggregator?: string;
	}

	export interface BaseMetricPOJO<TSnapshot extends Record<string, any>> {
		type: string;
		name: string;
		description?: string;
		labelNames: string[];
		unit?: string;
		values: Map<string, TSnapshot>;
	}
}

declare abstract class BaseMetric<TSnapshot extends Record<string, any>> {
	registry: MetricRegistry;

	type: string;
	name: string;
	description?: string;
	labelNames: string[];
	unit?: string;
	aggregator: string;

	lastSnapshot: Record<string, any> | null;
	dirty: boolean;

	values: Map<string, Record<string, any>>;

	constructor(opts: BaseMetric.BaseMetricOptions, registry: MetricRegistry);

	setDirty(): void;

	clearDirty(): void;

	get(labels?: Record<string, any>): Record<string, any> | null;

	abstract reset(labels?: Record<string, any>, timestamp?: number): void;

	abstract resetAll(timestamp?: number): void;

	clear(): void;

	hashingLabels(labels?: Record<string, any>): string;

	snapshot(): TSnapshot[];

	abstract generateSnapshot(): TSnapshot[];

	changed(value?: any | null, labels?: Record<string, any>, timestamp?: number): void;

	toObject(): BaseMetric.BaseMetricPOJO<TSnapshot>;
}
export = BaseMetric;