feat(sdk-trace-base): add configurable depth option to ConsoleSpanExporter

Add optional depth parameter to ConsoleSpanExporter constructor to control
console.dir output depth. Defaults to 3 for backward compatibility.

- Add ConsoleSpanOptions interface with depth parameter
- Add constructor to accept options
- Use configurable depth instead of hardcoded value
- Add tests for default, custom numeric, and null depth values

Author: btomaj

packages/opentelemetry-sdk-trace-base/src/export/ConsoleSpanExporter.ts

@@ -22,6 +22,10 @@ import {
   hrTimeToMicroseconds,
 } from '@opentelemetry/core';
 
+interface ConsoleSpanOptions {
+  depth?: number | null;
+}
+
 /**
  * This is implementation of {@link SpanExporter} that prints spans to the
  * console. This class can be used for diagnostic purposes.
@@ -31,6 +35,12 @@ import {
 
 /* eslint-disable no-console */
 export class ConsoleSpanExporter implements SpanExporter {
+  protected _depth: number | null;
+
+  constructor(options?: ConsoleSpanOptions) {
+    this._depth = typeof options?.depth !== 'undefined' ? options?.depth : 3;
+  }
+
   /**
    * Export spans.
    * @param spans
@@ -93,7 +103,7 @@ export class ConsoleSpanExporter implements SpanExporter {
     done?: (result: ExportResult) => void
   ): void {
     for (const span of spans) {
-      console.dir(this._exportInfo(span), { depth: 3 });
+      console.dir(this._exportInfo(span), { depth: this._depth });
     }
     if (done) {
       return done({ code: ExportResultCode.SUCCESS });

packages/opentelemetry-sdk-trace-base/test/common/export/ConsoleSpanExporter.test.ts

@@ -116,4 +116,57 @@ describe('ConsoleSpanExporter', () => {
       await consoleExporter.forceFlush();
     });
   });
+
+  describe('constructor', () => {
+    it('should use default depth of 3', () => {
+      consoleExporter = new ConsoleSpanExporter();
+      const basicTracerProvider = new BasicTracerProvider({
+        sampler: new AlwaysOnSampler(),
+        spanProcessors: [new SimpleSpanProcessor(consoleExporter)],
+      });
+
+      const spyConsole = sinon.spy(console, 'dir');
+      const tracer = basicTracerProvider.getTracer('test');
+      const span = tracer.startSpan('test-span');
+      span.end();
+
+      const consoleArgs = spyConsole.args[0];
+      const options = consoleArgs[1];
+      assert.strictEqual(options?.depth, 3);
+    });
+
+    it('should use custom depth when provided', () => {
+      consoleExporter = new ConsoleSpanExporter({ depth: 5 });
+      const basicTracerProvider = new BasicTracerProvider({
+        sampler: new AlwaysOnSampler(),
+        spanProcessors: [new SimpleSpanProcessor(consoleExporter)],
+      });
+
+      const spyConsole = sinon.spy(console, 'dir');
+      const tracer = basicTracerProvider.getTracer('test');
+      const span = tracer.startSpan('test-span');
+      span.end();
+
+      const consoleArgs = spyConsole.args[0];
+      const options = consoleArgs[1];
+      assert.strictEqual(options?.depth, 5);
+    });
+
+    it('should use null depth when explicitly provided', () => {
+      consoleExporter = new ConsoleSpanExporter({ depth: null });
+      const basicTracerProvider = new BasicTracerProvider({
+        sampler: new AlwaysOnSampler(),
+        spanProcessors: [new SimpleSpanProcessor(consoleExporter)],
+      });
+
+      const spyConsole = sinon.spy(console, 'dir');
+      const tracer = basicTracerProvider.getTracer('test');
+      const span = tracer.startSpan('test-span');
+      span.end();
+
+      const consoleArgs = spyConsole.args[0];
+      const options = consoleArgs[1];
+      assert.strictEqual(options?.depth, null);
+    });
+  });
 });