@theotherwillembotha/node-red-statsd 0.4.0

package/build/statsd/service/StatsdMetricsContainer.js

@@ -0,0 +1,293 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatsdMetricsContainer = exports.StatsdSummaryMetric = exports.StatsdHistogramMetric = exports.StatsdGaugeMetric = exports.StatsdCounterMetric = void 0;
+const node_red_plugincore_1 = require("@theotherwillembotha/node-red-plugincore");
+function getHotShots() { return require('hot-shots'); }
+// ******************************************************* //
+//                   Counter                               //
+// ******************************************************* //
+class StatsdCounterMetric extends node_red_plugincore_1.Metric {
+    constructor(client, metricKey, config) {
+        super(config);
+        this.value = 0;
+        this.subscribers = {};
+        this.client = client;
+        this.metricKey = metricKey;
+    }
+    inc() {
+        this.value++;
+        this.client.increment(this.metricKey);
+        const state = { value: this.value, labels: {} };
+        Object.values(this.subscribers).forEach(cb => cb(state));
+        return this;
+    }
+    reset() { this.value = 0; }
+    get() {
+        return Promise.resolve({ value: this.value, labels: {} });
+    }
+    subscribe(node, callback) {
+        this.subscribers[node.id()] = callback;
+    }
+    unsubscribe(node) {
+        delete this.subscribers[node.id()];
+    }
+}
+exports.StatsdCounterMetric = StatsdCounterMetric;
+// ******************************************************* //
+//                    Gauge                                 //
+// ******************************************************* //
+class StatsdGaugeMetric extends node_red_plugincore_1.Metric {
+    constructor(client, metricKey, config) {
+        super(config);
+        this.value = 0;
+        this.subscribers = {};
+        this.client = client;
+        this.metricKey = metricKey;
+    }
+    inc() {
+        this.value++;
+        this.client.gauge(this.metricKey, this.value);
+        this.notifySubscribers();
+        return this;
+    }
+    dec() {
+        this.value--;
+        this.client.gauge(this.metricKey, this.value);
+        this.notifySubscribers();
+        return this;
+    }
+    set(value) {
+        this.value = value;
+        this.client.gauge(this.metricKey, this.value);
+        this.notifySubscribers();
+        return this;
+    }
+    reset() {
+        this.value = 0;
+        this.client.gauge(this.metricKey, 0);
+    }
+    get() { return { value: this.value }; }
+    subscribe(node, callback) {
+        this.subscribers[node.id()] = callback;
+    }
+    unsubscribe(node) {
+        delete this.subscribers[node.id()];
+    }
+    notifySubscribers() {
+        const state = { value: this.value };
+        Object.values(this.subscribers).forEach(cb => cb(state));
+    }
+}
+exports.StatsdGaugeMetric = StatsdGaugeMetric;
+// ******************************************************* //
+//                  Histogram                              //
+// ******************************************************* //
+class StatsdHistogramMetric extends node_red_plugincore_1.Metric {
+    constructor(client, metricKey, config) {
+        super(config);
+        this.sum = 0;
+        this.count = 0;
+        this.subscribers = {};
+        this.client = client;
+        this.metricKey = metricKey;
+    }
+    observe(value) {
+        this.sum += value;
+        this.count++;
+        this.client.timing(this.metricKey, value);
+        const state = { average: () => this.count > 0 ? this.sum / this.count : undefined };
+        Object.values(this.subscribers).forEach(cb => cb(state));
+    }
+    reset() {
+        this.sum = 0;
+        this.count = 0;
+    }
+    subscribe(node, callback) {
+        this.subscribers[node.id()] = callback;
+    }
+    unsubscribe(node) {
+        delete this.subscribers[node.id()];
+    }
+}
+exports.StatsdHistogramMetric = StatsdHistogramMetric;
+// ******************************************************* //
+//                   Summary                               //
+// ******************************************************* //
+class StatsdSummaryMetric extends node_red_plugincore_1.Metric {
+    constructor(client, metricKey, config) {
+        super(config);
+        this.sum = 0;
+        this.count = 0;
+        this.subscribers = {};
+        this.client = client;
+        this.metricKey = metricKey;
+    }
+    observe(value) {
+        this.sum += value;
+        this.count++;
+        // StatsD has no native summary type; use timing as the closest equivalent
+        this.client.timing(this.metricKey, value);
+        const state = { average: () => this.count > 0 ? this.sum / this.count : undefined };
+        Object.values(this.subscribers).forEach(cb => cb(state));
+    }
+    reset() {
+        this.sum = 0;
+        this.count = 0;
+    }
+    subscribe(node, callback) {
+        this.subscribers[node.id()] = callback;
+    }
+    unsubscribe(node) {
+        delete this.subscribers[node.id()];
+    }
+}
+exports.StatsdSummaryMetric = StatsdSummaryMetric;
+class StatsdMetricsContainer extends node_red_plugincore_1.MetricsContainer {
+    constructor(config) {
+        super();
+        this.counters = {};
+        this.gauges = {};
+        this.histograms = {};
+        this.summaries = {};
+        this._config = config;
+        const StatsD = getHotShots().StatsD;
+        this._client = new StatsD({
+            host: config.host,
+            port: config.port,
+            prefix: config.prefix || undefined,
+            protocol: config.protocol || "udp",
+            errorHandler: (err) => {
+                console.error("StatsD client error:", String(err));
+            },
+        });
+    }
+    supports(capability) { return true; }
+    hasChanged(config) {
+        const c = config;
+        return !(this._config.host === c.host &&
+            this._config.port === c.port &&
+            this._config.prefix === c.prefix &&
+            this._config.protocol === c.protocol);
+    }
+    close() {
+        if (this._client) {
+            this._client.close();
+            this._client = null;
+        }
+        this.counters = {};
+        this.gauges = {};
+        this.histograms = {};
+        this.summaries = {};
+    }
+    client() { return this._client; }
+    counter(config) {
+        const id = `counter_${config.id}`;
+        if (!this.counters[id]) {
+            this.counters[id] = new StatsdCounterMetric(this._client, id, config);
+        }
+        return this.counters[id];
+    }
+    gauge(config) {
+        const id = `gauge_${config.id}`;
+        if (!this.gauges[id]) {
+            this.gauges[id] = new StatsdGaugeMetric(this._client, id, config);
+        }
+        return this.gauges[id];
+    }
+    histogram(config) {
+        const id = `histogram_${config.id}`;
+        if (!this.histograms[id]) {
+            this.histograms[id] = new StatsdHistogramMetric(this._client, id, config);
+        }
+        return this.histograms[id];
+    }
+    summary(config) {
+        const id = `summary_${config.id}`;
+        if (!this.summaries[id]) {
+            this.summaries[id] = new StatsdSummaryMetric(this._client, id, config);
+        }
+        return this.summaries[id];
+    }
+    createTimer(metricConfig, fragmentData) {
+        const pattern = fragmentData.metricKey || "{{metric}}.{{name}}";
+        const metricKey = StatsdMetricsContainer.resolvePattern(pattern, metricConfig);
+        const histogramConfig = {
+            ...metricConfig,
+            type: "Histogram",
+            buckettype: node_red_plugincore_1.BucketType.default,
+            bucketconfig: {},
+        };
+        const id = `timer_${metricConfig.id}`;
+        if (!this.histograms[id]) {
+            this.histograms[id] = new StatsdHistogramMetric(this._client, metricKey, histogramConfig);
+        }
+        return this.histograms[id];
+    }
+    createCounter(metricConfig, fragmentData) {
+        const pattern = fragmentData.metricKey || "{{metric}}.{{name}}";
+        const metricKey = StatsdMetricsContainer.resolvePattern(pattern, metricConfig);
+        const counterConfig = {
+            ...metricConfig,
+            type: "Counter",
+        };
+        const id = `counter_${metricConfig.id}`;
+        if (!this.counters[id]) {
+            this.counters[id] = new StatsdCounterMetric(this._client, metricKey, counterConfig);
+        }
+        return this.counters[id];
+    }
+    createGauge(metricConfig, fragmentData) {
+        const pattern = fragmentData.metricKey || "{{metric}}.{{name}}";
+        const metricKey = StatsdMetricsContainer.resolvePattern(pattern, metricConfig);
+        const gaugeConfig = {
+            ...metricConfig,
+            type: "Gauge",
+        };
+        const id = `gauge_${metricConfig.id}`;
+        if (!this.gauges[id]) {
+            this.gauges[id] = new StatsdGaugeMetric(this._client, metricKey, gaugeConfig);
+        }
+        return this.gauges[id];
+    }
+    /**
+     * Resolves a metric key pattern using flat MetricConfig fields.
+     * All labels are fixed at creation time — no dynamic resolution needed.
+     */
+    static resolvePattern(pattern, config) {
+        return pattern
+            .replace(/\{\{type\}\}/g, config.type)
+            .replace(/\{\{id\}\}/g, config.id)
+            .replace(/\{\{metric\}\}/g, config.metric)
+            .replace(/\{\{flow\}\}/g, config.flow)
+            .replace(/\{\{name\}\}/g, config.name);
+    }
+    static registerFragments() {
+        const timerHtml = require('../fragments/StatsdTimerFragment.html');
+        node_red_plugincore_1.ConfigFragmentService.registerFragment({
+            section: 'TimerMetricConfig',
+            providerType: 'StatsdMetricsConfigNode',
+            html: timerHtml,
+        });
+        const counterHtml = require('../fragments/StatsdCounterFragment.html');
+        node_red_plugincore_1.ConfigFragmentService.registerFragment({
+            section: 'CounterMetricConfig',
+            providerType: 'StatsdMetricsConfigNode',
+            html: counterHtml,
+        });
+        const gaugeHtml = require('../fragments/StatsdGaugeFragment.html');
+        node_red_plugincore_1.ConfigFragmentService.registerFragment({
+            section: 'GaugeMetricConfig',
+            providerType: 'StatsdMetricsConfigNode',
+            html: gaugeHtml,
+        });
+    }
+}
+exports.StatsdMetricsContainer = StatsdMetricsContainer;
+// Register at module load time. Wrapped in try-catch because during
+// generate-nodes (pre-esbuild), the .html require fails.
+try {
+    StatsdMetricsContainer.registerFragments();
+}
+catch (_e) {
+    // Expected during build time
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@theotherwillembotha/node-red-statsd",
+  "version": "0.4.0",
+  "description": "StatsD metrics provider plugin for node-red-plugincore.",
+  "author": "Willem Botha (@theotherwillembotha)",
+  "license": "ISC",
+  "keywords": [
+    "node-red",
+    "metrics",
+    "statsd"
+  ],
+  "main": "./build/index.js",
+  "exports": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepare": "npm run build",
+    "clean": "rm -rf ./build && rm -rf ./resources",
+    "build": "npm run clean && tsc && npm run copy-fragments && npm run generate-nodes && npm run bundle && npm run copy-files",
+    "generate-nodes": "node build/GenerateNodes.js",
+    "copy-fragments": "find src -name '*.html' -path '*/fragments/*' | while read f; do mkdir -p \"build/$(dirname \"${f#src/}\")\" && cp \"$f\" \"build/${f#src/}\"; done",
+    "bundle": "node esbuild.js",
+    "copy-files": "cp -r ./icons ./build 2>/dev/null || true && mkdir -p ./resources && cp -r ./build/resources/. ./resources/ 2>/dev/null || true"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theotherwillembotha/nodered_statsd.git"
+  },
+  "files": ["build/", "icons/", "documentation/", "LICENSE", "README.md"],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18",
+    "nodered": ">=4.0.0"
+  },
+  "dependencies": {
+    "@theotherwillembotha/node-red-plugincore": "^0.4.2"
+  },
+  "devDependencies": {
+    "@theotherwillembotha/node-red-plugincore": "../nodered_plugincore",
+    "@types/deep-equal": "^1.0.4",
+    "@types/node": "^26.1.1",
+    "@types/node-red": "~1.3.5",
+    "deep-equal": "^2.2.3",
+    "esbuild": "^0.24.0",
+    "hot-shots": "^10.2.1",
+    "typescript": "^5.8.3"
+  },
+  "node-red": {
+    "version": ">=4.0.0",
+    "nodes": {
+      "statsd": "./build/Nodes.js"
+    },
+    "plugins": {
+      "statsd": "./build/Plugins.js"
+    }
+  }
+}