feat(otel-utils): add addAttributesToActiveSpan method (#5587)

Co-authored-by: Michal Piechowiak <[email protected]>

Author: JGAntunes

Diff for: packages/opentelemetry-utils/src/index.ts

@@ -1,7 +1,8 @@
 import { context, Context, propagation, trace, SpanStatusCode, Attributes } from '@opentelemetry/api'
 
 /**
- * Sets attributes to be propagated across child spans under the current active context
+ * Sets attributes to be propagated across child spans under the current active context. Contexts are immutable so the
+ * newly returned context must be used when instantiating a new span for these new properties to be used.
  */
 export const setMultiSpanAttributes = function (attributes: { [key: string]: string }) {
   const currentBaggage = propagation.getBaggage(context.active())
@@ -14,6 +15,18 @@ export const setMultiSpanAttributes = function (attributes: { [key: string]: str
   return propagation.setBaggage(context.active(), baggage)
 }
 
+/**
+ * Add the provided attributes to the current active span (if any).
+ */
+export const addAttributesToActiveSpan = function (attributes?: Attributes) {
+  const span = trace.getActiveSpan()
+  if (!span) return
+
+  if (attributes !== undefined) {
+    span.setAttributes(attributes)
+  }
+}
+
 /**
  * Add error information to the current active span (if any). Optionally sets the provided attributes on the span too.
  */

Diff for: packages/opentelemetry-utils/tests/main.test.ts

@@ -6,6 +6,7 @@ import { expect, test, beforeAll, afterAll } from 'vitest'
 import {
   getGlobalContext,
   setGlobalContext,
+  addAttributesToActiveSpan,
   addEventToActiveSpan,
   addErrorToActiveSpan,
   setMultiSpanAttributes,
@@ -94,6 +95,39 @@ test('addErrorToActiveSpan - attributes are added', async () => {
   })
 })
 
+test('addAttributesToActiveSpan - attributes are added', async () => {
+  const tracer = trace.getTracer('default')
+  const span = tracer.startSpan('my-span') as Span
+  const ctx = trace.setSpan(context.active(), span)
+
+  context.with(ctx, async () => {
+    const attributes = {
+      'build.test': 'something',
+      'build.another-test': 'something-else',
+    }
+    addAttributesToActiveSpan(attributes)
+
+    expect(span.attributes).toStrictEqual(attributes)
+  })
+})
+
+test('addAttributesToActiveSpan - no attributes are added', async () => {
+  const tracer = trace.getTracer('default')
+  const span = tracer.startSpan('my-span') as Span
+  const ctx = trace.setSpan(context.active(), span)
+
+  context.with(ctx, async () => {
+    const attributes = {}
+    expect(() => addAttributesToActiveSpan()).not.toThrowError()
+
+    expect(span.attributes).toStrictEqual(attributes)
+  })
+})
+
+test('addAttributesToActiveSpan - does not throw without active span', async () => {
+  expect(() => addAttributesToActiveSpan()).not.toThrowError()
+})
+
 test('setMultiSpanAttributes - baggage is populated', async () => {
   const ctx = setMultiSpanAttributes({ some: 'test', foo: 'bar' })
   const baggage = propagation.getBaggage(ctx)