@platformatic/metrics 2.56.0 → 2.57.0

package/package.json

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

package/test/helper.js

@@ -0,0 +1,181 @@
+const assert = require('node:assert')
+
+const expectedMetrics = [
+  {
+    name: 'nodejs_active_handles',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_active_handles_total',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_active_requests',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_active_requests_total',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_active_resources',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_active_resources_total',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_max_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_mean_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_min_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_p50_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_p90_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_p99_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_lag_stddev_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_eventloop_utilization',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_external_memory_bytes',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_gc_duration_seconds',
+    type: 'histogram'
+  },
+  {
+    name: 'nodejs_heap_size_total_bytes',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_heap_size_used_bytes',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_heap_space_size_available_bytes',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_heap_space_size_total_bytes',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_heap_space_size_used_bytes',
+    type: 'gauge'
+  },
+  {
+    name: 'nodejs_version_info',
+    type: 'gauge'
+  },
+  {
+    name: 'process_cpu_percent_usage',
+    type: 'gauge'
+  },
+  {
+    name: 'process_cpu_seconds_total',
+    type: 'counter'
+  },
+  {
+    name: 'process_cpu_system_seconds_total',
+    type: 'counter'
+  },
+  {
+    name: 'process_cpu_user_seconds_total',
+    type: 'counter'
+  },
+  {
+    name: 'process_resident_memory_bytes',
+    type: 'gauge'
+  },
+  {
+    name: 'process_start_time_seconds',
+    type: 'gauge'
+  },
+  {
+    name: 'http_request_all_summary_seconds',
+    type: 'summary'
+  },
+  {
+    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) {
+  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_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{'))
+}
+
+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{'))
+}
+
+module.exports = {
+  expectedMetrics,
+  assertMetric
+}