@adalo/metrics 0.1.57 → 0.1.59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,6 +22,10 @@ export class QueueRedisMetricsClient extends RedisMetricsClient {
22
22
  * @returns {Promise<void>}
23
23
  */
24
24
  collectQueueMetrics: () => Promise<void>;
25
+ /**
26
+ * Cleanup queues and Redis client
27
+ */
28
+ cleanup: () => Promise<never>;
25
29
  }
26
30
  import { RedisMetricsClient } from "./metricsRedisClient";
27
31
  //# sourceMappingURL=metricsQueueRedisClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"metricsQueueRedisClient.d.ts","sourceRoot":"","sources":["../src/metricsQueueRedisClient.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IAgEI,wCAAsD;IACtD,iCAA0C;IAE1C,4DAA4D;IAC5D,0BAA2B;IAE3B,qCAAqC;IACrC,oDAIE;IAKJ;;;;OAIG;IACH,uCAHW,MAAM,KACJ,QAAQ,IAAI,CAAC,CAkDzB;IAED;;;OAGG;IACH,2BAFa,QAAQ,IAAI,CAAC,CAsCzB;CAmCF"}
1
+ {"version":3,"file":"metricsQueueRedisClient.d.ts","sourceRoot":"","sources":["../src/metricsQueueRedisClient.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IAgEI,wCAAsD;IACtD,iCAA0C;IAE1C,4DAA4D;IAC5D,0BAA2B;IAE3B,qCAAqC;IACrC,oDAIE;IAKJ;;;;OAIG;IACH,uCAHW,MAAM,KACJ,QAAQ,IAAI,CAAC,CAkDzB;IAED;;;OAGG;IACH,2BAFa,QAAQ,IAAI,CAAC,CAsCzB;IAsBD;;OAEG;IACH,8BASC;CACF"}
@@ -42,6 +42,7 @@ export class RedisMetricsClient extends MetricsClient {
42
42
  redisMemoryGauge: import("prom-client").Gauge<string>;
43
43
  /** Gauge for Redis operation stats */
44
44
  redisStatsGauge: import("prom-client").Gauge<string>;
45
+ getRedisInfo: (section: any) => Promise<any>;
45
46
  /**
46
47
  * Collect basic Redis INFO metrics: clients, memory, stats
47
48
  * @returns {Promise<void>}
@@ -57,6 +58,10 @@ export class RedisMetricsClient extends MetricsClient {
57
58
  * @param {number} [intervalSec=this.intervalSec] - Interval in seconds
58
59
  */
59
60
  startPush: (intervalSec?: number | undefined) => void;
61
+ /**
62
+ * Cleanup Redis client
63
+ */
64
+ cleanup: () => Promise<void>;
60
65
  }
61
66
  import { MetricsClient } from "./metricsClient";
62
67
  //# sourceMappingURL=metricsRedisClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"metricsRedisClient.d.ts","sourceRoot":"","sources":["../src/metricsRedisClient.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH;IACE;;;;;;;;;;;;;;OAcG;IACH;QAbwB,WAAW,EAAxB,GAAG;QACc,OAAO;QACP,MAAM;QACN,WAAW;QACV,OAAO;QACP,SAAS;QACV,cAAc;QACd,iBAAiB;QACjB,WAAW;QACV,gBAAgB;QAChB,mBAAmB;QAClB,iBAAiB;OAwC9C;IAzBC,oCAAoC;IACpC,iBAA8B;IAE9B,yCAAyC;IACzC,2DAIE;IAEF,mCAAmC;IACnC,sDAIE;IAEF,sCAAsC;IACtC,qDAIE;IAKJ;;;OAGG;IACH,2BAFa,QAAQ,IAAI,CAAC,CAiEzB;IAED;;;OAGG;IACH,wBAFa,QAAQ,IAAI,CAAC,CAoBzB;IAED;;;OAGG;IACH,sDAMC;CAkBF"}
1
+ {"version":3,"file":"metricsRedisClient.d.ts","sourceRoot":"","sources":["../src/metricsRedisClient.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH;IACE;;;;;;;;;;;;;;OAcG;IACH;QAbwB,WAAW,EAAxB,GAAG;QACc,OAAO;QACP,MAAM;QACN,WAAW;QACV,OAAO;QACP,SAAS;QACV,cAAc;QACd,iBAAiB;QACjB,WAAW;QACV,gBAAgB;QAChB,mBAAmB;QAClB,iBAAiB;OAwC9C;IAzBC,oCAAoC;IACpC,iBAA8B;IAE9B,yCAAyC;IACzC,2DAIE;IAEF,mCAAmC;IACnC,sDAIE;IAEF,sCAAsC;IACtC,qDAIE;IAKJ,6CAkBC;IAED;;;OAGG;IACH,2BAFa,QAAQ,IAAI,CAAC,CAyDzB;IAED;;;OAGG;IACH,wBAFa,QAAQ,IAAI,CAAC,CAoBzB;IAED;;;OAGG;IACH,sDAMC;IAED;;OAEG;IACH,6BAeC;CAMF"}
@@ -63,6 +63,23 @@ class RedisMetricsClient extends MetricsClient {
63
63
  });
64
64
  this._setCleanupHandlers();
65
65
  }
66
+ getRedisInfo = async section => {
67
+ if (!this.redisClient) throw new Error('Redis client not provided');
68
+ console.log("constructor name: ", this.redisClient.constructor.name); // :todo delete
69
+ if (typeof this.redisClient.info === 'function') {
70
+ if (this.redisClient.info.length === 1) {
71
+ // node-redis v3: uses callback
72
+ return new Promise((resolve, reject) => {
73
+ this.redisClient.info(section, (err, result) => {
74
+ if (err) reject(err);else resolve(result);
75
+ });
76
+ });
77
+ }
78
+ // node-redis v4 or ioredis: returns Promise
79
+ return this.redisClient.info(section);
80
+ }
81
+ throw new Error('Unsupported Redis client type');
82
+ };
66
83
 
67
84
  /**
68
85
  * Collect basic Redis INFO metrics: clients, memory, stats
@@ -70,12 +87,7 @@ class RedisMetricsClient extends MetricsClient {
70
87
  */
71
88
  collectRedisMetrics = async () => {
72
89
  try {
73
- const getRedisInfo = section => new Promise((resolve, reject) => {
74
- this.redisClient.info(section, (err, result) => {
75
- if (err) reject(err);else resolve(result);
76
- });
77
- });
78
- const [clientsInfo, memoryInfo, statsInfo] = await Promise.all([getRedisInfo('clients'), getRedisInfo('memory'), getRedisInfo('stats')]);
90
+ const [clientsInfo, memoryInfo, statsInfo] = await Promise.all([this.getRedisInfo('clients'), this.getRedisInfo('memory'), this.getRedisInfo('stats')]);
79
91
  const labels = this.getDefaultLabels();
80
92
  const parseRedisInfo = infoStr => Object.fromEntries(infoStr.split('\r\n').filter(line => line && !line.startsWith('#')).map(line => line.split(':', 2)).filter(parts => parts.length === 2 && parts[0] && parts[1]));
81
93
  const clients = parseRedisInfo(clientsInfo);
@@ -145,7 +157,14 @@ class RedisMetricsClient extends MetricsClient {
145
157
  */
146
158
  cleanup = async () => {
147
159
  try {
148
- this.redisClient?.quit();
160
+ if (!this.redisClient) return;
161
+ if (typeof this.redisClient.quit === 'function') {
162
+ // node-redis v3 or v4
163
+ await this.redisClient.quit();
164
+ } else if (typeof this.redisClient.disconnect === 'function') {
165
+ // ioredis
166
+ await this.redisClient.disconnect();
167
+ }
149
168
  } catch (err) {
150
169
  console.error('[redis-metrics] Error closing Redis client:', err);
151
170
  }
@@ -1 +1 @@
1
- {"version":3,"file":"metricsRedisClient.js","names":["MetricsClient","require","RedisMetricsClient","constructor","redisClient","metricsConfig","intervalSec","parseInt","process","env","METRICS_QUEUE_INTERVAL_SEC","scripDefaultMetrics","processType","redisConnectionsGauge","createGauge","name","help","labelNames","withDefaultLabels","redisMemoryGauge","redisStatsGauge","_setCleanupHandlers","collectRedisMetrics","getRedisInfo","section","Promise","resolve","reject","info","err","result","clientsInfo","memoryInfo","statsInfo","all","labels","getDefaultLabels","parseRedisInfo","infoStr","Object","fromEntries","split","filter","line","startsWith","map","parts","length","clients","memory","stats","connected_clients","set","connection_type","used_memory","memory_type","maxmemory","instantaneous_ops_per_sec","operation","error","console","warn","message","pushRedisMetrics","gatewayPush","metricsLogValues","metricObjects","registry","getMetricsAsJSON","JSON","stringify","startPush","_startPush","catch","cleanup","quit","exit","on","module","exports"],"sources":["../src/metricsRedisClient.js"],"sourcesContent":["const { MetricsClient } = require('.')\n\n/**\n * RedisMetricsClient extends MetricsClient to collect\n * Redis metrics periodically and push them to Prometheus Pushgateway.\n *\n * @extends MetricsClient\n */\nclass RedisMetricsClient extends MetricsClient {\n /**\n * @param {Object} options\n * @param {any} options.redisClient - Redis client instance (required)\n * @param {string} [options.appName] - Application name (from MetricsClient)\n * @param {string} [options.dynoId] - Dyno/instance ID (from MetricsClient)\n * @param {string} [options.processType] - Process type (from MetricsClient)\n * @param {boolean} [options.enabled] - Enable metrics collection (from MetricsClient)\n * @param {boolean} [options.logValues] - Log metrics values (from MetricsClient)\n * @param {string} [options.pushgatewayUrl] - PushGateway URL (from MetricsClient)\n * @param {string} [options.pushgatewaySecret] - PushGateway secret token (from MetricsClient)\n * @param {number} [options.intervalSec] - Interval in seconds for pushing metrics (from MetricsClient)\n * @param {boolean} [options.removeOldMetrics] - Remove old metrics by service (from MetricsClient)\n * @param {boolean} [options.scripDefaultMetrics] - Skip default metrics creation (from MetricsClient)\n * @param {function} [options.startupValidation] - Function to validate startup (from MetricsClient)\n */\n constructor({ redisClient, ...metricsConfig } = {}) {\n const intervalSec =\n metricsConfig.intervalSec ||\n parseInt(process.env.METRICS_QUEUE_INTERVAL_SEC || '', 10) ||\n 5\n\n super({\n ...metricsConfig,\n scripDefaultMetrics: true,\n processType: metricsConfig.processType || 'redis-metrics',\n intervalSec,\n })\n\n /** Redis client used for metrics */\n this.redisClient = redisClient\n\n /** Gauge for Redis client connections */\n this.redisConnectionsGauge = this.createGauge({\n name: 'app_redis_connections_count',\n help: 'Number of Redis client connections',\n labelNames: this.withDefaultLabels(['connection_type']),\n })\n\n /** Gauge for Redis memory usage */\n this.redisMemoryGauge = this.createGauge({\n name: 'app_redis_memory_bytes',\n help: 'Redis memory usage in bytes',\n labelNames: this.withDefaultLabels(['memory_type']),\n })\n\n /** Gauge for Redis operation stats */\n this.redisStatsGauge = this.createGauge({\n name: 'app_redis_stats_total',\n help: 'Redis operation statistics',\n labelNames: this.withDefaultLabels(['operation']),\n })\n\n this._setCleanupHandlers()\n }\n\n /**\n * Collect basic Redis INFO metrics: clients, memory, stats\n * @returns {Promise<void>}\n */\n collectRedisMetrics = async () => {\n try {\n const getRedisInfo = section =>\n new Promise((resolve, reject) => {\n this.redisClient.info(section, (err, result) => {\n if (err) reject(err)\n else resolve(result)\n })\n })\n\n const [clientsInfo, memoryInfo, statsInfo] = await Promise.all([\n getRedisInfo('clients'),\n getRedisInfo('memory'),\n getRedisInfo('stats'),\n ])\n\n const labels = this.getDefaultLabels()\n\n const parseRedisInfo = infoStr =>\n Object.fromEntries(\n infoStr\n .split('\\r\\n')\n .filter(line => line && !line.startsWith('#'))\n .map(line => line.split(':', 2))\n .filter(parts => parts.length === 2 && parts[0] && parts[1])\n )\n\n const clients = parseRedisInfo(clientsInfo)\n const memory = parseRedisInfo(memoryInfo)\n const stats = parseRedisInfo(statsInfo)\n\n if (clients.connected_clients) {\n this.redisConnectionsGauge.set(\n { ...labels, connection_type: 'connected' },\n parseInt(clients.connected_clients, 10) || 0\n )\n }\n\n if (memory.used_memory) {\n this.redisMemoryGauge.set(\n { ...labels, memory_type: 'used' },\n parseInt(memory.used_memory, 10) || 0\n )\n }\n if (memory.maxmemory) {\n this.redisMemoryGauge.set(\n { ...labels, memory_type: 'max' },\n parseInt(memory.maxmemory, 10) || 0\n )\n }\n\n if (stats.instantaneous_ops_per_sec) {\n this.redisStatsGauge.set(\n { ...labels, operation: 'ops_per_sec' },\n parseInt(stats.instantaneous_ops_per_sec, 10) || 0\n )\n }\n } catch (error) {\n console.warn(\n `[redis-metrics] Failed to collect Redis metrics:`,\n error.message\n )\n }\n }\n\n /**\n * Collect metrics for all Redis and push to Prometheus Pushgateway\n * @returns {Promise<void>}\n */\n pushRedisMetrics = async () => {\n try {\n await this.collectRedisMetrics()\n await this.gatewayPush()\n\n if (this.metricsLogValues) {\n const metricObjects = await this.registry.getMetricsAsJSON()\n console.info(\n `[redis-metrics] Collected metrics for Redis`,\n JSON.stringify(metricObjects, null, 2)\n )\n }\n } catch (error) {\n console.error(\n `[redis-metrics] Failed to collect Redis metrics: ${error.message}`\n )\n throw error\n }\n }\n\n /**\n * Start periodic collection.\n * @param {number} [intervalSec=this.intervalSec] - Interval in seconds\n */\n startPush = (intervalSec = this.intervalSec) => {\n this._startPush(intervalSec, () => {\n this.pushRedisMetrics().catch(err => {\n console.error(`[redis-metrics] Failed to push Redis metrics:`, err)\n })\n })\n }\n\n /**\n * Cleanup Redis client\n */\n cleanup = async () => {\n try {\n this.redisClient?.quit()\n } catch (err) {\n console.error('[redis-metrics] Error closing Redis client:', err)\n }\n process.exit(0)\n }\n\n _setCleanupHandlers = () => {\n process.on('SIGINT', this.cleanup)\n process.on('SIGTERM', this.cleanup)\n }\n}\n\nmodule.exports = { RedisMetricsClient }\n"],"mappings":";;AAAA,MAAM;EAAEA;AAAc,CAAC,GAAGC,OAAO,CAAC,GAAG,CAAC;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,kBAAkB,SAASF,aAAa,CAAC;EAC7C;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEG,WAAWA,CAAC;IAAEC,WAAW;IAAE,GAAGC;EAAc,CAAC,GAAG,CAAC,CAAC,EAAE;IAClD,MAAMC,WAAW,GACfD,aAAa,CAACC,WAAW,IACzBC,QAAQ,CAACC,OAAO,CAACC,GAAG,CAACC,0BAA0B,IAAI,EAAE,EAAE,EAAE,CAAC,IAC1D,CAAC;IAEH,KAAK,CAAC;MACJ,GAAGL,aAAa;MAChBM,mBAAmB,EAAE,IAAI;MACzBC,WAAW,EAAEP,aAAa,CAACO,WAAW,IAAI,eAAe;MACzDN;IACF,CAAC,CAAC;;IAEF;IACA,IAAI,CAACF,WAAW,GAAGA,WAAW;;IAE9B;IACA,IAAI,CAACS,qBAAqB,GAAG,IAAI,CAACC,WAAW,CAAC;MAC5CC,IAAI,EAAE,6BAA6B;MACnCC,IAAI,EAAE,oCAAoC;MAC1CC,UAAU,EAAE,IAAI,CAACC,iBAAiB,CAAC,CAAC,iBAAiB,CAAC;IACxD,CAAC,CAAC;;IAEF;IACA,IAAI,CAACC,gBAAgB,GAAG,IAAI,CAACL,WAAW,CAAC;MACvCC,IAAI,EAAE,wBAAwB;MAC9BC,IAAI,EAAE,6BAA6B;MACnCC,UAAU,EAAE,IAAI,CAACC,iBAAiB,CAAC,CAAC,aAAa,CAAC;IACpD,CAAC,CAAC;;IAEF;IACA,IAAI,CAACE,eAAe,GAAG,IAAI,CAACN,WAAW,CAAC;MACtCC,IAAI,EAAE,uBAAuB;MAC7BC,IAAI,EAAE,4BAA4B;MAClCC,UAAU,EAAE,IAAI,CAACC,iBAAiB,CAAC,CAAC,WAAW,CAAC;IAClD,CAAC,CAAC;IAEF,IAAI,CAACG,mBAAmB,CAAC,CAAC;EAC5B;;EAEA;AACF;AACA;AACA;EACEC,mBAAmB,GAAG,MAAAA,CAAA,KAAY;IAChC,IAAI;MACF,MAAMC,YAAY,GAAGC,OAAO,IAC1B,IAAIC,OAAO,CAAC,CAACC,OAAO,EAAEC,MAAM,KAAK;QAC/B,IAAI,CAACvB,WAAW,CAACwB,IAAI,CAACJ,OAAO,EAAE,CAACK,GAAG,EAAEC,MAAM,KAAK;UAC9C,IAAID,GAAG,EAAEF,MAAM,CAACE,GAAG,CAAC,MACfH,OAAO,CAACI,MAAM,CAAC;QACtB,CAAC,CAAC;MACJ,CAAC,CAAC;MAEJ,MAAM,CAACC,WAAW,EAAEC,UAAU,EAAEC,SAAS,CAAC,GAAG,MAAMR,OAAO,CAACS,GAAG,CAAC,CAC7DX,YAAY,CAAC,SAAS,CAAC,EACvBA,YAAY,CAAC,QAAQ,CAAC,EACtBA,YAAY,CAAC,OAAO,CAAC,CACtB,CAAC;MAEF,MAAMY,MAAM,GAAG,IAAI,CAACC,gBAAgB,CAAC,CAAC;MAEtC,MAAMC,cAAc,GAAGC,OAAO,IAC5BC,MAAM,CAACC,WAAW,CAChBF,OAAO,CACJG,KAAK,CAAC,MAAM,CAAC,CACbC,MAAM,CAACC,IAAI,IAAIA,IAAI,IAAI,CAACA,IAAI,CAACC,UAAU,CAAC,GAAG,CAAC,CAAC,CAC7CC,GAAG,CAACF,IAAI,IAAIA,IAAI,CAACF,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAC/BC,MAAM,CAACI,KAAK,IAAIA,KAAK,CAACC,MAAM,KAAK,CAAC,IAAID,KAAK,CAAC,CAAC,CAAC,IAAIA,KAAK,CAAC,CAAC,CAAC,CAC/D,CAAC;MAEH,MAAME,OAAO,GAAGX,cAAc,CAACN,WAAW,CAAC;MAC3C,MAAMkB,MAAM,GAAGZ,cAAc,CAACL,UAAU,CAAC;MACzC,MAAMkB,KAAK,GAAGb,cAAc,CAACJ,SAAS,CAAC;MAEvC,IAAIe,OAAO,CAACG,iBAAiB,EAAE;QAC7B,IAAI,CAACtC,qBAAqB,CAACuC,GAAG,CAC5B;UAAE,GAAGjB,MAAM;UAAEkB,eAAe,EAAE;QAAY,CAAC,EAC3C9C,QAAQ,CAACyC,OAAO,CAACG,iBAAiB,EAAE,EAAE,CAAC,IAAI,CAC7C,CAAC;MACH;MAEA,IAAIF,MAAM,CAACK,WAAW,EAAE;QACtB,IAAI,CAACnC,gBAAgB,CAACiC,GAAG,CACvB;UAAE,GAAGjB,MAAM;UAAEoB,WAAW,EAAE;QAAO,CAAC,EAClChD,QAAQ,CAAC0C,MAAM,CAACK,WAAW,EAAE,EAAE,CAAC,IAAI,CACtC,CAAC;MACH;MACA,IAAIL,MAAM,CAACO,SAAS,EAAE;QACpB,IAAI,CAACrC,gBAAgB,CAACiC,GAAG,CACvB;UAAE,GAAGjB,MAAM;UAAEoB,WAAW,EAAE;QAAM,CAAC,EACjChD,QAAQ,CAAC0C,MAAM,CAACO,SAAS,EAAE,EAAE,CAAC,IAAI,CACpC,CAAC;MACH;MAEA,IAAIN,KAAK,CAACO,yBAAyB,EAAE;QACnC,IAAI,CAACrC,eAAe,CAACgC,GAAG,CACtB;UAAE,GAAGjB,MAAM;UAAEuB,SAAS,EAAE;QAAc,CAAC,EACvCnD,QAAQ,CAAC2C,KAAK,CAACO,yBAAyB,EAAE,EAAE,CAAC,IAAI,CACnD,CAAC;MACH;IACF,CAAC,CAAC,OAAOE,KAAK,EAAE;MACdC,OAAO,CAACC,IAAI,CACV,kDAAkD,EAClDF,KAAK,CAACG,OACR,CAAC;IACH;EACF,CAAC;;EAED;AACF;AACA;AACA;EACEC,gBAAgB,GAAG,MAAAA,CAAA,KAAY;IAC7B,IAAI;MACF,MAAM,IAAI,CAACzC,mBAAmB,CAAC,CAAC;MAChC,MAAM,IAAI,CAAC0C,WAAW,CAAC,CAAC;MAExB,IAAI,IAAI,CAACC,gBAAgB,EAAE;QACzB,MAAMC,aAAa,GAAG,MAAM,IAAI,CAACC,QAAQ,CAACC,gBAAgB,CAAC,CAAC;QAC5DR,OAAO,CAAChC,IAAI,CACV,6CAA6C,EAC7CyC,IAAI,CAACC,SAAS,CAACJ,aAAa,EAAE,IAAI,EAAE,CAAC,CACvC,CAAC;MACH;IACF,CAAC,CAAC,OAAOP,KAAK,EAAE;MACdC,OAAO,CAACD,KAAK,CACX,oDAAoDA,KAAK,CAACG,OAAO,EACnE,CAAC;MACD,MAAMH,KAAK;IACb;EACF,CAAC;;EAED;AACF;AACA;AACA;EACEY,SAAS,GAAGA,CAACjE,WAAW,GAAG,IAAI,CAACA,WAAW,KAAK;IAC9C,IAAI,CAACkE,UAAU,CAAClE,WAAW,EAAE,MAAM;MACjC,IAAI,CAACyD,gBAAgB,CAAC,CAAC,CAACU,KAAK,CAAC5C,GAAG,IAAI;QACnC+B,OAAO,CAACD,KAAK,CAAC,+CAA+C,EAAE9B,GAAG,CAAC;MACrE,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ,CAAC;;EAED;AACF;AACA;EACE6C,OAAO,GAAG,MAAAA,CAAA,KAAY;IACpB,IAAI;MACF,IAAI,CAACtE,WAAW,EAAEuE,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC,OAAO9C,GAAG,EAAE;MACZ+B,OAAO,CAACD,KAAK,CAAC,6CAA6C,EAAE9B,GAAG,CAAC;IACnE;IACArB,OAAO,CAACoE,IAAI,CAAC,CAAC,CAAC;EACjB,CAAC;EAEDvD,mBAAmB,GAAGA,CAAA,KAAM;IAC1Bb,OAAO,CAACqE,EAAE,CAAC,QAAQ,EAAE,IAAI,CAACH,OAAO,CAAC;IAClClE,OAAO,CAACqE,EAAE,CAAC,SAAS,EAAE,IAAI,CAACH,OAAO,CAAC;EACrC,CAAC;AACH;AAEAI,MAAM,CAACC,OAAO,GAAG;EAAE7E;AAAmB,CAAC","ignoreList":[]}
1
+ {"version":3,"file":"metricsRedisClient.js","names":["MetricsClient","require","RedisMetricsClient","constructor","redisClient","metricsConfig","intervalSec","parseInt","process","env","METRICS_QUEUE_INTERVAL_SEC","scripDefaultMetrics","processType","redisConnectionsGauge","createGauge","name","help","labelNames","withDefaultLabels","redisMemoryGauge","redisStatsGauge","_setCleanupHandlers","getRedisInfo","section","Error","console","log","info","length","Promise","resolve","reject","err","result","collectRedisMetrics","clientsInfo","memoryInfo","statsInfo","all","labels","getDefaultLabels","parseRedisInfo","infoStr","Object","fromEntries","split","filter","line","startsWith","map","parts","clients","memory","stats","connected_clients","set","connection_type","used_memory","memory_type","maxmemory","instantaneous_ops_per_sec","operation","error","warn","message","pushRedisMetrics","gatewayPush","metricsLogValues","metricObjects","registry","getMetricsAsJSON","JSON","stringify","startPush","_startPush","catch","cleanup","quit","disconnect","exit","on","module","exports"],"sources":["../src/metricsRedisClient.js"],"sourcesContent":["const { MetricsClient } = require('.')\n\n/**\n * RedisMetricsClient extends MetricsClient to collect\n * Redis metrics periodically and push them to Prometheus Pushgateway.\n *\n * @extends MetricsClient\n */\nclass RedisMetricsClient extends MetricsClient {\n /**\n * @param {Object} options\n * @param {any} options.redisClient - Redis client instance (required)\n * @param {string} [options.appName] - Application name (from MetricsClient)\n * @param {string} [options.dynoId] - Dyno/instance ID (from MetricsClient)\n * @param {string} [options.processType] - Process type (from MetricsClient)\n * @param {boolean} [options.enabled] - Enable metrics collection (from MetricsClient)\n * @param {boolean} [options.logValues] - Log metrics values (from MetricsClient)\n * @param {string} [options.pushgatewayUrl] - PushGateway URL (from MetricsClient)\n * @param {string} [options.pushgatewaySecret] - PushGateway secret token (from MetricsClient)\n * @param {number} [options.intervalSec] - Interval in seconds for pushing metrics (from MetricsClient)\n * @param {boolean} [options.removeOldMetrics] - Remove old metrics by service (from MetricsClient)\n * @param {boolean} [options.scripDefaultMetrics] - Skip default metrics creation (from MetricsClient)\n * @param {function} [options.startupValidation] - Function to validate startup (from MetricsClient)\n */\n constructor({ redisClient, ...metricsConfig } = {}) {\n const intervalSec =\n metricsConfig.intervalSec ||\n parseInt(process.env.METRICS_QUEUE_INTERVAL_SEC || '', 10) ||\n 5\n\n super({\n ...metricsConfig,\n scripDefaultMetrics: true,\n processType: metricsConfig.processType || 'redis-metrics',\n intervalSec,\n })\n\n /** Redis client used for metrics */\n this.redisClient = redisClient\n\n /** Gauge for Redis client connections */\n this.redisConnectionsGauge = this.createGauge({\n name: 'app_redis_connections_count',\n help: 'Number of Redis client connections',\n labelNames: this.withDefaultLabels(['connection_type']),\n })\n\n /** Gauge for Redis memory usage */\n this.redisMemoryGauge = this.createGauge({\n name: 'app_redis_memory_bytes',\n help: 'Redis memory usage in bytes',\n labelNames: this.withDefaultLabels(['memory_type']),\n })\n\n /** Gauge for Redis operation stats */\n this.redisStatsGauge = this.createGauge({\n name: 'app_redis_stats_total',\n help: 'Redis operation statistics',\n labelNames: this.withDefaultLabels(['operation']),\n })\n\n this._setCleanupHandlers()\n }\n\n getRedisInfo = async section => {\n if (!this.redisClient) throw new Error('Redis client not provided')\n console.log(\"constructor name: \", this.redisClient.constructor.name) // :todo delete\n if (typeof this.redisClient.info === 'function') {\n if (this.redisClient.info.length === 1) {\n // node-redis v3: uses callback\n return new Promise((resolve, reject) => {\n this.redisClient.info(section, (err, result) => {\n if (err) reject(err)\n else resolve(result)\n })\n })\n }\n // node-redis v4 or ioredis: returns Promise\n return this.redisClient.info(section)\n }\n throw new Error('Unsupported Redis client type')\n\n }\n\n /**\n * Collect basic Redis INFO metrics: clients, memory, stats\n * @returns {Promise<void>}\n */\n collectRedisMetrics = async () => {\n try {\n const [clientsInfo, memoryInfo, statsInfo] = await Promise.all([\n this.getRedisInfo('clients'),\n this.getRedisInfo('memory'),\n this.getRedisInfo('stats'),\n ])\n\n const labels = this.getDefaultLabels()\n\n const parseRedisInfo = infoStr =>\n Object.fromEntries(\n infoStr\n .split('\\r\\n')\n .filter(line => line && !line.startsWith('#'))\n .map(line => line.split(':', 2))\n .filter(parts => parts.length === 2 && parts[0] && parts[1])\n )\n\n const clients = parseRedisInfo(clientsInfo)\n const memory = parseRedisInfo(memoryInfo)\n const stats = parseRedisInfo(statsInfo)\n\n if (clients.connected_clients) {\n this.redisConnectionsGauge.set(\n { ...labels, connection_type: 'connected' },\n parseInt(clients.connected_clients, 10) || 0\n )\n }\n\n if (memory.used_memory) {\n this.redisMemoryGauge.set(\n { ...labels, memory_type: 'used' },\n parseInt(memory.used_memory, 10) || 0\n )\n }\n if (memory.maxmemory) {\n this.redisMemoryGauge.set(\n { ...labels, memory_type: 'max' },\n parseInt(memory.maxmemory, 10) || 0\n )\n }\n\n if (stats.instantaneous_ops_per_sec) {\n this.redisStatsGauge.set(\n { ...labels, operation: 'ops_per_sec' },\n parseInt(stats.instantaneous_ops_per_sec, 10) || 0\n )\n }\n } catch (error) {\n console.warn(\n `[redis-metrics] Failed to collect Redis metrics:`,\n error.message\n )\n }\n }\n\n /**\n * Collect metrics for all Redis and push to Prometheus Pushgateway\n * @returns {Promise<void>}\n */\n pushRedisMetrics = async () => {\n try {\n await this.collectRedisMetrics()\n await this.gatewayPush()\n\n if (this.metricsLogValues) {\n const metricObjects = await this.registry.getMetricsAsJSON()\n console.info(\n `[redis-metrics] Collected metrics for Redis`,\n JSON.stringify(metricObjects, null, 2)\n )\n }\n } catch (error) {\n console.error(\n `[redis-metrics] Failed to collect Redis metrics: ${error.message}`\n )\n throw error\n }\n }\n\n /**\n * Start periodic collection.\n * @param {number} [intervalSec=this.intervalSec] - Interval in seconds\n */\n startPush = (intervalSec = this.intervalSec) => {\n this._startPush(intervalSec, () => {\n this.pushRedisMetrics().catch(err => {\n console.error(`[redis-metrics] Failed to push Redis metrics:`, err)\n })\n })\n }\n\n /**\n * Cleanup Redis client\n */\n cleanup = async () => {\n try {\n if (!this.redisClient) return\n\n if (typeof this.redisClient.quit === 'function') {\n // node-redis v3 or v4\n await this.redisClient.quit()\n } else if (typeof this.redisClient.disconnect === 'function') {\n // ioredis\n await this.redisClient.disconnect()\n }\n } catch (err) {\n console.error('[redis-metrics] Error closing Redis client:', err)\n }\n process.exit(0)\n }\n\n _setCleanupHandlers = () => {\n process.on('SIGINT', this.cleanup)\n process.on('SIGTERM', this.cleanup)\n }\n}\n\nmodule.exports = { RedisMetricsClient }\n"],"mappings":";;AAAA,MAAM;EAAEA;AAAc,CAAC,GAAGC,OAAO,CAAC,GAAG,CAAC;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,kBAAkB,SAASF,aAAa,CAAC;EAC7C;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEG,WAAWA,CAAC;IAAEC,WAAW;IAAE,GAAGC;EAAc,CAAC,GAAG,CAAC,CAAC,EAAE;IAClD,MAAMC,WAAW,GACfD,aAAa,CAACC,WAAW,IACzBC,QAAQ,CAACC,OAAO,CAACC,GAAG,CAACC,0BAA0B,IAAI,EAAE,EAAE,EAAE,CAAC,IAC1D,CAAC;IAEH,KAAK,CAAC;MACJ,GAAGL,aAAa;MAChBM,mBAAmB,EAAE,IAAI;MACzBC,WAAW,EAAEP,aAAa,CAACO,WAAW,IAAI,eAAe;MACzDN;IACF,CAAC,CAAC;;IAEF;IACA,IAAI,CAACF,WAAW,GAAGA,WAAW;;IAE9B;IACA,IAAI,CAACS,qBAAqB,GAAG,IAAI,CAACC,WAAW,CAAC;MAC5CC,IAAI,EAAE,6BAA6B;MACnCC,IAAI,EAAE,oCAAoC;MAC1CC,UAAU,EAAE,IAAI,CAACC,iBAAiB,CAAC,CAAC,iBAAiB,CAAC;IACxD,CAAC,CAAC;;IAEF;IACA,IAAI,CAACC,gBAAgB,GAAG,IAAI,CAACL,WAAW,CAAC;MACvCC,IAAI,EAAE,wBAAwB;MAC9BC,IAAI,EAAE,6BAA6B;MACnCC,UAAU,EAAE,IAAI,CAACC,iBAAiB,CAAC,CAAC,aAAa,CAAC;IACpD,CAAC,CAAC;;IAEF;IACA,IAAI,CAACE,eAAe,GAAG,IAAI,CAACN,WAAW,CAAC;MACtCC,IAAI,EAAE,uBAAuB;MAC7BC,IAAI,EAAE,4BAA4B;MAClCC,UAAU,EAAE,IAAI,CAACC,iBAAiB,CAAC,CAAC,WAAW,CAAC;IAClD,CAAC,CAAC;IAEF,IAAI,CAACG,mBAAmB,CAAC,CAAC;EAC5B;EAEAC,YAAY,GAAG,MAAMC,OAAO,IAAI;IAC9B,IAAI,CAAC,IAAI,CAACnB,WAAW,EAAE,MAAM,IAAIoB,KAAK,CAAC,2BAA2B,CAAC;IACnEC,OAAO,CAACC,GAAG,CAAC,oBAAoB,EAAE,IAAI,CAACtB,WAAW,CAACD,WAAW,CAACY,IAAI,CAAC,EAAC;IACrE,IAAI,OAAO,IAAI,CAACX,WAAW,CAACuB,IAAI,KAAK,UAAU,EAAE;MAC/C,IAAI,IAAI,CAACvB,WAAW,CAACuB,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE;QACtC;QACA,OAAO,IAAIC,OAAO,CAAC,CAACC,OAAO,EAAEC,MAAM,KAAK;UACtC,IAAI,CAAC3B,WAAW,CAACuB,IAAI,CAACJ,OAAO,EAAE,CAACS,GAAG,EAAEC,MAAM,KAAK;YAC9C,IAAID,GAAG,EAAED,MAAM,CAACC,GAAG,CAAC,MACfF,OAAO,CAACG,MAAM,CAAC;UACtB,CAAC,CAAC;QACJ,CAAC,CAAC;MACJ;MACE;MACA,OAAO,IAAI,CAAC7B,WAAW,CAACuB,IAAI,CAACJ,OAAO,CAAC;IACzC;IACE,MAAM,IAAIC,KAAK,CAAC,+BAA+B,CAAC;EAEpD,CAAC;;EAED;AACF;AACA;AACA;EACEU,mBAAmB,GAAG,MAAAA,CAAA,KAAY;IAChC,IAAI;MACF,MAAM,CAACC,WAAW,EAAEC,UAAU,EAAEC,SAAS,CAAC,GAAG,MAAMR,OAAO,CAACS,GAAG,CAAC,CAC7D,IAAI,CAAChB,YAAY,CAAC,SAAS,CAAC,EAC5B,IAAI,CAACA,YAAY,CAAC,QAAQ,CAAC,EAC3B,IAAI,CAACA,YAAY,CAAC,OAAO,CAAC,CAC3B,CAAC;MAEF,MAAMiB,MAAM,GAAG,IAAI,CAACC,gBAAgB,CAAC,CAAC;MAEtC,MAAMC,cAAc,GAAGC,OAAO,IAC5BC,MAAM,CAACC,WAAW,CAChBF,OAAO,CACJG,KAAK,CAAC,MAAM,CAAC,CACbC,MAAM,CAACC,IAAI,IAAIA,IAAI,IAAI,CAACA,IAAI,CAACC,UAAU,CAAC,GAAG,CAAC,CAAC,CAC7CC,GAAG,CAACF,IAAI,IAAIA,IAAI,CAACF,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAC/BC,MAAM,CAACI,KAAK,IAAIA,KAAK,CAACtB,MAAM,KAAK,CAAC,IAAIsB,KAAK,CAAC,CAAC,CAAC,IAAIA,KAAK,CAAC,CAAC,CAAC,CAC/D,CAAC;MAEH,MAAMC,OAAO,GAAGV,cAAc,CAACN,WAAW,CAAC;MAC3C,MAAMiB,MAAM,GAAGX,cAAc,CAACL,UAAU,CAAC;MACzC,MAAMiB,KAAK,GAAGZ,cAAc,CAACJ,SAAS,CAAC;MAEvC,IAAIc,OAAO,CAACG,iBAAiB,EAAE;QAC7B,IAAI,CAACzC,qBAAqB,CAAC0C,GAAG,CAC5B;UAAE,GAAGhB,MAAM;UAAEiB,eAAe,EAAE;QAAY,CAAC,EAC3CjD,QAAQ,CAAC4C,OAAO,CAACG,iBAAiB,EAAE,EAAE,CAAC,IAAI,CAC7C,CAAC;MACH;MAEA,IAAIF,MAAM,CAACK,WAAW,EAAE;QACtB,IAAI,CAACtC,gBAAgB,CAACoC,GAAG,CACvB;UAAE,GAAGhB,MAAM;UAAEmB,WAAW,EAAE;QAAO,CAAC,EAClCnD,QAAQ,CAAC6C,MAAM,CAACK,WAAW,EAAE,EAAE,CAAC,IAAI,CACtC,CAAC;MACH;MACA,IAAIL,MAAM,CAACO,SAAS,EAAE;QACpB,IAAI,CAACxC,gBAAgB,CAACoC,GAAG,CACvB;UAAE,GAAGhB,MAAM;UAAEmB,WAAW,EAAE;QAAM,CAAC,EACjCnD,QAAQ,CAAC6C,MAAM,CAACO,SAAS,EAAE,EAAE,CAAC,IAAI,CACpC,CAAC;MACH;MAEA,IAAIN,KAAK,CAACO,yBAAyB,EAAE;QACnC,IAAI,CAACxC,eAAe,CAACmC,GAAG,CACtB;UAAE,GAAGhB,MAAM;UAAEsB,SAAS,EAAE;QAAc,CAAC,EACvCtD,QAAQ,CAAC8C,KAAK,CAACO,yBAAyB,EAAE,EAAE,CAAC,IAAI,CACnD,CAAC;MACH;IACF,CAAC,CAAC,OAAOE,KAAK,EAAE;MACdrC,OAAO,CAACsC,IAAI,CACV,kDAAkD,EAClDD,KAAK,CAACE,OACR,CAAC;IACH;EACF,CAAC;;EAED;AACF;AACA;AACA;EACEC,gBAAgB,GAAG,MAAAA,CAAA,KAAY;IAC7B,IAAI;MACF,MAAM,IAAI,CAAC/B,mBAAmB,CAAC,CAAC;MAChC,MAAM,IAAI,CAACgC,WAAW,CAAC,CAAC;MAExB,IAAI,IAAI,CAACC,gBAAgB,EAAE;QACzB,MAAMC,aAAa,GAAG,MAAM,IAAI,CAACC,QAAQ,CAACC,gBAAgB,CAAC,CAAC;QAC5D7C,OAAO,CAACE,IAAI,CACV,6CAA6C,EAC7C4C,IAAI,CAACC,SAAS,CAACJ,aAAa,EAAE,IAAI,EAAE,CAAC,CACvC,CAAC;MACH;IACF,CAAC,CAAC,OAAON,KAAK,EAAE;MACdrC,OAAO,CAACqC,KAAK,CACX,oDAAoDA,KAAK,CAACE,OAAO,EACnE,CAAC;MACD,MAAMF,KAAK;IACb;EACF,CAAC;;EAED;AACF;AACA;AACA;EACEW,SAAS,GAAGA,CAACnE,WAAW,GAAG,IAAI,CAACA,WAAW,KAAK;IAC9C,IAAI,CAACoE,UAAU,CAACpE,WAAW,EAAE,MAAM;MACjC,IAAI,CAAC2D,gBAAgB,CAAC,CAAC,CAACU,KAAK,CAAC3C,GAAG,IAAI;QACnCP,OAAO,CAACqC,KAAK,CAAC,+CAA+C,EAAE9B,GAAG,CAAC;MACrE,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ,CAAC;;EAED;AACF;AACA;EACE4C,OAAO,GAAG,MAAAA,CAAA,KAAY;IACpB,IAAI;MACF,IAAI,CAAC,IAAI,CAACxE,WAAW,EAAE;MAEvB,IAAI,OAAO,IAAI,CAACA,WAAW,CAACyE,IAAI,KAAK,UAAU,EAAE;QAC/C;QACA,MAAM,IAAI,CAACzE,WAAW,CAACyE,IAAI,CAAC,CAAC;MAC/B,CAAC,MAAM,IAAI,OAAO,IAAI,CAACzE,WAAW,CAAC0E,UAAU,KAAK,UAAU,EAAE;QAC5D;QACA,MAAM,IAAI,CAAC1E,WAAW,CAAC0E,UAAU,CAAC,CAAC;MACrC;IACF,CAAC,CAAC,OAAO9C,GAAG,EAAE;MACZP,OAAO,CAACqC,KAAK,CAAC,6CAA6C,EAAE9B,GAAG,CAAC;IACnE;IACAxB,OAAO,CAACuE,IAAI,CAAC,CAAC,CAAC;EACjB,CAAC;EAED1D,mBAAmB,GAAGA,CAAA,KAAM;IAC1Bb,OAAO,CAACwE,EAAE,CAAC,QAAQ,EAAE,IAAI,CAACJ,OAAO,CAAC;IAClCpE,OAAO,CAACwE,EAAE,CAAC,SAAS,EAAE,IAAI,CAACJ,OAAO,CAAC;EACrC,CAAC;AACH;AAEAK,MAAM,CAACC,OAAO,GAAG;EAAEhF;AAAmB,CAAC","ignoreList":[]}
@@ -4,5 +4,17 @@
4
4
  * @param {string} [defaultAppName='undefined-app'] - Fallback app name if METRICS_APP_NAME is not set.
5
5
  * @returns {(client: import('redis').RedisClient, name: string) => void}
6
6
  */
7
- export function createSetClientName(defaultAppName?: string | undefined): (client: import('redis').RedisClient, name: string) => void;
7
+ export function createSetClientNameForRedisV3(defaultAppName?: string | undefined): (client: import('redis').RedisClient, name: string) => void;
8
+ /**
9
+ * Creates a function to set Redis client name for node-redis v4
10
+ * @param {string} defaultAppName
11
+ * @returns {(client: ReturnType<createClient>, name: string) => void}
12
+ */
13
+ export function createSetClientNameForRedisV4(defaultAppName?: string): (client: ReturnType<createClient>, name: string) => void;
14
+ /**
15
+ * Creates a function to set Redis client name for ioredis
16
+ * @param {string} defaultAppName
17
+ * @returns {(client: Redis, name: string) => void}
18
+ */
19
+ export function createSetClientNameForIoredis(defaultAppName?: string): (client: Redis, name: string) => void;
8
20
  //# sourceMappingURL=redisUtils.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"redisUtils.d.ts","sourceRoot":"","sources":["../src/redisUtils.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,mFAFsB,OAAO,OAAO,EAAE,WAAW,QAAQ,MAAM,KAAK,IAAI,CAuBvE"}
1
+ {"version":3,"file":"redisUtils.d.ts","sourceRoot":"","sources":["../src/redisUtils.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,6FAFsB,OAAO,OAAO,EAAE,WAAW,QAAQ,MAAM,KAAK,IAAI,CAuBvE;AA2BD;;;;GAIG;AACH,+DAHW,MAAM,YACK,wBAAwB,QAAQ,MAAM,KAAK,IAAI,CAsBpE;AAlDD;;;;GAIG;AACH,+DAHW,MAAM,yBACkB,MAAM,KAAK,IAAI,CAoBjD"}
package/lib/redisUtils.js CHANGED
@@ -6,7 +6,7 @@
6
6
  * @param {string} [defaultAppName='undefined-app'] - Fallback app name if METRICS_APP_NAME is not set.
7
7
  * @returns {(client: import('redis').RedisClient, name: string) => void}
8
8
  */
9
- const createSetClientName = (defaultAppName = 'undefined-app') => {
9
+ const createSetClientNameForRedisV3 = (defaultAppName = 'undefined-app') => {
10
10
  return (client, name) => {
11
11
  const appName = process.env.METRICS_APP_NAME || defaultAppName;
12
12
  const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno';
@@ -23,7 +23,52 @@ const createSetClientName = (defaultAppName = 'undefined-app') => {
23
23
  }
24
24
  };
25
25
  };
26
+
27
+ /**
28
+ * Creates a function to set Redis client name for ioredis
29
+ * @param {string} defaultAppName
30
+ * @returns {(client: Redis, name: string) => void}
31
+ */
32
+ const createSetClientNameForIoredis = (defaultAppName = 'undefined-app') => {
33
+ return (client, name) => {
34
+ const appName = process.env.METRICS_APP_NAME || defaultAppName;
35
+ const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno';
36
+ if (process.env.NODE_ENV !== 'test') {
37
+ client.once('connect', () => {
38
+ client.call('CLIENT', ['SETNAME', `${appName}:${dyno}:${name}`]).then(() => {
39
+ console.log(`Connected to Redis for pid:${process.pid} (${name})`);
40
+ }).catch(err => {
41
+ console.error(`Failed to set client name for ${name}:`, err);
42
+ });
43
+ });
44
+ }
45
+ };
46
+ };
47
+
48
+ /**
49
+ * Creates a function to set Redis client name for node-redis v4
50
+ * @param {string} defaultAppName
51
+ * @returns {(client: ReturnType<createClient>, name: string) => void}
52
+ */
53
+ const createSetClientNameForRedisV4 = (defaultAppName = 'undefined-app') => {
54
+ return (client, name) => {
55
+ const appName = process.env.METRICS_APP_NAME || defaultAppName;
56
+ const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno';
57
+ if (process.env.NODE_ENV !== 'test') {
58
+ client.on('ready', async () => {
59
+ try {
60
+ await client.sendCommand(['CLIENT', 'SETNAME', `${appName}:${dyno}:${name}`]);
61
+ console.log(`Connected to Redis for pid:${process.pid} (${name})`);
62
+ } catch (err) {
63
+ console.error(`Failed to set client name for ${name}:`, err);
64
+ }
65
+ });
66
+ }
67
+ };
68
+ };
26
69
  module.exports = {
27
- createSetClientName
70
+ createSetClientNameForRedisV3,
71
+ createSetClientNameForRedisV4,
72
+ createSetClientNameForIoredis
28
73
  };
29
74
  //# sourceMappingURL=redisUtils.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"redisUtils.js","names":["createSetClientName","defaultAppName","client","name","appName","process","env","METRICS_APP_NAME","dyno","BUILD_DYNO_PROCESS_TYPE","NODE_ENV","on","send_command","err","console","error","log","pid","module","exports"],"sources":["../src/redisUtils.js"],"sourcesContent":["/**\n * Creates a configured setClientName function.\n *\n * @param {string} [defaultAppName='undefined-app'] - Fallback app name if METRICS_APP_NAME is not set.\n * @returns {(client: import('redis').RedisClient, name: string) => void}\n */\nconst createSetClientName = (defaultAppName = 'undefined-app') => {\n return (client, name) => {\n const appName = process.env.METRICS_APP_NAME || defaultAppName\n const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno'\n\n if (process.env.NODE_ENV !== 'test') {\n client.on('connect', () => {\n client.send_command(\n 'CLIENT',\n ['SETNAME', `${appName}:${dyno}:${name}`],\n err => {\n if (err) {\n console.error(`Failed to set client name for ${name}:`, err)\n } else {\n console.log(`Connected to Redis for pid:${process.pid} (${name})`)\n }\n }\n )\n })\n }\n }\n}\n\nmodule.exports = { createSetClientName }\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,mBAAmB,GAAGA,CAACC,cAAc,GAAG,eAAe,KAAK;EAChE,OAAO,CAACC,MAAM,EAAEC,IAAI,KAAK;IACvB,MAAMC,OAAO,GAAGC,OAAO,CAACC,GAAG,CAACC,gBAAgB,IAAIN,cAAc;IAC9D,MAAMO,IAAI,GAAGH,OAAO,CAACC,GAAG,CAACG,uBAAuB,IAAI,gBAAgB;IAEpE,IAAIJ,OAAO,CAACC,GAAG,CAACI,QAAQ,KAAK,MAAM,EAAE;MACnCR,MAAM,CAACS,EAAE,CAAC,SAAS,EAAE,MAAM;QACzBT,MAAM,CAACU,YAAY,CACjB,QAAQ,EACR,CAAC,SAAS,EAAE,GAAGR,OAAO,IAAII,IAAI,IAAIL,IAAI,EAAE,CAAC,EACzCU,GAAG,IAAI;UACL,IAAIA,GAAG,EAAE;YACPC,OAAO,CAACC,KAAK,CAAC,iCAAiCZ,IAAI,GAAG,EAAEU,GAAG,CAAC;UAC9D,CAAC,MAAM;YACLC,OAAO,CAACE,GAAG,CAAC,8BAA8BX,OAAO,CAACY,GAAG,KAAKd,IAAI,GAAG,CAAC;UACpE;QACF,CACF,CAAC;MACH,CAAC,CAAC;IACJ;EACF,CAAC;AACH,CAAC;AAEDe,MAAM,CAACC,OAAO,GAAG;EAAEnB;AAAoB,CAAC","ignoreList":[]}
1
+ {"version":3,"file":"redisUtils.js","names":["createSetClientNameForRedisV3","defaultAppName","client","name","appName","process","env","METRICS_APP_NAME","dyno","BUILD_DYNO_PROCESS_TYPE","NODE_ENV","on","send_command","err","console","error","log","pid","createSetClientNameForIoredis","once","call","then","catch","createSetClientNameForRedisV4","sendCommand","module","exports"],"sources":["../src/redisUtils.js"],"sourcesContent":["/**\n * Creates a configured setClientName function.\n *\n * @param {string} [defaultAppName='undefined-app'] - Fallback app name if METRICS_APP_NAME is not set.\n * @returns {(client: import('redis').RedisClient, name: string) => void}\n */\nconst createSetClientNameForRedisV3 = (defaultAppName = 'undefined-app') => {\n return (client, name) => {\n const appName = process.env.METRICS_APP_NAME || defaultAppName\n const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno'\n\n if (process.env.NODE_ENV !== 'test') {\n client.on('connect', () => {\n client.send_command(\n 'CLIENT',\n ['SETNAME', `${appName}:${dyno}:${name}`],\n err => {\n if (err) {\n console.error(`Failed to set client name for ${name}:`, err)\n } else {\n console.log(`Connected to Redis for pid:${process.pid} (${name})`)\n }\n }\n )\n })\n }\n }\n}\n\n/**\n * Creates a function to set Redis client name for ioredis\n * @param {string} defaultAppName\n * @returns {(client: Redis, name: string) => void}\n */\nconst createSetClientNameForIoredis = (defaultAppName = 'undefined-app') => {\n return (client, name) => {\n const appName = process.env.METRICS_APP_NAME || defaultAppName\n const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno'\n\n if (process.env.NODE_ENV !== 'test') {\n client.once('connect', () => {\n client\n .call('CLIENT', ['SETNAME', `${appName}:${dyno}:${name}`])\n .then(() => {\n console.log(`Connected to Redis for pid:${process.pid} (${name})`)\n })\n .catch(err => {\n console.error(`Failed to set client name for ${name}:`, err)\n })\n })\n }\n }\n}\n\n/**\n * Creates a function to set Redis client name for node-redis v4\n * @param {string} defaultAppName\n * @returns {(client: ReturnType<createClient>, name: string) => void}\n */\nconst createSetClientNameForRedisV4 = (defaultAppName = 'undefined-app') => {\n return (client, name) => {\n const appName = process.env.METRICS_APP_NAME || defaultAppName\n const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno'\n\n if (process.env.NODE_ENV !== 'test') {\n client.on('ready', async () => {\n try {\n await client.sendCommand([\n 'CLIENT',\n 'SETNAME',\n `${appName}:${dyno}:${name}`,\n ])\n console.log(`Connected to Redis for pid:${process.pid} (${name})`)\n } catch (err) {\n console.error(`Failed to set client name for ${name}:`, err)\n }\n })\n }\n }\n}\n\nmodule.exports = {\n createSetClientNameForRedisV3,\n createSetClientNameForRedisV4,\n createSetClientNameForIoredis,\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,6BAA6B,GAAGA,CAACC,cAAc,GAAG,eAAe,KAAK;EAC1E,OAAO,CAACC,MAAM,EAAEC,IAAI,KAAK;IACvB,MAAMC,OAAO,GAAGC,OAAO,CAACC,GAAG,CAACC,gBAAgB,IAAIN,cAAc;IAC9D,MAAMO,IAAI,GAAGH,OAAO,CAACC,GAAG,CAACG,uBAAuB,IAAI,gBAAgB;IAEpE,IAAIJ,OAAO,CAACC,GAAG,CAACI,QAAQ,KAAK,MAAM,EAAE;MACnCR,MAAM,CAACS,EAAE,CAAC,SAAS,EAAE,MAAM;QACzBT,MAAM,CAACU,YAAY,CACjB,QAAQ,EACR,CAAC,SAAS,EAAE,GAAGR,OAAO,IAAII,IAAI,IAAIL,IAAI,EAAE,CAAC,EACzCU,GAAG,IAAI;UACL,IAAIA,GAAG,EAAE;YACPC,OAAO,CAACC,KAAK,CAAC,iCAAiCZ,IAAI,GAAG,EAAEU,GAAG,CAAC;UAC9D,CAAC,MAAM;YACLC,OAAO,CAACE,GAAG,CAAC,8BAA8BX,OAAO,CAACY,GAAG,KAAKd,IAAI,GAAG,CAAC;UACpE;QACF,CACF,CAAC;MACH,CAAC,CAAC;IACJ;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMe,6BAA6B,GAAGA,CAACjB,cAAc,GAAG,eAAe,KAAK;EAC1E,OAAO,CAACC,MAAM,EAAEC,IAAI,KAAK;IACvB,MAAMC,OAAO,GAAGC,OAAO,CAACC,GAAG,CAACC,gBAAgB,IAAIN,cAAc;IAC9D,MAAMO,IAAI,GAAGH,OAAO,CAACC,GAAG,CAACG,uBAAuB,IAAI,gBAAgB;IAEpE,IAAIJ,OAAO,CAACC,GAAG,CAACI,QAAQ,KAAK,MAAM,EAAE;MACnCR,MAAM,CAACiB,IAAI,CAAC,SAAS,EAAE,MAAM;QAC3BjB,MAAM,CACHkB,IAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,GAAGhB,OAAO,IAAII,IAAI,IAAIL,IAAI,EAAE,CAAC,CAAC,CACzDkB,IAAI,CAAC,MAAM;UACVP,OAAO,CAACE,GAAG,CAAC,8BAA8BX,OAAO,CAACY,GAAG,KAAKd,IAAI,GAAG,CAAC;QACpE,CAAC,CAAC,CACDmB,KAAK,CAACT,GAAG,IAAI;UACZC,OAAO,CAACC,KAAK,CAAC,iCAAiCZ,IAAI,GAAG,EAAEU,GAAG,CAAC;QAC9D,CAAC,CAAC;MACN,CAAC,CAAC;IACJ;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMU,6BAA6B,GAAGA,CAACtB,cAAc,GAAG,eAAe,KAAK;EAC1E,OAAO,CAACC,MAAM,EAAEC,IAAI,KAAK;IACvB,MAAMC,OAAO,GAAGC,OAAO,CAACC,GAAG,CAACC,gBAAgB,IAAIN,cAAc;IAC9D,MAAMO,IAAI,GAAGH,OAAO,CAACC,GAAG,CAACG,uBAAuB,IAAI,gBAAgB;IAEpE,IAAIJ,OAAO,CAACC,GAAG,CAACI,QAAQ,KAAK,MAAM,EAAE;MACnCR,MAAM,CAACS,EAAE,CAAC,OAAO,EAAE,YAAY;QAC7B,IAAI;UACF,MAAMT,MAAM,CAACsB,WAAW,CAAC,CACvB,QAAQ,EACR,SAAS,EACT,GAAGpB,OAAO,IAAII,IAAI,IAAIL,IAAI,EAAE,CAC7B,CAAC;UACFW,OAAO,CAACE,GAAG,CAAC,8BAA8BX,OAAO,CAACY,GAAG,KAAKd,IAAI,GAAG,CAAC;QACpE,CAAC,CAAC,OAAOU,GAAG,EAAE;UACZC,OAAO,CAACC,KAAK,CAAC,iCAAiCZ,IAAI,GAAG,EAAEU,GAAG,CAAC;QAC9D;MACF,CAAC,CAAC;IACJ;EACF,CAAC;AACH,CAAC;AAEDY,MAAM,CAACC,OAAO,GAAG;EACf1B,6BAA6B;EAC7BuB,6BAA6B;EAC7BL;AACF,CAAC","ignoreList":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adalo/metrics",
3
- "version": "0.1.57",
3
+ "version": "0.1.59",
4
4
  "description": "Reusable metrics utilities for Node.js and Laravel apps",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -62,24 +62,36 @@ class RedisMetricsClient extends MetricsClient {
62
62
  this._setCleanupHandlers()
63
63
  }
64
64
 
65
- /**
66
- * Collect basic Redis INFO metrics: clients, memory, stats
67
- * @returns {Promise<void>}
68
- */
69
- collectRedisMetrics = async () => {
70
- try {
71
- const getRedisInfo = section =>
72
- new Promise((resolve, reject) => {
65
+ getRedisInfo = async section => {
66
+ if (!this.redisClient) throw new Error('Redis client not provided')
67
+ console.log("constructor name: ", this.redisClient.constructor.name) // :todo delete
68
+ if (typeof this.redisClient.info === 'function') {
69
+ if (this.redisClient.info.length === 1) {
70
+ // node-redis v3: uses callback
71
+ return new Promise((resolve, reject) => {
73
72
  this.redisClient.info(section, (err, result) => {
74
73
  if (err) reject(err)
75
74
  else resolve(result)
76
75
  })
77
76
  })
77
+ }
78
+ // node-redis v4 or ioredis: returns Promise
79
+ return this.redisClient.info(section)
80
+ }
81
+ throw new Error('Unsupported Redis client type')
78
82
 
83
+ }
84
+
85
+ /**
86
+ * Collect basic Redis INFO metrics: clients, memory, stats
87
+ * @returns {Promise<void>}
88
+ */
89
+ collectRedisMetrics = async () => {
90
+ try {
79
91
  const [clientsInfo, memoryInfo, statsInfo] = await Promise.all([
80
- getRedisInfo('clients'),
81
- getRedisInfo('memory'),
82
- getRedisInfo('stats'),
92
+ this.getRedisInfo('clients'),
93
+ this.getRedisInfo('memory'),
94
+ this.getRedisInfo('stats'),
83
95
  ])
84
96
 
85
97
  const labels = this.getDefaultLabels()
@@ -172,7 +184,15 @@ class RedisMetricsClient extends MetricsClient {
172
184
  */
173
185
  cleanup = async () => {
174
186
  try {
175
- this.redisClient?.quit()
187
+ if (!this.redisClient) return
188
+
189
+ if (typeof this.redisClient.quit === 'function') {
190
+ // node-redis v3 or v4
191
+ await this.redisClient.quit()
192
+ } else if (typeof this.redisClient.disconnect === 'function') {
193
+ // ioredis
194
+ await this.redisClient.disconnect()
195
+ }
176
196
  } catch (err) {
177
197
  console.error('[redis-metrics] Error closing Redis client:', err)
178
198
  }
package/src/redisUtils.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * @param {string} [defaultAppName='undefined-app'] - Fallback app name if METRICS_APP_NAME is not set.
5
5
  * @returns {(client: import('redis').RedisClient, name: string) => void}
6
6
  */
7
- const createSetClientName = (defaultAppName = 'undefined-app') => {
7
+ const createSetClientNameForRedisV3 = (defaultAppName = 'undefined-app') => {
8
8
  return (client, name) => {
9
9
  const appName = process.env.METRICS_APP_NAME || defaultAppName
10
10
  const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno'
@@ -27,4 +27,60 @@ const createSetClientName = (defaultAppName = 'undefined-app') => {
27
27
  }
28
28
  }
29
29
 
30
- module.exports = { createSetClientName }
30
+ /**
31
+ * Creates a function to set Redis client name for ioredis
32
+ * @param {string} defaultAppName
33
+ * @returns {(client: Redis, name: string) => void}
34
+ */
35
+ const createSetClientNameForIoredis = (defaultAppName = 'undefined-app') => {
36
+ return (client, name) => {
37
+ const appName = process.env.METRICS_APP_NAME || defaultAppName
38
+ const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno'
39
+
40
+ if (process.env.NODE_ENV !== 'test') {
41
+ client.once('connect', () => {
42
+ client
43
+ .call('CLIENT', ['SETNAME', `${appName}:${dyno}:${name}`])
44
+ .then(() => {
45
+ console.log(`Connected to Redis for pid:${process.pid} (${name})`)
46
+ })
47
+ .catch(err => {
48
+ console.error(`Failed to set client name for ${name}:`, err)
49
+ })
50
+ })
51
+ }
52
+ }
53
+ }
54
+
55
+ /**
56
+ * Creates a function to set Redis client name for node-redis v4
57
+ * @param {string} defaultAppName
58
+ * @returns {(client: ReturnType<createClient>, name: string) => void}
59
+ */
60
+ const createSetClientNameForRedisV4 = (defaultAppName = 'undefined-app') => {
61
+ return (client, name) => {
62
+ const appName = process.env.METRICS_APP_NAME || defaultAppName
63
+ const dyno = process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined-dyno'
64
+
65
+ if (process.env.NODE_ENV !== 'test') {
66
+ client.on('ready', async () => {
67
+ try {
68
+ await client.sendCommand([
69
+ 'CLIENT',
70
+ 'SETNAME',
71
+ `${appName}:${dyno}:${name}`,
72
+ ])
73
+ console.log(`Connected to Redis for pid:${process.pid} (${name})`)
74
+ } catch (err) {
75
+ console.error(`Failed to set client name for ${name}:`, err)
76
+ }
77
+ })
78
+ }
79
+ }
80
+ }
81
+
82
+ module.exports = {
83
+ createSetClientNameForRedisV3,
84
+ createSetClientNameForRedisV4,
85
+ createSetClientNameForIoredis,
86
+ }