@platformatic/metrics 3.13.1 → 3.15.0

package/index.js

@@ -189,6 +189,58 @@ export async function collectMetrics (applicationId, workerId, metricsConfig = {
   }
 
   return {
-    registry
+    registry,
+    otlpBridge: null
   }
 }
+
+export async function setupOtlpExporter (registry, otlpExporterConfig, applicationId) {
+  if (!otlpExporterConfig || !otlpExporterConfig.endpoint) {
+    return null
+  }
+
+  // Check if explicitly disabled
+  if (otlpExporterConfig.enabled === false || otlpExporterConfig.enabled === 'false') {
+    return null
+  }
+
+  // Dynamically import PromClientBridge to defer loading until after telemetry is initialized
+  const { PromClientBridge } = await import('@platformatic/promotel')
+
+  const {
+    endpoint,
+    headers,
+    interval = 60000,
+    serviceName = applicationId,
+    serviceVersion
+  } = otlpExporterConfig
+
+  const otlpEndpointOptions = {
+    url: endpoint
+  }
+
+  if (headers) {
+    otlpEndpointOptions.headers = headers
+  }
+
+  const conversionOptions = {
+    serviceName
+  }
+
+  if (serviceVersion) {
+    conversionOptions.serviceVersion = serviceVersion
+  }
+
+  const bridge = new PromClientBridge({
+    registry,
+    otlpEndpoint: otlpEndpointOptions,
+    interval,
+    conversionOptions,
+    onError: (error) => {
+      // Log error but don't crash the application
+      console.error('OTLP metrics export error:', error)
+    }
+  })
+
+  return bridge
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/metrics",
-  "version": "3.13.1",
+  "version": "3.15.0",
   "description": "Platformatic Capability Metrics",
   "main": "index.js",
   "type": "module",
@@ -16,6 +16,7 @@
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "dependencies": {
     "@platformatic/http-metrics": "^0.2.1",
+    "@platformatic/promotel": "^0.1.0",
     "prom-client": "^15.1.2"
   },
   "devDependencies": {

package/test/otlp.test.js

@@ -0,0 +1,141 @@
+import assert from 'node:assert'
+import { test } from 'node:test'
+import { client, collectMetrics, setupOtlpExporter } from '../index.js'
+
+test('setupOtlpExporter returns null when no config provided', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, null, 'test-app')
+  assert.strictEqual(bridge, null)
+})
+
+test('setupOtlpExporter returns null when no endpoint provided', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, {}, 'test-app')
+  assert.strictEqual(bridge, null)
+})
+
+test('setupOtlpExporter returns null when explicitly disabled', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, {
+    enabled: false,
+    endpoint: 'http://localhost:4318/v1/metrics'
+  }, 'test-app')
+  assert.strictEqual(bridge, null)
+})
+
+test('setupOtlpExporter returns null when disabled via string', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, {
+    enabled: 'false',
+    endpoint: 'http://localhost:4318/v1/metrics'
+  }, 'test-app')
+  assert.strictEqual(bridge, null)
+})
+
+test('setupOtlpExporter creates bridge with minimal config', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, {
+    endpoint: 'http://localhost:4318/v1/metrics'
+  }, 'test-app')
+
+  assert.ok(bridge, 'Bridge should be created')
+  assert.strictEqual(bridge.running, false, 'Bridge should not be running initially')
+
+  const config = bridge.config
+  assert.strictEqual(config.otlpEndpoint.url, 'http://localhost:4318/v1/metrics')
+  assert.strictEqual(config.interval, 60000, 'Default interval should be 60000')
+  assert.strictEqual(config.conversionOptions.serviceName, 'test-app')
+})
+
+test('setupOtlpExporter creates bridge with full config', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, {
+    endpoint: 'http://collector:4318/v1/metrics',
+    headers: {
+      'x-api-key': 'secret123',
+      'x-custom-header': 'value'
+    },
+    interval: 30000,
+    serviceName: 'my-service',
+    serviceVersion: '1.2.3'
+  }, 'test-app')
+
+  assert.ok(bridge, 'Bridge should be created')
+
+  const config = bridge.config
+  assert.strictEqual(config.otlpEndpoint.url, 'http://collector:4318/v1/metrics')
+  assert.deepStrictEqual(config.otlpEndpoint.headers, {
+    'x-api-key': 'secret123',
+    'x-custom-header': 'value'
+  })
+  assert.strictEqual(config.interval, 30000)
+  assert.strictEqual(config.conversionOptions.serviceName, 'my-service')
+  assert.strictEqual(config.conversionOptions.serviceVersion, '1.2.3')
+})
+
+test('setupOtlpExporter uses applicationId as default serviceName', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, {
+    endpoint: 'http://localhost:4318/v1/metrics'
+  }, 'my-app-id')
+
+  assert.ok(bridge, 'Bridge should be created')
+  assert.strictEqual(bridge.config.conversionOptions.serviceName, 'my-app-id')
+})
+
+test('collectMetrics returns registry and null otlpBridge', async () => {
+  const result = await collectMetrics('test-service', 1, {
+    defaultMetrics: false,
+    httpMetrics: false
+  })
+
+  assert.ok(result.registry)
+  assert.strictEqual(result.otlpBridge, null)
+})
+
+test('bridge lifecycle - start and stop', async () => {
+  const registry = new client.Registry()
+  const bridge = await setupOtlpExporter(registry, {
+    endpoint: 'http://localhost:4318/v1/metrics',
+    interval: 60000
+  }, 'test-app')
+
+  assert.ok(bridge, 'Bridge should be created')
+  assert.strictEqual(bridge.running, false, 'Should not be running initially')
+
+  // Start bridge
+  bridge.start()
+  assert.strictEqual(bridge.running, true, 'Should be running after start')
+
+  // Stop bridge
+  bridge.stop()
+  assert.strictEqual(bridge.running, false, 'Should not be running after stop')
+})
+
+test('bridge handles errors gracefully', async () => {
+  const registry = new client.Registry()
+
+  // Add a test metric
+  const counter = new client.Counter({
+    name: 'test_counter',
+    help: 'Test counter',
+    registers: [registry]
+  })
+  counter.inc(5)
+
+  const bridge = await setupOtlpExporter(registry, {
+    endpoint: 'http://invalid-endpoint-that-does-not-exist:9999/v1/metrics',
+    interval: 1000 // Short interval for testing
+  }, 'test-app')
+
+  assert.ok(bridge, 'Bridge should be created')
+
+  // The bridge should not crash the app even with invalid endpoint
+  // Errors are logged but don't throw
+  bridge.start()
+  assert.strictEqual(bridge.running, true)
+
+  // Clean up
+  bridge.stop()
+  assert.strictEqual(bridge.running, false)
+})