Should express-zod-api work with @opentelemetry/instrumentation-express?

[rosswarren]

Hello!

I am currently enabling OpenTelemetry with our service, we are getting spans from instrumentation-http but none from instrumentation-express. I am wondering if there is something specific about the way in which express-zod-api is using express that would prevent the automatic instrumentation working or if maybe there is just something else broken on my side. Looking to hear from any others who have tried to get this working!

[RobinTail]

is something specific about the way in which express-zod-api is using express that would prevent the automatic instrumentation working

I can not elaborate — don't know how that thing works, what it needs and how exactly you attach it.

But here is what I see in the documentation:

The current version Express Zod API only supports Express 5.

Perhaps something is misaligned.

[rosswarren]

Thank you, just an update I've written my own middleware instead of using instrumentation-express which has solved my issue. Only thing is I'm not sure if request.route is something I should be accessing or if it's meant to be internal.

import { context, trace } from "@opentelemetry/api";

import { Middleware } from "express-zod-api";
import z from "zod";

/**
 * Middleware to set OpenTelemetry attributes and update span name
 * based on the incoming request.
 */
export const otelMiddleware = new Middleware({
  input: z.object({}),
  handler: async ({ request }) => {
    const activeSpan = trace.getSpan(context.active());

    // The matched route should be the path template in the format used by the respective server framework
    activeSpan?.setAttribute("http.route", request.route.path);

    activeSpan?.updateName(
      `${request.method.toUpperCase()} ${request.route.path}`,
    );

    return {};
  },
});

[RobinTail]

request.route is not internal:
https://expressjs.com/en/5x/api.html#req.route

If you'd like to track requests that do not have matching handlers, consider request.path and moving to beforeRouting config option for that purpose:
https://ez.robintail.cz/v24.7.1/using-native-express-middlewares

Looks good, @rosswarren