@platformatic/metrics 2.74.3 → 3.0.0-alpha.2

package/eslint.config.js

@@ -1,3 +1,3 @@
-'use strict'
+import neostandard from 'neostandard'
 
-module.exports = require('neostandard')({ ts: true })
+export default neostandard()

package/index.js

@@ -1,59 +1,42 @@
-'use strict'
+import collectHttpMetrics from '@platformatic/http-metrics'
+import os from 'node:os'
+import { performance } from 'node:perf_hooks'
+import client from 'prom-client'
 
-const os = require('node:os')
-const { eventLoopUtilization } = require('node:perf_hooks').performance
-const client = require('prom-client')
-const collectHttpMetrics = require('@platformatic/http-metrics')
+export * as client from 'prom-client'
 
+const { eventLoopUtilization } = performance
 const { Registry, Gauge, Counter, collectDefaultMetrics } = client
 
-async function collectMetrics (serviceId, workerId, metricsConfig = {}, registry = undefined) {
-  if (!registry) {
-    registry = new Registry()
-  }
+export const kMetricsGroups = Symbol('plt.metrics.MetricsGroups')
 
-  const labels = { ...metricsConfig.labels, serviceId }
-  if (workerId >= 0) {
-    labels.workerId = workerId
-  }
-  registry.setDefaultLabels(labels)
+export function registerMetricsGroup (registry, group) {
+  registry[kMetricsGroups] ??= new Set()
+  registry[kMetricsGroups].add(group)
+}
 
-  if (metricsConfig.defaultMetrics) {
-    collectDefaultMetrics({ register: registry })
-    collectEluMetric(registry)
-    await collectThreadCpuMetrics(registry)
-  }
+export function hasMetricsGroup (registry, group) {
+  return registry[kMetricsGroups]?.has(group)
+}
 
-  if (metricsConfig.httpMetrics) {
-    collectHttpMetrics(registry, {
-      customLabels: ['telemetry_id'],
-      getCustomLabels: req => {
-        const telemetryId = req.headers?.['x-plt-telemetry-id'] ?? 'unknown'
-        return { telemetry_id: telemetryId }
-      },
-      histogram: {
-        name: 'http_request_all_duration_seconds',
-        help: 'request duration in seconds summary for all requests',
-        collect: function () {
-          process.nextTick(() => this.reset())
-        }
-      },
-      summary: {
-        name: 'http_request_all_summary_seconds',
-        help: 'request duration in seconds histogram for all requests',
-        collect: function () {
-          process.nextTick(() => this.reset())
-        }
-      }
-    })
-  }
+// Use this method when dealing with metrics registration in async functions.
+// This will ensure that the group is registered only once.
+export function ensureMetricsGroup (registry, group) {
+  registry[kMetricsGroups] ??= new Set()
 
-  return {
-    registry,
+  if (registry[kMetricsGroups]?.has(group)) {
+    return true
   }
+
+  registry[kMetricsGroups].add(group)
+  return false
 }
 
-async function collectThreadCpuMetrics (registry) {
+export async function collectThreadCpuMetrics (registry) {
+  if (ensureMetricsGroup(registry, 'threadCpuUsage')) {
+    return
+  }
+
   let threadCpuUsage
 
   try {
@@ -117,7 +100,11 @@ async function collectThreadCpuMetrics (registry) {
   registry.registerMetric(threadCpuPercentUsageGaugeMetric)
 }
 
-function collectEluMetric (register) {
+export function collectEluMetric (registry) {
+  if (ensureMetricsGroup(registry, 'elu')) {
+    return
+  }
+
   let startELU = eventLoopUtilization()
   const eluMetric = new Gauge({
     name: 'nodejs_eventloop_utilization',
@@ -128,9 +115,9 @@ function collectEluMetric (register) {
       eluMetric.set(result)
       startELU = endELU
     },
-    registers: [register]
+    registers: [registry]
   })
-  register.registerMetric(eluMetric)
+  registry.registerMetric(eluMetric)
 
   let previousIdleTime = 0
   let previousTotalTime = 0
@@ -161,9 +148,56 @@ function collectEluMetric (register) {
       previousIdleTime = idleTime
       previousTotalTime = totalTime
     },
-    registers: [register]
+    registers: [registry]
   })
-  register.registerMetric(cpuMetric)
+  registry.registerMetric(cpuMetric)
 }
 
-module.exports = { collectMetrics, client }
+export async function collectMetrics (serviceId, workerId, metricsConfig = {}, registry = undefined) {
+  if (!registry) {
+    registry = new Registry()
+  }
+
+  const labels = { ...metricsConfig.labels, serviceId }
+  if (workerId >= 0) {
+    labels.workerId = workerId
+  }
+  registry.setDefaultLabels(labels)
+
+  if (metricsConfig.defaultMetrics) {
+    if (!ensureMetricsGroup(registry, 'default')) {
+      collectDefaultMetrics({ register: registry })
+    }
+
+    collectEluMetric(registry)
+    await collectThreadCpuMetrics(registry)
+  }
+
+  if (metricsConfig.httpMetrics && !ensureMetricsGroup(registry, 'http')) {
+    collectHttpMetrics(registry, {
+      customLabels: ['telemetry_id'],
+      getCustomLabels: req => {
+        const telemetryId = req.headers?.['x-plt-telemetry-id'] ?? 'unknown'
+        return { telemetry_id: telemetryId }
+      },
+      histogram: {
+        name: 'http_request_all_duration_seconds',
+        help: 'request duration in seconds summary for all requests',
+        collect: function () {
+          process.nextTick(() => this.reset())
+        }
+      },
+      summary: {
+        name: 'http_request_all_summary_seconds',
+        help: 'request duration in seconds histogram for all requests',
+        collect: function () {
+          process.nextTick(() => this.reset())
+        }
+      }
+    })
+  }
+
+  return {
+    registry
+  }
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@platformatic/metrics",
-  "version": "2.74.3",
+  "version": "3.0.0-alpha.2",
   "description": "Platformatic Stackable Metrics",
   "main": "index.js",
-  "type": "commonjs",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
@@ -26,6 +26,9 @@
     "eslint": "9",
     "neostandard": "^0.12.0"
   },
+  "engines": {
+    "node": ">=22.18.0"
+  },
   "scripts": {
     "test": "npm run lint && borp",
     "lint": "eslint"

package/test/helper.js

@@ -1,6 +1,6 @@
-const assert = require('node:assert')
+import { ok } from 'node:assert'
 
-const expectedMetrics = [
+export const expectedMetrics = [
   {
     name: 'nodejs_active_handles',
     type: 'gauge'
@@ -127,47 +127,42 @@ const expectedMetrics = [
   }
 ]
 
-function assertMetric (metrics, metric) {
-  assert.ok(metrics.includes(`# HELP ${metric.name} `), `Metric ${metric.name} not found`)
-  assert.ok(metrics.includes(`# TYPE ${metric.name} ${metric.type}`), `Metric ${metric.name} type ${metric.type} not found`)
-
-  if (metric.type === 'summary') {
-    assertSummary(metrics, metric)
-  } else if (metric.type === 'histogram') {
-    assertHistogram(metrics, metric)
-  }
-}
-
 function assertSummary (metrics, metric) {
-  assert.ok(metrics.includes(`${metric.name}{quantile="0.01"`))
-  assert.ok(metrics.includes('http_request_all_summary_seconds{quantile="0.01"'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds{quantile="0.05"'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds{quantile="0.5"'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds{quantile="0.9"'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds{quantile="0.95"'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds{quantile="0.99"'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds{quantile="0.999"'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds_sum{'))
-  assert.ok(metrics.includes('http_request_all_summary_seconds_count{'))
+  ok(metrics.includes(`${metric.name}{quantile="0.01"`))
+  ok(metrics.includes('http_request_all_summary_seconds{quantile="0.01"'))
+  ok(metrics.includes('http_request_all_summary_seconds{quantile="0.05"'))
+  ok(metrics.includes('http_request_all_summary_seconds{quantile="0.5"'))
+  ok(metrics.includes('http_request_all_summary_seconds{quantile="0.9"'))
+  ok(metrics.includes('http_request_all_summary_seconds{quantile="0.95"'))
+  ok(metrics.includes('http_request_all_summary_seconds{quantile="0.99"'))
+  ok(metrics.includes('http_request_all_summary_seconds{quantile="0.999"'))
+  ok(metrics.includes('http_request_all_summary_seconds_sum{'))
+  ok(metrics.includes('http_request_all_summary_seconds_count{'))
 }
 
 function assertHistogram (metrics, metric) {
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.005"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.01"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.025"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.05"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.1"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.25"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.5"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="1"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="2.5"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="5"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_bucket{le="10"'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_sum{'))
-  assert.ok(metrics.includes('http_request_all_duration_seconds_count{'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.005"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.01"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.025"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.05"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.1"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.25"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="0.5"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="1"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="2.5"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="5"'))
+  ok(metrics.includes('http_request_all_duration_seconds_bucket{le="10"'))
+  ok(metrics.includes('http_request_all_duration_seconds_sum{'))
+  ok(metrics.includes('http_request_all_duration_seconds_count{'))
 }
 
-module.exports = {
-  expectedMetrics,
-  assertMetric
+export function assertMetric (metrics, metric) {
+  ok(metrics.includes(`# HELP ${metric.name} `), `Metric ${metric.name} not found`)
+  ok(metrics.includes(`# TYPE ${metric.name} ${metric.type}`), `Metric ${metric.name} type ${metric.type} not found`)
+
+  if (metric.type === 'summary') {
+    assertSummary(metrics, metric)
+  } else if (metric.type === 'histogram') {
+    assertHistogram(metrics, metric)
+  }
 }

package/test/index.test.js

@@ -1,8 +1,6 @@
-'use strict'
-
-const assert = require('node:assert')
-const { test } = require('node:test')
-const { collectMetrics, client } = require('..')
+import assert from 'node:assert'
+import { test } from 'node:test'
+import { client, collectMetrics } from '../index.js'
 
 const nextTick = () => new Promise(resolve => process.nextTick(resolve))