refactor logs setup

Author: jsumners-nr

lib/otel/logs/bootstrap-logs.js

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2025 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const logsApi = require('@opentelemetry/api-logs')
+const logsSdk = require('@opentelemetry/sdk-logs')
+const {
+  isApplicationLoggingEnabled,
+  isLogForwardingEnabled,
+  isMetricsEnabled,
+  incrementLoggingLinesMetrics
+} = require('#agentlib/util/application-logging.js')
+
+const defaultLogger = require('../../logger').child({ component: 'opentelemetry-metrics' })
+const SetupSignal = require('../setup-signal.js')
+const NewRelicLoggerProvider = require('./proxying-provider.js')
+const NoOpExporter = require('./no-op-exporter.js')
+const normalizeTimestamp = require('./normalize-timestamp.js')
+const severityToString = require('./severity-to-string.js')
+
+class SetupLogs extends SetupSignal {
+  constructor({ agent, logger = defaultLogger } = {}) {
+    super({ agent, logger })
+
+    if (isApplicationLoggingEnabled(agent.config) === false) {
+      logger.info('application logging disabled, skipping otel logs setup')
+      return
+    }
+
+    agent.metrics
+      .getOrCreateMetric('Supportability/Nodejs/OpenTelemetryBridge/Logs')
+      .incrementCallCount()
+
+    const exporter = new NoOpExporter()
+    const processor = new logsSdk.BatchLogRecordProcessor(exporter)
+    const otelProvider = new logsSdk.LoggerProvider({
+      processors: [processor]
+    })
+    const provider = new NewRelicLoggerProvider({
+      agent,
+      provider: otelProvider,
+      emitHandler: nrEmitHandler
+    })
+    logsApi.logs.setGlobalLoggerProvider(provider)
+
+    function nrEmitHandler(record) {
+      const level = severityToString(record.severityNumber ?? 0)
+      if (isMetricsEnabled(agent.config) === true) {
+        incrementLoggingLinesMetrics(level, agent.metrics)
+      }
+
+      // TODO: if we decide to support local decorating, implement it here
+
+      if (isLogForwardingEnabled(agent.config, agent) === true) {
+        const meta = agent.getLinkingMetadata(true)
+        const timestamp = normalizeTimestamp(record.timestamp)
+        const logData = {
+          message: record.body,
+          level,
+          timestamp,
+          ...record.attributes,
+          ...meta
+        }
+
+        agent.logs.add(logData)
+      }
+    }
+
+    agent.emit('otelLogsBootstrapped')
+  }
+
+  teardown() {
+    logsApi.logs.disable()
+  }
+}
+
+module.exports = SetupLogs

lib/otel/logs/index.js

@@ -6,16 +6,15 @@
 'use strict'
 
 const opentelemetry = require('@opentelemetry/api')
-const logsApi = require('@opentelemetry/api-logs')
 
-const SetupTraces = require('./traces/index.js')
+const SetupLogs = require('./logs/index.js')
 const SetupMetrics = require('./metrics/index.js')
+const SetupTraces = require('./traces/index.js')
 const ContextManager = require('./context-manager')
 const TracePropagator = require('./trace-propagator')
 const defaultLogger = require('../logger').child({ component: 'opentelemetry-bridge' })
 const createOtelLogger = require('./logger')
 const interceptSpanKey = require('./span-key-interceptor')
-const bootstrapLogs = require('./logs/bootstrap-logs')
 
 const signals = []
 
@@ -52,7 +51,8 @@ function setupOtel(agent, logger = defaultLogger) {
   }
 
   if (agent.config.opentelemetry_bridge.logs.enabled === true) {
-    bootstrapLogs({ agent })
+    const signal = new SetupLogs({ agent })
+    signals.push(signal)
   } else {
     logger.debug('`opentelemetry_bridge.logs` is not enabled, skipping')
   }
@@ -74,7 +74,6 @@ function teardownOtel(agent) {
   opentelemetry.context.disable()
   opentelemetry.propagation.disable()
   opentelemetry.diag.disable()
-  logsApi.logs.disable()
 }
 
 module.exports = {

lib/otel/metrics/bootstrap-metrics.js

@@ -9,10 +9,11 @@ const test = require('node:test')
 const assert = require('node:assert')
 const { EventEmitter } = require('node:events')
 
-const bootstrapLogs = require('#agentlib/otel/logs/bootstrap-logs.js')
+const SetupLogs = require('#agentlib/otel/logs/index.js')
 
 test('logs notice when application logging is disabled', () => {
   const agent = {
+    get [Symbol.toStringTag]() { return 'Agent' },
     config: {
       entity_guid: 'guid-123456',
       license_key: 'license-123456',
@@ -36,7 +37,8 @@ test('logs notice when application logging is disabled', () => {
     }
   }
 
-  bootstrapLogs({ agent, logger })
+  const signal = new SetupLogs({ agent, logger })
+  assert.ok(signal)
 
   assert.deepStrictEqual(logs, [['application logging disabled, skipping otel logs setup']])
 })