@platformatic/metrics 2.69.0 → 2.70.1

package/index.js

@@ -12,9 +12,6 @@ async function collectMetrics (serviceId, workerId, metricsConfig = {}, registry
     registry = new Registry()
   }
 
-  const httpRequestCallbacks = []
-  const httpResponseCallbacks = []
-
   const labels = { ...metricsConfig.labels, serviceId }
   if (workerId >= 0) {
     labels.workerId = workerId
@@ -28,51 +25,31 @@ async function collectMetrics (serviceId, workerId, metricsConfig = {}, registry
   }
 
   if (metricsConfig.httpMetrics) {
-    {
-      const { startTimer, endTimer } = collectHttpMetrics(registry, {
-        customLabels: ['telemetry_id'],
-        getCustomLabels: req => {
-          const telemetryId = req.headers?.['x-plt-telemetry-id'] ?? 'unknown'
-          return { telemetry_id: telemetryId }
+    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())
         }
-      })
-      httpRequestCallbacks.push(startTimer)
-      httpResponseCallbacks.push(endTimer)
-    }
-
-    {
-      // TODO: check if it's a nodejs environment
-      // Needed for the Meraki metrics
-      const { startTimer, endTimer } = 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())
-          }
+      },
+      summary: {
+        name: 'http_request_all_summary_seconds',
+        help: 'request duration in seconds histogram for all requests',
+        collect: function () {
+          process.nextTick(() => this.reset())
         }
-      })
-      httpRequestCallbacks.push(startTimer)
-      httpResponseCallbacks.push(endTimer)
-    }
+      }
+    })
   }
 
   return {
     registry,
-    startHttpTimer: options => httpRequestCallbacks.forEach(cb => cb(options)),
-    endHttpTimer: options => httpResponseCallbacks.forEach(cb => cb(options))
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/metrics",
-  "version": "2.69.0",
+  "version": "2.70.1",
   "description": "Platformatic Stackable Metrics",
   "main": "index.js",
   "type": "commonjs",

package/test/helper.js

@@ -124,15 +124,7 @@ const expectedMetrics = [
   {
     name: 'http_request_all_duration_seconds',
     type: 'histogram'
-  },
-  {
-    name: 'http_request_duration_seconds',
-    type: 'histogram'
-  },
-  {
-    name: 'http_request_summary_seconds',
-    type: 'summary'
-  },
+  }
 ]
 
 function assertMetric (metrics, metric) {
@@ -148,31 +140,31 @@ function assertMetric (metrics, metric) {
 
 function assertSummary (metrics, metric) {
   assert.ok(metrics.includes(`${metric.name}{quantile="0.01"`))
-  assert.ok(metrics.includes('http_request_summary_seconds{quantile="0.01"'))
-  assert.ok(metrics.includes('http_request_summary_seconds{quantile="0.05"'))
-  assert.ok(metrics.includes('http_request_summary_seconds{quantile="0.5"'))
-  assert.ok(metrics.includes('http_request_summary_seconds{quantile="0.9"'))
-  assert.ok(metrics.includes('http_request_summary_seconds{quantile="0.95"'))
-  assert.ok(metrics.includes('http_request_summary_seconds{quantile="0.99"'))
-  assert.ok(metrics.includes('http_request_summary_seconds{quantile="0.999"'))
-  assert.ok(metrics.includes('http_request_summary_seconds_sum{'))
-  assert.ok(metrics.includes('http_request_summary_seconds_count{'))
+  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{'))
 }
 
 function assertHistogram (metrics, metric) {
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="0.005"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="0.01"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="0.025"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="0.05"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="0.1"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="0.25"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="0.5"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="1"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="2.5"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="5"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_bucket{le="10"'))
-  assert.ok(metrics.includes('http_request_duration_seconds_sum{'))
-  assert.ok(metrics.includes('http_request_duration_seconds_count{'))
+  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{'))
 }
 
 module.exports = {

package/test/index.test.js

@@ -4,12 +4,12 @@ const assert = require('node:assert')
 const { test } = require('node:test')
 const { collectMetrics, client } = require('..')
 
+const nextTick = () => new Promise(resolve => process.nextTick(resolve))
+
 test('returns expected structure', async () => {
   const result = await collectMetrics('test-service', 1, {})
 
   assert.ok(result.registry)
-  assert.equal(typeof result.startHttpTimer, 'function')
-  assert.equal(typeof result.endHttpTimer, 'function')
 })
 
 test('accepts custom registry', async () => {
@@ -59,3 +59,70 @@ test('workerId is NOT included in labels when negative', async () => {
   const [{ values }] = await result.registry.getMetricsAsJSON()
   assert.strictEqual(values[0].labels.workerId, undefined)
 })
+
+test('httpMetrics creates histogram and summary with collect functions', async () => {
+  const result = await collectMetrics('test-service', 1, { httpMetrics: true })
+  const metrics = await result.registry.getMetricsAsJSON()
+
+  const histogram = metrics.find(m => m.name === 'http_request_all_duration_seconds')
+  const summary = metrics.find(m => m.name === 'http_request_all_summary_seconds')
+
+  assert.ok(histogram, 'histogram metric should exist')
+  assert.ok(summary, 'summary metric should exist')
+  assert.strictEqual(histogram.help, 'request duration in seconds summary for all requests')
+  assert.strictEqual(summary.help, 'request duration in seconds histogram for all requests')
+})
+
+test('httpMetrics histogram resets after metric collection', async () => {
+  const result = await collectMetrics('test-service', 1, { httpMetrics: true })
+
+  const metricObjects = result.registry._metrics
+  const histogramMetric = metricObjects.http_request_all_duration_seconds
+
+  histogramMetric.observe({ method: 'GET', telemetry_id: 'test' }, 0.1)
+  histogramMetric.observe({ method: 'GET', telemetry_id: 'test' }, 0.2)
+  histogramMetric.observe({ method: 'GET', telemetry_id: 'test' }, 0.3)
+
+  const metricsBefore = await result.registry.getMetricsAsJSON()
+  const histogramBefore = metricsBefore.find(m => m.name === 'http_request_all_duration_seconds')
+  assert.ok(histogramBefore.values.length > 0, 'histogram should have values before collection')
+
+  await result.registry.metrics()
+
+  await nextTick()
+
+  const metricsAfter = await result.registry.getMetricsAsJSON()
+  const histogramAfter = metricsAfter.find(m => m.name === 'http_request_all_duration_seconds')
+
+  const sum = histogramAfter.values.find(v => v.metricName === 'http_request_all_duration_seconds_sum')
+  const count = histogramAfter.values.find(v => v.metricName === 'http_request_all_duration_seconds_count')
+  assert.strictEqual(sum?.value || 0, 0, 'histogram sum should be reset to 0')
+  assert.strictEqual(count?.value || 0, 0, 'histogram count should be reset to 0')
+})
+
+test('httpMetrics summary resets after metric collection', async () => {
+  const result = await collectMetrics('test-service', 1, { httpMetrics: true })
+
+  const metricObjects = result.registry._metrics
+  const summaryMetric = metricObjects.http_request_all_summary_seconds
+
+  summaryMetric.observe({ method: 'POST', telemetry_id: 'test' }, 0.15)
+  summaryMetric.observe({ method: 'POST', telemetry_id: 'test' }, 0.25)
+  summaryMetric.observe({ method: 'POST', telemetry_id: 'test' }, 0.35)
+
+  const metricsBefore = await result.registry.getMetricsAsJSON()
+  const summaryBefore = metricsBefore.find(m => m.name === 'http_request_all_summary_seconds')
+  assert.ok(summaryBefore.values.length > 0, 'summary should have values before collection')
+
+  await result.registry.metrics()
+
+  await nextTick()
+
+  const metricsAfter = await result.registry.getMetricsAsJSON()
+  const summaryAfter = metricsAfter.find(m => m.name === 'http_request_all_summary_seconds')
+
+  const sum = summaryAfter.values.find(v => v.metricName === 'http_request_all_summary_seconds_sum')
+  const count = summaryAfter.values.find(v => v.metricName === 'http_request_all_summary_seconds_count')
+  assert.strictEqual(sum?.value || 0, 0, 'summary sum should be reset to 0')
+  assert.strictEqual(count?.value || 0, 0, 'summary count should be reset to 0')
+})