Suppress instrumentation for specific http requests

[cybodelic]

Hi, i'm trying to suppress instrumenation for some incoming http requests which should be a common use case. My idea is to use a requestHook function on the http plugin config to filter the urls and then use the suppressInstrumentation function. I found examples of this function being used in the SpanProcessors but could not make it work for my case. All layers (http, express, gprc) are still traced and exported when using this code:

const provider = new NodeTracerProvider({
  plugins: {
    http: {
      requestHook: (span, request) => {
        if (request.url === '/probes/readiness' || request.url === '/probes/liveness') {
          context.with(suppressInstrumentation(context.active()), () => {})
         }
      }
    }
  }
})

Help appreciated :-)

[dyladan]

You are probably looking for the ignoreIncomingPaths option to the http plugin documented here https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-plugin-http/README.md#http-plugin-options

const provider = new NodeTracerProvider({
  plugins: {
    http: {
      ignoreIncomingPaths: ["/probes/readiness", "/probes/liveness"],
    },
    https: {
      ignoreIncomingPaths: ["/probes/readiness", "/probes/liveness"],
    },
  }
})

[cybodelic]

After linking api, core & node packages i got rid of the error but ended up not getting any traces at all. I assume functional testing has been conducted and i'm ok with marking this discussion as answered and wait for next release. Also happy to assist with further tests if needed, but then i would need some support or instructions with regards to local setup.

[vmarchaud]

@cybodelic We released the 0.15.0 version that should address this, could you please verify ?

[cybodelic]

@vmarchaud yes, it's working now, no traces for the ignored paths 👍 Unfortunately i had to remove the @opentelemetry/[email protected] as it does not work with 0.15.0most likely due to the breaking changes you've mentioned. I get

TypeError: plugin._tracer.getCurrentSpan is not a function
    at /Users/cybodelic/projects/otel-test-service/node_modules/@opentelemetry/plugin-express/build/src/express.js:141:36

[vmarchaud]

@cybodelic a PR is on-going to publish a fixed version of the plugin with the newest API version: open-telemetry/opentelemetry-js-contrib#315

[cybodelic]

Ok, closing the discussion. Thanks for the great work!

[cybodelic]

The issue has been fixed with release 0.15.0 and now plugin-http suppresses tracing of any downstream calls for ignoreIncomingPaths urls.