@platformatic/telemetry 2.74.3 → 3.0.0-alpha.2

package/lib/file-span-exporter.js

@@ -1,21 +1,15 @@
 'use strict'
 
-const {
-  ExportResultCode,
-  hrTimeToMicroseconds,
-} = require('@opentelemetry/core')
-const path = require('node:path')
+const { ExportResultCode, hrTimeToMicroseconds } = require('@opentelemetry/core')
+const { resolve: resolvePath } = require('node:path')
 const { appendFileSync } = require('node:fs')
+const { workerData } = require('node:worker_threads')
 
 // Export spans to a file, mostly for testing purposes.
 class FileSpanExporter {
   #path
   constructor (opts) {
-    if (!opts.path) {
-      this.#path = path.resolve('spans.log')
-    } else {
-      this.#path = opts.path
-    }
+    this.#path = resolvePath(workerData?.dirname ?? process.cwd(), opts.path ?? 'spans.log')
   }
 
   export (spans, resultCallback) {
@@ -36,7 +30,11 @@ class FileSpanExporter {
   #exportInfo (span) {
     return {
       traceId: span.spanContext().traceId,
-      parentId: span.parentSpanId,
+      // parentId has been removed from otel 2.0, we need to get it from parentSpanContext
+      parentSpanContext: {
+        traceId: span.parentSpanContext?.traceId,
+        spanId: span.parentSpanContext?.spanId
+      },
       traceState: span.spanContext().traceState?.serialize(),
       name: span.name,
       id: span.spanContext().spanId,
@@ -48,7 +46,8 @@ class FileSpanExporter {
       events: span.events,
       links: span.links,
       resource: span.resource,
-      instrumentationLibrary: span.instrumentationLibrary,
+      // instrumentationLibrary is deprecated in otel 2.0, we need to use instrumentationScope
+      instrumentationScope: span.instrumentationLibrary || span.instrumentationScope
     }
   }
 }

package/lib/node-telemetry.js

@@ -1,15 +1,15 @@
 'use strict'
 
 const process = require('node:process')
+const { resourceFromAttributes } = require('@opentelemetry/resources')
 const { AsyncLocalStorage } = require('node:async_hooks')
 const opentelemetry = require('@opentelemetry/sdk-node')
-const { Resource } = require('@opentelemetry/resources')
 const FileSpanExporter = require('./file-span-exporter')
 const { ATTR_SERVICE_NAME } = require('@opentelemetry/semantic-conventions')
 const { workerData } = require('node:worker_threads')
 const { resolve } = require('node:path')
 const { tmpdir } = require('node:os')
-const logger = require('abstract-logging')
+const { abstractLogger } = require('@platformatic/foundation')
 const { statSync, readFileSync } = require('node:fs') // We want to have all this synch
 const util = require('node:util')
 const { getInstrumentations } = require('./pluggable-instrumentations')
@@ -38,7 +38,7 @@ const setupNodeHTTPTelemetry = async (opts, serviceDir) => {
 
   let exporter = opts.exporter
   if (!exporter) {
-    logger.warn('No exporter configured, defaulting to console.')
+    abstractLogger.warn('No exporter configured, defaulting to console.')
     exporter = { type: 'console' }
   }
   const exporters = Array.isArray(exporter) ? exporter : [exporter]
@@ -64,7 +64,7 @@ const setupNodeHTTPTelemetry = async (opts, serviceDir) => {
     } else if (exporter.type === 'file') {
       exporterObj = new FileSpanExporter(exporterOptions)
     } else {
-      logger.warn(
+      abstractLogger.warn(
         `Unknown exporter type: ${exporter.type}, defaulting to console.`
       )
       exporterObj = new ConsoleSpanExporter(exporterOptions)
@@ -99,7 +99,7 @@ const setupNodeHTTPTelemetry = async (opts, serviceDir) => {
       new HttpInstrumentation(),
       ...additionalInstrumentations
     ],
-    resource: new Resource({
+    resource: resourceFromAttributes({
       [ATTR_SERVICE_NAME]: serviceName
     })
   })

package/lib/platformatic-trace-provider.js

@@ -1,8 +1,10 @@
 'use strict'
 
-const { Resource } = require('@opentelemetry/resources')
-const { AlwaysOnSampler, merge, CompositePropagator, W3CTraceContextPropagator } = require('@opentelemetry/core')
-const { Tracer } = require('@opentelemetry/sdk-trace-base')
+const { emptyResource } = require('@opentelemetry/resources')
+const { merge, CompositePropagator, W3CTraceContextPropagator } = require('@opentelemetry/core')
+const { AlwaysOnSampler } = require('@opentelemetry/sdk-trace-base')
+// We need to import the Tracer to write our own TracerProvider that does NOT extend the OpenTelemetry one.
+const { Tracer } = require('@opentelemetry/sdk-trace-base/build/src/Tracer')
 const { MultiSpanProcessor } = require('./multispan-processor')
 
 class PlatformaticTracerProvider {
@@ -20,15 +22,15 @@ class PlatformaticTracerProvider {
       },
       config
     )
-    this.resource = mergedConfig.resource ?? Resource.empty()
+    this.resource = mergedConfig.resource ?? emptyResource
     this._config = Object.assign({}, mergedConfig, {
       resource: this.resource,
     })
   }
 
   // This is the only mandatory API: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#get-a-tracer
-  getTracer (name, version, options) {
-    return new Tracer({ name, version }, this._config, this)
+  getTracer (name, version) {
+    return new Tracer({ name, version }, this._config, this.resource, this.activeSpanProcessor)
   }
 
   addSpanProcessor (spanProcessor) {
@@ -56,7 +58,6 @@ class PlatformaticTracerProvider {
 
   forceFlush () {
     // Let's do a fire-and-forget of forceFlush on all the processor for the time being.
-    // TODO: manage errors
     this._registeredSpanProcessors.forEach(spanProcessor => spanProcessor.forceFlush())
   }
 

package/lib/schema.js

@@ -1,4 +1,4 @@
 'use strict'
 
-const { schemaComponents } = require('@platformatic/utils')
+const { schemaComponents } = require('@platformatic/foundation')
 module.exports = schemaComponents.telemetry

package/lib/telemetry-config.js

@@ -18,7 +18,7 @@ const {
 
 const FileSpanExporter = require('./file-span-exporter')
 
-const { Resource } = require('@opentelemetry/resources')
+const { resourceFromAttributes } = require('@opentelemetry/resources')
 const { PlatformaticTracerProvider } = require('./platformatic-trace-provider')
 
 const { name: moduleName, version: moduleVersion } = require('../package.json')
@@ -98,7 +98,7 @@ const initTelemetry = (opts, logger) => {
   )
 
   const provider = new PlatformaticTracerProvider({
-    resource: new Resource({
+    resource: resourceFromAttributes({
       [ATTR_SERVICE_NAME]: serviceName,
       [ATTR_SERVICE_VERSION]: version,
     }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/telemetry",
-  "version": "2.74.3",
+  "version": "3.0.0-alpha.2",
   "description": "OpenTelemetry integration for Platformatic",
   "main": "index.js",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
@@ -11,33 +11,34 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@databases/pg": "^5.5.0",
-    "@opentelemetry/instrumentation-express": "^0.51.0",
-    "@opentelemetry/instrumentation-pg": "^0.54.0",
-    "borp": "^0.20.0",
-    "express": "^4.19.2",
-    "fastify": "^5.0.0",
-    "neostandard": "^0.12.0",
-    "protobufjs": "^7.5.0",
-    "typescript": "^5.5.4"
+    "@opentelemetry/instrumentation-express": "^0.52.0",
+    "@opentelemetry/instrumentation-pg": "^0.55.0",
+    "borp": "^0.20.1",
+    "express": "^5.1.0",
+    "fastify": "^5.4.0",
+    "neostandard": "^0.12.2",
+    "protobufjs": "^7.5.3",
+    "typescript": "^5.9.2"
   },
   "dependencies": {
-    "@fastify/swagger": "^9.0.0",
-    "@opentelemetry/api": "^1.8.0",
-    "@opentelemetry/core": "^1.22.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.57.0",
-    "@opentelemetry/exporter-zipkin": "^1.22.0",
-    "@opentelemetry/instrumentation": "^0.57.0",
-    "@opentelemetry/instrumentation-http": "^0.56.0",
-    "@opentelemetry/instrumentation-undici": "^0.13.0",
-    "@opentelemetry/resources": "^1.22.0",
-    "@opentelemetry/sdk-node": "^0.57.0",
-    "@opentelemetry/sdk-trace-base": "^1.22.0",
-    "@opentelemetry/semantic-conventions": "1.30.0",
-    "abstract-logging": "^2.0.1",
-    "fast-uri": "^3.0.0",
-    "fastify-plugin": "^5.0.0",
-    "@platformatic/config": "2.74.3",
-    "@platformatic/utils": "2.74.3"
+    "@fastify/swagger": "^9.5.1",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/core": "^2.0.1",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.203.0",
+    "@opentelemetry/exporter-zipkin": "^2.0.1",
+    "@opentelemetry/instrumentation": "^0.203.0",
+    "@opentelemetry/instrumentation-http": "^0.203.0",
+    "@opentelemetry/instrumentation-undici": "^0.14.0",
+    "@opentelemetry/resources": "^2.0.1",
+    "@opentelemetry/sdk-node": "^0.203.0",
+    "@opentelemetry/sdk-trace-base": "^2.0.1",
+    "@opentelemetry/semantic-conventions": "1.36.0",
+    "fast-uri": "^3.0.6",
+    "fastify-plugin": "^5.0.1",
+    "@platformatic/foundation": "3.0.0-alpha.2"
+  },
+  "engines": {
+    "node": ">=22.18.0"
   },
   "scripts": {
     "test": "npm run lint && borp --timeout=120000 --concurrency=1",