@platformatic/telemetry 2.0.0-alpha.2 → 2.0.0-alpha.21

package/eslint.config.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('neostandard')({})

package/index.js

@@ -2,8 +2,10 @@
 
 const telemetry = require('./lib/telemetry')
 const schema = require('./lib/schema')
+const setupNodeHTTPTelemetry = require('./lib/node-http-telemetry')
 
 module.exports = {
   telemetry,
-  schema
+  schema,
+  setupNodeHTTPTelemetry
 }

package/lib/fastify-text-map.js

@@ -7,16 +7,16 @@ const fastifyTextMapGetter = {
   /* istanbul ignore next */
   keys (request) {
     return Object.keys(request.headers)
-  }
+  },
 }
 
 const fastifyTextMapSetter = {
   set (reply, key, value) {
     reply.headers({ [key]: value })
-  }
+  },
 }
 
 module.exports = {
   fastifyTextMapGetter,
-  fastifyTextMapSetter
+  fastifyTextMapSetter,
 }

package/lib/node-http-telemetry.js

@@ -0,0 +1,33 @@
+'use strict'
+const process = require('node:process')
+const opentelemetry = require('@opentelemetry/sdk-node')
+const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http')
+const { Resource } = require('@opentelemetry/resources')
+const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions')
+const setupTelemetry = require('./telemetry-config')
+
+const setupNodeHTTPTelemetry = (opts, logger) => {
+  const { serviceName } = opts
+  logger.info(`Setting up Node.js HTTP telemetry for service: ${serviceName}`)
+  // We setup the telemetry to init the spanProcessors, then we pass them to the SDK
+  const { spanProcessors } = setupTelemetry(opts, logger)
+  const sdk = new opentelemetry.NodeSDK({
+    spanProcessors, // https://github.com/open-telemetry/opentelemetry-js/issues/4881#issuecomment-2358059714
+    instrumentations: [
+      new HttpInstrumentation(),
+    ],
+    resource: new Resource({
+      [SemanticResourceAttributes.SERVICE_NAME]: serviceName
+    })
+  })
+  sdk.start()
+
+  // gracefully shut down the SDK on process exit
+  process.on('SIGTERM', () => {
+    sdk.shutdown()
+      .then(() => console.log('Tracing terminated'))
+      .catch((error) => console.log('Error terminating tracing', error))
+  })
+}
+
+module.exports = setupNodeHTTPTelemetry

package/lib/platformatic-trace-provider.js

@@ -16,13 +16,13 @@ class PlatformaticTracerProvider {
     const mergedConfig = merge(
       {},
       {
-        sampler: new AlwaysOnSampler()
+        sampler: new AlwaysOnSampler(),
       },
       config
     )
     this.resource = mergedConfig.resource ?? Resource.empty()
     this._config = Object.assign({}, mergedConfig, {
-      resource: this.resource
+      resource: this.resource,
     })
   }
 
@@ -49,8 +49,8 @@ class PlatformaticTracerProvider {
   getPropagator () {
     return new CompositePropagator({
       propagators: [
-        new W3CTraceContextPropagator() // see: https://www.w3.org/TR/trace-context/
-      ]
+        new W3CTraceContextPropagator(), // see: https://www.w3.org/TR/trace-context/
+      ],
     })
   }
 

package/lib/schema.js

@@ -6,7 +6,7 @@ const ExporterSchema = {
     type: {
       type: 'string',
       enum: ['console', 'otlp', 'zipkin', 'memory'],
-      default: 'console'
+      default: 'console',
     },
     options: {
       type: 'object',
@@ -14,16 +14,16 @@ const ExporterSchema = {
       properties: {
         url: {
           type: 'string',
-          description: 'The URL to send the traces to. Not used for console or memory exporters.'
+          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.'
-        }
-      }
+          description: 'Headers to send to the exporter. Not used for console or memory exporters.',
+        },
+      },
     },
-    additionalProperties: false
-  }
+    additionalProperties: false,
+  },
 }
 
 const TelemetrySchema = {
@@ -32,11 +32,11 @@ const TelemetrySchema = {
   properties: {
     serviceName: {
       type: 'string',
-      description: 'The name of the service. Defaults to the folder name if not specified.'
+      description: 'The name of the service. Defaults to the folder name if not specified.',
     },
     version: {
       type: 'string',
-      description: 'The version of the service (optional)'
+      description: 'The version of the service (optional)',
     },
     skip: {
       type: 'array',
@@ -46,28 +46,28 @@ const TelemetrySchema = {
         properties: {
           path: {
             type: 'string',
-            description: 'The path to skip. Can be a string or a regex.'
+            description: 'The path to skip. Can be a string or a regex.',
           },
           method: {
             description: 'HTTP method to skip',
             type: 'string',
-            enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']
-          }
-        }
-      }
+            enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'],
+          },
+        },
+      },
     },
     exporter: {
       anyOf: [
         {
           type: 'array',
-          items: ExporterSchema
+          items: ExporterSchema,
         },
-        ExporterSchema
-      ]
-    }
+        ExporterSchema,
+      ],
+    },
   },
   required: ['serviceName'],
-  additionalProperties: false
+  additionalProperties: false,
 }
 
 module.exports = TelemetrySchema

package/lib/telemetry-config.js

@@ -0,0 +1,81 @@
+'use strict'
+
+const {
+  ConsoleSpanExporter,
+  BatchSpanProcessor,
+  SimpleSpanProcessor,
+  InMemorySpanExporter,
+} = require('@opentelemetry/sdk-trace-base')
+const {
+  SemanticResourceAttributes,
+} = require('@opentelemetry/semantic-conventions')
+const { Resource } = require('@opentelemetry/resources')
+const { PlatformaticTracerProvider } = require('./platformatic-trace-provider')
+
+const { name: moduleName, version: moduleVersion } = require('../package.json')
+
+const setupTelemetry = (opts, logger) => {
+  const { serviceName, version } = opts
+  let exporter = opts.exporter
+  if (!exporter) {
+    logger.warn('No exporter configured, defaulting to console.')
+    exporter = { type: 'console' }
+  }
+
+  const exporters = Array.isArray(exporter) ? exporter : [exporter]
+
+  logger.debug(
+    `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,
+      [SemanticResourceAttributes.SERVICE_VERSION]: version,
+    }),
+  })
+
+  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 }
+
+    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 {
+      logger.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)
+  }
+
+  provider.addSpanProcessor(spanProcessors)
+  const tracer = provider.getTracer(moduleName, moduleVersion)
+  const propagator = provider.getPropagator()
+
+  return { tracer, exporters: exporterObjs, propagator, provider, spanProcessors }
+}
+
+module.exports = setupTelemetry

package/lib/telemetry.js

@@ -2,12 +2,12 @@
 
 const fp = require('fastify-plugin')
 const { SpanStatusCode, SpanKind } = require('@opentelemetry/api')
-const { ConsoleSpanExporter, BatchSpanProcessor, SimpleSpanProcessor, InMemorySpanExporter } = require('@opentelemetry/sdk-trace-base')
-const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions')
-const { Resource } = require('@opentelemetry/resources')
-const { PlatformaticTracerProvider } = require('./platformatic-trace-provider')
 const { PlatformaticContext } = require('./platformatic-context')
-const { fastifyTextMapGetter, fastifyTextMapSetter } = require('./fastify-text-map')
+const {
+  fastifyTextMapGetter,
+  fastifyTextMapSetter,
+} = require('./fastify-text-map')
+const setup = require('./telemetry-config')
 const { formatParamUrl } = require('@fastify/swagger')
 const fastUri = require('fast-uri')
 
@@ -25,9 +25,6 @@ const fastUri = require('fast-uri')
 // Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 // The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-const { name: moduleName, version: moduleVersion } = require('../package.json')
-
 const extractPath = (request) => {
   // We must user RouterPath, because otherwise `/test/123` will be considered as
   // a different operation than `/test/321`. In case is not set (this should actually happen only for HTTP/404) we fallback to the path.
@@ -58,104 +55,53 @@ const formatSpanAttributes = {
       'server.port': urlData.port,
       'http.request.method': method,
       'url.path': path,
-      'url.scheme': protocol
+      'url.scheme': protocol,
     }
   },
   reply (reply) {
     return {
-      'http.response.status_code': reply.statusCode
+      'http.response.status_code': reply.statusCode,
     }
   },
   error (error) {
     return {
       'error.name': error.name,
       'error.message': error.message,
-      'error.stack': error.stack
-    }
-  }
-}
-
-const setupProvider = (app, opts) => {
-  const { serviceName, version } = opts
-  let exporter = opts.exporter
-  if (!exporter) {
-    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,
-      [SemanticResourceAttributes.SERVICE_VERSION]: version
-    })
-  })
-
-  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 }
-
-    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)
+      'error.stack': error.stack,
     }
-
-    // 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)
-  }
-
-  provider.addSpanProcessor(spanProcessors)
-  const tracer = provider.getTracer(moduleName, moduleVersion)
-  const propagator = provider.getPropagator()
-  return { tracer, exporters: exporterObjs, propagator, provider }
+  },
 }
 
 async function setupTelemetry (app, opts) {
-  const openTelemetryAPIs = setupProvider(app, opts)
+  const openTelemetryAPIs = setup(opts, app.log)
   const { tracer, propagator, provider } = openTelemetryAPIs
-  const skipOperations = opts?.skip?.map(skip => {
-    const { method, path } = skip
-    return `${method}${path}`
-  }) || []
+  const skipOperations =
+    opts?.skip?.map((skip) => {
+      const { method, path } = skip
+      return `${method}${path}`
+    }) || []
 
   // expose the span as a request decorator
   app.decorateRequest('span')
 
-  const startSpan = async (request) => {
+  const startHTTPSpan = async (request) => {
     if (skipOperations.includes(`${request.method}${request.url}`)) {
-      request.log.debug({ operation: `${request.method}${request.url}` }, 'Skipping telemetry')
+      request.log.debug(
+        { operation: `${request.method}${request.url}` },
+        'Skipping telemetry'
+      )
       return
     }
 
     // We populate the context with the incoming request headers
-    let context = propagator.extract(new PlatformaticContext(), request, fastifyTextMapGetter)
+    let context = propagator.extract(
+      new PlatformaticContext(),
+      request,
+      fastifyTextMapGetter
+    )
 
     const path = extractPath(request)
-    const span = tracer.startSpan(
-      formatSpanName(request, path),
-      {},
-      context
-    )
+    const span = tracer.startSpan(formatSpanName(request, path), {}, context)
     span.kind = SpanKind.SERVER
     // Next 2 lines are needed by W3CTraceContextPropagator
     context = context.setSpan(span)
@@ -164,7 +110,7 @@ async function setupTelemetry (app, opts) {
     request.span = span
   }
 
-  const setErrorInSpan = async (request, reply, error) => {
+  const setErrorInSpan = async (request, _reply, error) => {
     const span = request.span
     span.setAttributes(formatSpanAttributes.error(error))
   }
@@ -176,7 +122,7 @@ async function setupTelemetry (app, opts) {
     }
   }
 
-  const endSpan = async (request, reply) => {
+  const endHTTPSpan = async (request, reply) => {
     const span = request.span
     if (span) {
       const spanStatus = { code: SpanStatusCode.OK }
@@ -189,9 +135,9 @@ async function setupTelemetry (app, opts) {
     }
   }
 
-  app.addHook('onRequest', startSpan)
+  app.addHook('onRequest', startHTTPSpan)
   app.addHook('onSend', injectPropagationHeadersInReply)
-  app.addHook('onResponse', endSpan)
+  app.addHook('onResponse', endHTTPSpan)
   app.addHook('onError', setErrorInSpan)
   app.addHook('onClose', async function () {
     try {
@@ -206,9 +152,9 @@ async function setupTelemetry (app, opts) {
     const context = span.context
     const headers = {}
     propagator.inject(context, headers, {
-      set (carrier, key, value) {
+      set (_carrier, key, value) {
         headers[key] = value
-      }
+      },
     })
     return headers
   }
@@ -218,12 +164,15 @@ async function setupTelemetry (app, opts) {
   // So the client caller is responible of:
   // - setting the propagatorHeaders in the client request
   // - closing the span
-  const startSpanClient = (url, method, ctx) => {
+  const startHTTPSpanClient = (url, method, ctx) => {
     let context = ctx || new PlatformaticContext()
     const urlObj = fastUri.parse(url)
 
     if (skipOperations.includes(`${method}${urlObj.path}`)) {
-      app.log.debug({ operation: `${method}${urlObj.path}` }, 'Skipping telemetry')
+      app.log.debug(
+        { operation: `${method}${urlObj.path}` },
+        'Skipping telemetry'
+      )
       return
     }
 
@@ -247,7 +196,7 @@ async function setupTelemetry (app, opts) {
           'http.request.method': method,
           'url.full': url,
           'url.path': urlObj.path,
-          'url.scheme': urlObj.scheme
+          'url.scheme': urlObj.scheme,
         }
       : {}
     span.setAttributes(attributes)
@@ -260,7 +209,7 @@ async function setupTelemetry (app, opts) {
     return { span, telemetryHeaders }
   }
 
-  const endSpanClient = (span, response) => {
+  const endHTTPSpanClient = (span, response) => {
     /* istanbul ignore next */
     if (!span) {
       return
@@ -271,13 +220,13 @@ async function setupTelemetry (app, opts) {
         spanStatus.code = SpanStatusCode.ERROR
       }
       span.setAttributes({
-        'http.response.status_code': response.statusCode
+        'http.response.status_code': response.statusCode,
       })
       span.setStatus(spanStatus)
     } else {
       span.setStatus({
         code: SpanStatusCode.ERROR,
-        message: 'No response received'
+        message: 'No response received',
       })
     }
     span.end()
@@ -291,17 +240,17 @@ async function setupTelemetry (app, opts) {
     span.setAttributes(formatSpanAttributes.error(error))
   }
 
-  // The attributes are specific for the "internal" usage, so they must be set by the caller
-  const startInternalSpan = (name, ctx, attributes = {}) => {
+  // In the generic "startSpan" the attributes here are specified by the caller
+  const startSpan = (name, ctx, attributes = {}, kind = SpanKind.INTERNAL) => {
     const context = ctx || new PlatformaticContext()
     const span = tracer.startSpan(name, {}, context)
-    span.kind = SpanKind.INTERNAL
+    span.kind = kind
     span.setAttributes(attributes)
     span.context = context
     return span
   }
 
-  const endInternalSpan = (span, error) => {
+  const endSpan = (span, error) => {
     /* istanbul ignore next */
     if (!span) {
       return
@@ -309,7 +258,7 @@ async function setupTelemetry (app, opts) {
     if (error) {
       span.setStatus({
         code: SpanStatusCode.ERROR,
-        message: error.message
+        message: error.message,
       })
     } else {
       const spanStatus = { code: SpanStatusCode.OK }
@@ -320,11 +269,12 @@ async function setupTelemetry (app, opts) {
 
   app.decorate('openTelemetry', {
     ...openTelemetryAPIs,
-    startSpanClient,
-    endSpanClient,
+    startHTTPSpanClient,
+    endHTTPSpanClient,
     setErrorInSpanClient,
-    startInternalSpan,
-    endInternalSpan
+    startSpan,
+    endSpan,
+    SpanKind,
   })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/telemetry",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.21",
   "description": "OpenTelemetry integration for Platformatic",
   "main": "index.js",
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",
@@ -10,25 +10,28 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "borp": "^0.16.0",
-    "fastify": "^4.26.2",
-    "snazzy": "^9.0.0",
-    "standard": "^17.1.0"
+    "borp": "^0.17.0",
+    "fastify": "^5.0.0",
+    "express": "^4.19.2",
+    "neostandard": "^0.11.1",
+    "typescript": "^5.5.4"
   },
   "dependencies": {
-    "@fastify/swagger": "^8.14.0",
+    "@fastify/swagger": "^9.0.0",
     "@opentelemetry/api": "^1.8.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.50.0",
     "@opentelemetry/core": "^1.22.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.52.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.53.0",
     "@opentelemetry/exporter-zipkin": "^1.22.0",
     "@opentelemetry/resources": "^1.22.0",
+    "@opentelemetry/sdk-node": "^0.53.0",
     "@opentelemetry/sdk-trace-base": "^1.22.0",
     "@opentelemetry/semantic-conventions": "^1.22.0",
     "fast-uri": "^2.3.0",
-    "fastify-plugin": "^4.5.1"
+    "fastify-plugin": "^5.0.0"
   },
   "scripts": {
-    "test": "npm run lint | snazzy && borp",
-    "lint": "standard | snazzy"
+    "test": "npm run lint && borp",
+    "lint": "eslint"
   }
 }