moleculer/src/metrics/types/base.js

Fast & powerful microservices framework for Node.JS

/*
 * moleculer
 * Copyright (c) 2023 MoleculerJS (https://github.com/moleculerjs/moleculer)
 * MIT Licensed
 */

/* eslint-disable no-unused-vars */

"use strict";

/**
 * Import types
 *
 * @typedef {import("../registry")} MetricRegistry
 * @typedef {import("./base")} BaseMetricClass
 * @typedef {import("./base").BaseMetricOptions} BaseMetricOptions
 */

/**
 * Abstract Base Metric class.
 *
 * @class BaseMetric
 * @implements {BaseMetricClass}
 */
class BaseMetric {
	/**
	 * Creates an instance of BaseMetric.
	 *
	 * @param {BaseMetricOptions} opts
	 * @param {MetricRegistry} registry
	 * @memberof BaseMetric
	 */
	constructor(opts, registry) {
		this.registry = registry;
		this.type = opts.type;
		this.name = opts.name;
		this.description = opts.description;
		this.labelNames = opts.labelNames || [];
		this.unit = opts.unit;
		this.aggregator = opts.aggregator || registry.opts.defaultAggregator;

		this.lastSnapshot = null;
		this.dirty = true;

		this.values = new Map();
	}

	/**
	 * Set dirty flag
	 *
	 * @memberof BaseMetric
	 */
	setDirty() {
		this.dirty = true;
	}

	/**
	 * Clear dirty flag
	 *
	 * @memberof BaseMetric
	 */
	clearDirty() {
		this.dirty = false;
	}

	/**
	 * Get metric item by labels
	 *
	 * @param {Object?} labels
	 * @returns {Object}
	 * @memberof BaseMetric
	 */
	get(labels) {
		const hash = this.hashingLabels(labels);
		return this.values.get(hash);
	}

	/**
	 * Reset item by labels
	 *
	 * @param {Object?} labels
	 * @param {Number?} timestamp
	 *
	 * @memberof BaseMetric
	 */
	reset(labels, timestamp) {
		/* istanbul ignore next */
		throw new Error("Not implemented");
	}

	/**
	 * Reset all items
	 *
	 * @param {Number?} timestamp
	 * @memberof BaseMetric
	 */
	resetAll(timestamp) {
		/* istanbul ignore next */
		throw new Error("Not implemented");
	}

	/**
	 * Clear metric values.
	 *
	 * @memberof BaseMetric
	 */
	clear() {
		this.values = new Map();
		this.changed();
	}

	/**
	 * Create a hash from label values. It will
	 * be used as a key in Map.
	 *
	 * @param {Object} labels
	 * @returns {String}
	 * @memberof BaseMetric
	 */
	hashingLabels(labels) {
		if (this.labelNames.length == 0 || labels == null || typeof labels !== "object") return "";

		const parts = [];
		for (let i = 0; i < this.labelNames.length; i++) {
			const v = labels[this.labelNames[i]];
			if (typeof v == "number") parts.push(v);
			else if (typeof v === "string") parts.push('"' + v + '"');
			else if (typeof v === "boolean") parts.push("" + v);
			else parts.push("");
		}
		return parts.join("|");
	}

	/**
	 * Get a snapshot.
	 *
	 * @returns {Object|null}
	 * @memberof BaseMetric
	 */
	snapshot() {
		if (!this.dirty && this.lastSnapshot) return this.lastSnapshot;

		this.lastSnapshot = this.generateSnapshot();
		this.clearDirty();

		return this.lastSnapshot;
	}

	/**
	 * Generate a snapshot.
	 *
	 * @returns {Array}
	 * @memberof BaseMetric
	 */
	generateSnapshot() {
		/* istanbul ignore next */
		throw new Error("Not implemented");
	}

	/**
	 * Metric has been changed.
	 * @param {any=} value
	 * @param {Object=} labels
	 * @param {Number=} timestamp
	 */
	changed(value, labels, timestamp) {
		this.setDirty();
		this.registry.changed(this, value, labels, timestamp);
	}

	/**
	 * Export to a POJO.
	 */
	toObject() {
		return {
			type: this.type,
			name: this.name,
			description: this.description,
			labelNames: this.labelNames,
			unit: this.unit,

			values: this.snapshot()
		};
	}
}

module.exports = BaseMetric;