feat(sdk-trace-base): add stack trace to operation on ended Span warn…

…ing (#5363)

Co-authored-by: Victor <[email protected]>

CHANGELOG.md

@@ -55,6 +55,8 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se
 
 ### :rocket: (Enhancement)
 
+* feat(sdk-trace-base): add stack trace warning to debug instrumentation [#5363](https://github.com/open-telemetry/opentelemetry-js/pull/5363) @neilfordyce
+
 ### :bug: (Bug Fix)
 
 * fix(sdk-metrics): do not export from `PeriodicExportingMetricReader` when there are no metrics to export. [#5288](https://github.com/open-telemetry/opentelemetry-js/pull/5288) @jacksonweber

packages/opentelemetry-sdk-trace-base/src/Span.ts

@@ -369,8 +369,13 @@ export class SpanImpl implements Span {
 
   private _isSpanEnded(): boolean {
     if (this._ended) {
+      const error = new Error(
+        `Operation attempted on ended Span {traceId: ${this._spanContext.traceId}, spanId: ${this._spanContext.spanId}}`
+      );
+
       diag.warn(
-        `Can not execute the operation on ended Span {traceId: ${this._spanContext.traceId}, spanId: ${this._spanContext.spanId}}`
+        `Cannot execute the operation on ended Span {traceId: ${this._spanContext.traceId}, spanId: ${this._spanContext.spanId}}`,
+        error
       );
     }
     return this._ended;

packages/opentelemetry-sdk-trace-base/test/common/Span.test.ts

@@ -281,6 +281,31 @@ describe('Span', () => {
     });
   });
 
+  it('should log a warning attempting to add event to ended span', () => {
+    const span = new SpanImpl({
+      scope: tracer.instrumentationScope,
+      resource: tracer['_resource'],
+      context: ROOT_CONTEXT,
+      spanContext,
+      name,
+      kind: SpanKind.CLIENT,
+      spanLimits: tracer.getSpanLimits(),
+      spanProcessor: tracer['_spanProcessor'],
+    });
+    span.end();
+
+    const warnStub = sinon.spy(diag, 'warn');
+
+    span.addEvent('oops, too late');
+
+    sinon.assert.calledOnce(warnStub);
+    sinon.assert.calledWith(
+      warnStub,
+      sinon.match(/Cannot execute the operation on ended Span/),
+      sinon.match.instanceOf(Error)
+    );
+  });
+
   describe('setAttribute', () => {
     describe('when default options set', () => {
       it('should set an attribute', () => {