chore: Copy OTEL status metadata to segment (#3613)

Author: jsumners-nr

lib/otel/traces/span-processor.js

@@ -15,7 +15,13 @@ const SpanLink = require('#agentlib/spans/span-link.js')
 const TimedEvent = require('#agentlib/spans/timed-event.js')
 const normalizeTimestamp = require('../normalize-timestamp.js')
 const { otelSynthesis } = require('#agentlib/symbols.js')
-const { assignToTarget, buildRuleMappings, extractAttributeValue, processRegex, transformTemplate } = require('./utils.js')
+const {
+  assignToTarget,
+  buildRuleMappings,
+  extractAttributeValue,
+  processRegex,
+  transformTemplate
+} = require('./utils.js')
 const defaultLogger = require('#agentlib/logger.js').child({ component: 'span-processor' })
 
 const {
@@ -58,6 +64,19 @@ module.exports = class NrSpanProcessor {
       const { segment, transaction, rule } = span[otelSynthesis]
       const { instrumentationScope } = span
 
+      // OTEL spans have a status attribute. We copy this information over
+      // to our agent attributes as informational metadata.
+      let code
+      switch (span.status.code) {
+        case 0: { code = 'unset'; break }
+        case 1: { code = 'ok'; break }
+        case 2: { code = 'error'; break }
+      }
+      segment.addAttribute('status.code', code)
+      if (code === 'error') {
+        segment.addAttribute('status.description', span.status.message)
+      }
+
       // We always attach the instrumentation scope data as agent attributes
       // if the OTEL span has them set.
       // See https://opentelemetry.io/docs/specs/otel/common/mapping-to-non-otlp/#instrumentationscope

lib/spans/timed-event.js

@@ -51,6 +51,8 @@ class TimedEvent {
     }
   }
 
+  get [Symbol.toStringTag]() { return 'TimedEvent' }
+
   getIntrinsicAttributes() {
     return this.intrinsics
   }

test/unit/lib/otel/fixtures/index.js

@@ -13,16 +13,23 @@ const {
 } = require('./db-sql')
 const createSpan = require('./span')
 const createHttpClientSpan = require('./http-client')
-const { createRpcServerSpan, createHttpServerSpan } = require('./server')
+const {
+  createFallbackServer,
+  createRpcServerSpan,
+  createHttpServerSpan,
+  createHttpServer1dot23Span
+} = require('./server')
 const { createProducerSpan } = require('./producer')
 const { createConsumerSpan } = require('./consumer')
 
 module.exports = {
   createConsumerSpan,
   createDbSpan,
   createDbClientSpan,
+  createFallbackServer,
   createHttpClientSpan,
   createHttpServerSpan,
+  createHttpServer1dot23Span,
   createMemcachedDbSpan,
   createMongoDbSpan,
   createRedisDbSpan,

test/unit/lib/otel/fixtures/server.js

@@ -10,13 +10,18 @@ const createSpan = require('./span')
 
 const {
   ATTR_HTTP_METHOD,
+  ATTR_HTTP_REQUEST_METHOD,
   ATTR_HTTP_ROUTE,
   ATTR_HTTP_URL,
   ATTR_RPC_METHOD,
   ATTR_RPC_SERVICE,
   ATTR_RPC_SYSTEM,
 } = require('#agentlib/otel/traces/constants.js')
 
+function createFallbackServer({ tracer, name = 'test-span', spanContext }) {
+  return createSpan({ name, kind: SpanKind.SERVER, tracer, spanContext })
+}
+
 function createRpcServerSpan({ tracer, name = 'test-span', spanContext }) {
   const span = createSpan({ name, kind: SpanKind.SERVER, tracer, spanContext })
   span.setAttribute(ATTR_RPC_SYSTEM, 'grpc')
@@ -33,7 +38,17 @@ function createHttpServerSpan({ tracer, name = 'test-span', spanContext }) {
   return span
 }
 
+function createHttpServer1dot23Span({ tracer, name = 'test-span', spanContext }) {
+  const span = createSpan({ name, kind: SpanKind.SERVER, tracer, spanContext })
+  span.setAttribute(ATTR_HTTP_REQUEST_METHOD, 'PUT')
+  span.setAttribute(ATTR_HTTP_ROUTE, '/user/:id')
+  span.setAttribute(ATTR_HTTP_URL, '/user/1')
+  return span
+}
+
 module.exports = {
+  createFallbackServer,
   createHttpServerSpan,
+  createHttpServer1dot23Span,
   createRpcServerSpan
 }