nextjs - 💡(How to fix) Fix Opentelemetry warnings since v16.2.0 [2 comments, 2 participants]

Cannot execute the operation on ended Span {traceId: 722ebe96aae7b52fa0afa2f06a5110c0, spanId: 4663e719a6a39b15} Error: Operation attempted on ended Span {traceId: 722ebe96aae7b52fa0afa2f06a5110c0, spanId: 4663e719a6a39b15}

Fix Plan

The fix involves ensuring that the parent span is not closed before adding attributes to it.

• Update the custom server to properly handle the span lifecycle:
  • Ensure that the span is not ended prematurely.
  • Use tracer.startSpan to create a new span for each request.
  • Use span.setAttribute to add attributes to the span.
  • End the span after the request is processed.

Example code:

const { Tracer } = require('@opentelemetry/api');
const { NodeTracerProvider } = require('@opentelemetry/node');

const provider = new NodeTracerProvider();
const tracer = provider.getTracer('my-tracer');

// Create a new span for each request
const handleRequest = (req, res) => {
  const span = tracer.startSpan('handle-request');
  // Add attributes to the span
  span.setAttribute('request.method', req.method);
  span.setAttribute('request.path', req.path);

  // Process the request
  // ...

  // End the span after the request is processed
  span.end();
  res.send('Hello World!');
};

Verification

To verify that the fix worked, run the application and check the console for warnings. The warning about attempting to execute an operation on an ended span should be gone.

Extra Tips

• Make sure to properly configure the OpenTelemetry provider and tracer.
• Use the tracer.startSpan method to create a new span for each request.
• Use the span.setAttribute method to add attributes to the span.
• End the span after the request is processed using the span.end method.
• Consider using a library like @opentelemetry/instrumentation-http to automatically instrument HTTP requests.