nextjs - 💡(How to fix) Fix Otel server spans lack required attributes according to the semantic conventions [1 comments, 2 participants]

Fix Plan

To fix the missing net.host.name attribute in server spans, you need to update the OpenTelemetry instrumentation to include this required attribute.

Step-by-Step Solution

1. Update the net.host.name attribute: In your OpenTelemetry configuration, add the net.host.name attribute to the server span. You can do this by using the setAttribute method on the span object.
2. Get the hostname: Use the os module in Node.js to get the hostname of the machine running the application.

Example Code

const os = require('os');
const { trace } = require('@opentelemetry/api');

// Get the hostname
const hostname = os.hostname();

// Create a server span
const span = trace.getTracer('my-tracer').startSpan('my-span');

// Set the net.host.name attribute
span.setAttribute('net.host.name', hostname);

// End the span
span.end();

Integration with Next.js

In your Next.js application, you can integrate this fix by updating the OpenTelemetry instrumentation in the pages/_app.js file or in a separate module that handles tracing.

import { trace } from '@opentelemetry/api';
import os from 'os';

// Get the hostname
const hostname = os.hostname();

// Create a tracer
const tracer = trace.getTracer('my-tracer');

// Update the server span
export function getServerSideProps() {
  const span = tracer.startSpan('my-span');
  span.setAttribute('net.host.name', hostname);
  // ...
  span.end();
  return {
    props: {},
  };
}

Verification

To verify that the fix worked, you can check the server spans created by your application and look for the net.host.name attribute. You can use a tool like Jaeger or Zipkin to visualize the spans and verify that the attribute is present.

Extra Tips

• Make sure to update the OpenTelemetry version to the latest version to ensure compatibility with the latest specifications.
• If you are using a custom tracer, make sure to update the tracer configuration to include the net.host.name attribute.