feat(subscribers): update pino subscriber to use native tracing channel (pino >= v9.10.0)

lib/subscribers/pino/index.js

@@ -6,15 +6,33 @@
 'use strict'
 const ApplicationLogsSubscriber = require('../application-logs')
 const { truncate } = require('../../util/application-logging')
+const semver = require('semver')
+
+const NATIVE_CHANNEL_MIN_VERSION = '9.10.0'
+const NATIVE_CHANNEL_NAME = 'pino.logger'
+const LEGACY_CHANNEL_NAME = 'nr_asJson'
 
 class PinoSubscriber extends ApplicationLogsSubscriber {
   constructor({ agent, logger }) {
-    super({ agent, logger, packageName: 'pino', channelName: 'nr_asJson' })
+    super({ agent, logger, packageName: 'pino', channelName: LEGACY_CHANNEL_NAME })
     this.events = ['end']
+    this._useNativeChannel = false
+  }
+
+  subscribe(pinoVersion) {
+    if (pinoVersion && semver.gte(pinoVersion, NATIVE_CHANNEL_MIN_VERSION)) {
+      this._useNativeChannel = true
+      this.channelName = NATIVE_CHANNEL_NAME
+      this.events = ['start', 'end']
+    }
+    super.subscribe()
   }
 
   handler(data, ctx) {
     this.createModuleUsageMetric('pino')
+    if (this._useNativeChannel) {
+      return this._nativeHandler(data, ctx)
+    }
     const { self, arguments: args } = data
     const level = self?.levels?.labels?.[args[2]]
     this.incrementLinesMetric(level)
@@ -23,6 +41,28 @@ class PinoSubscriber extends ApplicationLogsSubscriber {
     return ctx
   }
 
+  _nativeHandler(data, ctx) {
+    const { thisArg: self, args } = data
+    const level = self?.levels?.labels?.[args[2]]
+    this.incrementLinesMetric(level)
+    const useMergeObj = this._nativeDecorateLogLine({ self, args })
+    ctx.extras = { useMergeObj }
+    return ctx
+  }
+
+  _nativeDecorateLogLine({ self, args }) {
+    const useMergeObj = args[1] === undefined && Object.hasOwn(args[0], 'msg')
+    const meta = super.decorateLogLine()
+    if (meta) {
+      if (useMergeObj === true) {
+        args[0].msg += this.agent.getNRLinkingMetadata()
+      } else {
+        args[1] += this.agent.getNRLinkingMetadata()
+      }
+    }
+    return useMergeObj
+  }
+
   decorateLogLine(data) {
     // Pino log methods accept a singular object (a merging object) that can
     // have a `msg` property for the log message. In such cases, we need to
@@ -39,10 +79,71 @@ class PinoSubscriber extends ApplicationLogsSubscriber {
     return useMergeObj
   }
 
+  start(data) {
+    if (this._useNativeChannel) {
+      const ctx = {}
+      this._nativeHandler(data, ctx)
+      data.__nrCtx = ctx
+    }
+  }
+
   end(data) {
+    if (this._useNativeChannel) {
+      this._nativeEnd(data)
+      return
+    }
     this.forwardLogLine(data)
   }
 
+  _nativeEnd(data) {
+    const ctx = data.__nrCtx || {}
+    delete data.__nrCtx
+    this._nativeForwardLogLine(data, ctx)
+  }
+
+  _nativeForwardLogLine(data, ctx) {
+    const { thisArg: self, args, result: logLine } = data
+    if (!logLine) {
+      return
+    }
+    const reformatted = this._nativeReformatLogLine({ self, args, logLine }, ctx)
+    if (reformatted) {
+      this.agent.logs.add(reformatted)
+    }
+  }
+
+  _nativeReformatLogLine({ self, args, logLine }, ctx) {
+    const subscriber = this
+    const msg = ctx?.extras?.useMergeObj === true ? args[0].msg : args[1]
+    const level = self?.levels?.labels?.[args[2]]
+    const metadata = this.agent.getLinkingMetadata(true)
+    const agentMeta = Object.assign({}, { timestamp: Date.now() }, metadata)
+    // eslint-disable-next-line eqeqeq
+    if (msg != undefined) {
+      agentMeta.message = msg
+    }
+    return function formatLogLine() {
+      let formattedLog
+      try {
+        formattedLog = JSON.parse(logLine)
+      } catch (err) {
+        subscriber.logger.error('Failed to parse log line as json: %s', err.message)
+        return
+      }
+      if (formattedLog.err) {
+        formattedLog['error.message'] = truncate(formattedLog.err.message)
+        formattedLog['error.stack'] = truncate(formattedLog.err.stack)
+        formattedLog['error.class'] = formattedLog.err.type
+        delete formattedLog.err
+      }
+      Object.assign(formattedLog, agentMeta)
+      formattedLog.level = level
+      delete formattedLog.time
+      delete formattedLog.msg
+      return formattedLog
+    }
+  }
+
   /**
    * reformats error and assigns NR context data
    * to log line
@@ -54,6 +155,9 @@ class PinoSubscriber extends ApplicationLogsSubscriber {
   reformatLogLine(data, ctx) {
     const subscriber = this
     const { self, result: logLine, arguments: args } = data
+    if (!logLine) {
+      return
+    }
     const msg = ctx?.extras?.useMergeObj === true ? args[0].msg : args[1]
     const level = self?.levels?.labels?.[args[2]]
     const metadata = this.agent.getLinkingMetadata(true)