@platformatic/telemetry 0.37.0 → 0.37.2

package/lib/platformatic-trace-provider.js

@@ -32,7 +32,11 @@ class PlatformaticTracerProvider {
   }
 
   addSpanProcessor (spanProcessor) {
-    this._registeredSpanProcessors.push(spanProcessor)
+    if (Array.isArray(spanProcessor)) {
+      this._registeredSpanProcessors.push(...spanProcessor)
+    } else {
+      this._registeredSpanProcessors.push(spanProcessor)
+    }
     this.activeSpanProcessor = new MultiSpanProcessor(
       this._registeredSpanProcessors
     )

package/lib/schema.js

@@ -1,5 +1,31 @@
 'use strict'
 
+const ExporterSchema = {
+  type: 'object',
+  properties: {
+    type: {
+      type: 'string',
+      enum: ['console', 'otlp', 'zipkin', 'memory'],
+      default: 'console'
+    },
+    options: {
+      type: 'object',
+      description: 'Options for the exporter. These are passed directly to the exporter.',
+      properties: {
+        url: {
+          type: 'string',
+          description: 'The URL to send the traces to. Not used for console or memory exporters.'
+        },
+        headers: {
+          type: 'object',
+          description: 'Headers to send to the exporter. Not used for console or memory exporters.'
+        }
+      }
+    },
+    additionalProperties: false
+  }
+}
+
 const TelemetrySchema = {
   $id: '/OpenTelemetry',
   type: 'object',
@@ -20,29 +46,13 @@ const TelemetrySchema = {
       }
     },
     exporter: {
-      type: 'object',
-      properties: {
-        type: {
-          type: 'string',
-          enum: ['console', 'otlp', 'zipkin', 'memory'],
-          default: 'console'
-        },
-        options: {
-          type: 'object',
-          description: 'Options for the exporter. These are passed directly to the exporter.',
-          properties: {
-            url: {
-              type: 'string',
-              description: 'The URL to send the traces to. Not used for console or memory exporters.'
-            },
-            headers: {
-              type: 'object',
-              description: 'Headers to send to the exporter. Not used for console or memory exporters.'
-            }
-          }
+      anyOf: [
+        {
+          type: 'array',
+          items: ExporterSchema
         },
-        additionalProperties: false
-      }
+        ExporterSchema
+      ]
     }
   },
   required: ['serviceName'],

package/lib/telemetry.js

@@ -81,7 +81,11 @@ const setupProvider = (app, opts) => {
     app.log.warn('No exporter configured, defaulting to console.')
     exporter = { type: 'console' }
   }
+
+  const exporters = Array.isArray(exporter) ? exporter : [exporter]
+
   app.log.info(`Setting up telemetry for service: ${serviceName}${version ? ' version: ' + version : ''} with exporter of type ${exporter.type}`)
+
   const provider = new PlatformaticTracerProvider({
     resource: new Resource({
       [SemanticResourceAttributes.SERVICE_NAME]: serviceName,
@@ -89,33 +93,40 @@ const setupProvider = (app, opts) => {
     })
   })
 
+  const exporterObjs = []
+  const spanProcessors = []
+  for (const exporter of exporters) {
   // Exporter config:
   // https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_exporter_zipkin.ExporterConfig.html
-  const exporterOptions = { ...exporter.options, serviceName }
+    const exporterOptions = { ...exporter.options, serviceName }
 
-  let exporterObj
-  if (exporter.type === 'console') {
-    exporterObj = new ConsoleSpanExporter(exporterOptions)
-  } else if (exporter.type === 'otlp') {
+    let exporterObj
+    if (exporter.type === 'console') {
+      exporterObj = new ConsoleSpanExporter(exporterOptions)
+    } else if (exporter.type === 'otlp') {
     // We require here because this require (and only the require!) creates some issue with c8 on some mjs tests on other modules. Since we need an assignemet here, we don't use a switch.
-    const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-proto')
-    exporterObj = new OTLPTraceExporter(exporterOptions)
-  } else if (exporter.type === 'zipkin') {
-    const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin')
-    exporterObj = new ZipkinExporter(exporterOptions)
-  } else if (exporter.type === 'memory') {
-    exporterObj = new InMemorySpanExporter()
-  } else {
-    app.log.warn(`Unknown exporter type: ${exporter.type}, defaulting to console.`)
-    exporterObj = new ConsoleSpanExporter(exporterOptions)
+      const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-proto')
+      exporterObj = new OTLPTraceExporter(exporterOptions)
+    } else if (exporter.type === 'zipkin') {
+      const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin')
+      exporterObj = new ZipkinExporter(exporterOptions)
+    } else if (exporter.type === 'memory') {
+      exporterObj = new InMemorySpanExporter()
+    } else {
+      app.log.warn(`Unknown exporter type: ${exporter.type}, defaulting to console.`)
+      exporterObj = new ConsoleSpanExporter(exporterOptions)
+    }
+
+    // We use a SimpleSpanProcessor for the console/memory exporters and a BatchSpanProcessor for the others.
+    const spanProcessor = ['memory', 'console'].includes(exporter.type) ? new SimpleSpanProcessor(exporterObj) : new BatchSpanProcessor(exporterObj)
+    spanProcessors.push(spanProcessor)
+    exporterObjs.push(exporterObj)
   }
 
-  // We use a SimpleSpanProcessor for the console/memory exporters and a BatchSpanProcessor for the others.
-  const spanProcessor = ['memory', 'console'].includes(exporter.type) ? new SimpleSpanProcessor(exporterObj) : new BatchSpanProcessor(exporterObj)
-  provider.addSpanProcessor(spanProcessor)
+  provider.addSpanProcessor(spanProcessors)
   const tracer = provider.getTracer(moduleName, moduleVersion)
   const propagator = provider.getPropagator()
-  return { tracer, exporter: exporterObj, propagator, provider }
+  return { tracer, exporters: exporterObjs, propagator, provider }
 }
 
 async function setupTelemetry (app, opts) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/telemetry",
-  "version": "0.37.0",
+  "version": "0.37.2",
   "description": "OpenTelemetry integration for Platformatic",
   "main": "index.js",
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",

package/test/client.test.js

@@ -14,10 +14,12 @@ async function setupApp (pluginOpts, routeHandler, teardown) {
   app.ready()
   teardown(async () => {
     await app.close()
-    const { exporter } = app.openTelemetry
-    if (exporter.constructor.name === 'InMemorySpanExporter') {
-      exporter.reset()
-    }
+    const { exporters } = app.openTelemetry
+    exporters.forEach(exporter => {
+      if (exporter.constructor.name === 'InMemorySpanExporter') {
+        exporter.reset()
+      }
+    })
   })
   return app
 }
@@ -119,7 +121,8 @@ test('should trace a client request', async ({ equal, same, teardown }) => {
   const response = await app.inject(args)
   endSpanClient(span, response)
 
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 2)
   // We have two one for the client and one for the server
@@ -173,7 +176,9 @@ test('should trace a client request failing', async ({ equal, same, teardown })
   const response = await app.inject(args)
   endSpanClient(span, response)
 
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
+
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 2)
   // We have two one for the client and one for the server
@@ -218,7 +223,8 @@ test('should trace a client request failing (no HTTP error)', async ({ equal, sa
     endSpanClient(span)
   }
 
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 1)
 

package/test/telemetry.test.js

@@ -13,10 +13,12 @@ async function setupApp (pluginOpts, routeHandler, teardown) {
   app.ready()
   teardown(async () => {
     await app.close()
-    const { exporter } = app.openTelemetry
-    if (exporter.constructor.name === 'InMemorySpanExporter') {
-      exporter.reset()
-    }
+    const { exporters } = app.openTelemetry
+    exporters.forEach(exporter => {
+      if (exporter.constructor.name === 'InMemorySpanExporter') {
+        exporter.reset()
+      }
+    })
   })
   return app
 }
@@ -43,7 +45,8 @@ test('should trace a request not failing', async ({ equal, same, teardown }) =>
   }, handler, teardown)
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 1)
   const span = finishedSpans[0]
@@ -82,7 +85,8 @@ test('should not put query in `url.path', async ({ equal, same, teardown }) => {
   }, handler, teardown)
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 1)
   const span = finishedSpans[0]
@@ -114,7 +118,8 @@ test('request should add attribute to a span', async ({ equal, same, teardown })
   }, handler, teardown)
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 1)
   const span = finishedSpans[0]
@@ -164,7 +169,8 @@ test('should trace a request that fails', async ({ equal, same, teardown }) => {
   }, handler, teardown)
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 1)
   const span = finishedSpans[0]
@@ -189,7 +195,8 @@ test('if no exporter is configured, should default to console', async ({ equal,
   }, handler, teardown)
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   same(exporter.constructor.name, 'ConsoleSpanExporter')
 })
 
@@ -208,7 +215,8 @@ test('should configure OTLP correctly', async ({ equal, same, teardown }) => {
     }
   }, handler, teardown)
 
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   same(exporter.constructor.name, 'OTLPTraceExporter')
   same(exporter.url, 'http://localhost:4317')
 })
@@ -228,7 +236,8 @@ test('should configure Zipkin correctly', async ({ equal, same, teardown }) => {
     }
   }, handler, teardown)
 
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   same(exporter.constructor.name, 'ZipkinExporter')
   same(exporter._urlStr, 'http://localhost:9876')
 })
@@ -246,7 +255,8 @@ test('wrong exporter is configured, should default to console', async ({ equal,
   }, handler, teardown)
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   same(exporter.constructor.name, 'ConsoleSpanExporter')
 })
 
@@ -275,7 +285,8 @@ test('should not trace if the operation is skipped', async ({ equal, same, teard
   }
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 0)
 })
@@ -302,7 +313,8 @@ test('should not put the URL param in path', async ({ equal, same, teardown }) =
   }, handler, teardown)
 
   await app.inject(injectArgs)
-  const { exporter } = app.openTelemetry
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 1)
   const span = finishedSpans[0]
@@ -318,3 +330,53 @@ test('should not put the URL param in path', async ({ equal, same, teardown }) =
   same(resource.attributes['service.name'], 'test-service')
   same(resource.attributes['service.version'], '1.0.0')
 })
+
+test('should configure an exporter as an array', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return {}
+  }
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: [{
+      type: 'otlp',
+      options: {
+        url: 'http://localhost:4317'
+      }
+    }]
+  }, handler, teardown)
+  const { exporters } = app.openTelemetry
+  const exporter = exporters[0]
+  same(exporter.constructor.name, 'OTLPTraceExporter')
+  same(exporter.url, 'http://localhost:4317')
+})
+
+test('should use multiple exporters and sent traces to all the exporters', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return {}
+  }
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: [{
+      type: 'memory'
+    }, {
+      type: 'memory'
+    }]
+  }, handler, teardown)
+  const { exporters } = app.openTelemetry
+
+  await app.inject(injectArgs)
+
+  const finishedSpans0 = exporters[0].getFinishedSpans()
+  equal(finishedSpans0.length, 1)
+  const span0 = finishedSpans0[0]
+  equal(span0.name, 'GET /test')
+  equal(span0.status.code, SpanStatusCode.OK)
+
+  const finishedSpans1 = exporters[1].getFinishedSpans()
+  equal(finishedSpans1.length, 1)
+  const span1 = finishedSpans1[0]
+  equal(span1.name, 'GET /test')
+  equal(span1.status.code, SpanStatusCode.OK)
+})