Allow programmatically import the `@aws/aws-distro-opentelemetry-node-autoinstrumentation/register` module and customize the NodeSDK

[alexandr2110pro]

I want to be able to setup custom components like sampler, span processors, resource detectors and so on.

Manual NodeSDK setup with @opentelemetry/instrumentation-aws-sdk instrumentation doesn't work in bundled (probably, bundled in a very specific way) apps, like NextJS, for example.

See this ticket and these comments specifically:

• @opentelemetry/instrumentation-aws-sdk doesn't work with NextJS open-telemetry/opentelemetry-js-contrib#2734 (comment)
• @opentelemetry/instrumentation-aws-sdk doesn't work with NextJS open-telemetry/opentelemetry-js-contrib#2734 (comment)

You guys are doing something else on top of the standard NodeSDK setup that makes @opentelemetry/instrumentation-aws-sdk work in the bundled app.

It would be great if you could wrap everything you do in the register.ts in a fn that accepts the configuration options for the NodeSDK and let us call it programmatically.

Something like that:

import { registerAdotInstrumentation } from '@aws/aws-distro-opentelemetry-node-autoinstrumentation';

registerAdotInstrumentation({
  nodeSdkOptions: {
    instrumentations: [
      new FetchInstrumentation(),
      new HttpInstrumentation(),
      new AwsInstrumentation({
        suppressInternalInstrumentation: true,
      }),
    ],
    sampler: new ParentBasedSampler({
      root: new NextJSSampler({
        // base: new AlwaysOnSampler(),
        base: new TraceIdRatioBasedSampler(0.1),
      }),
    }),
  },
});

Please let me know if you want me to make a PR for this myself.

[jj22ee]

Hi, can you let us know what exactly you would want exported?

Today, our register.ts is based off v0.50.0 of OTel's register.ts for their auto-instrumentation.

It is mostly the same, except we plugin our own ApplicationSignals-specific configuration into OTel JS's opentelemetry.NodeSDK.

From the issue that you have linked, it doesn't seem like you need any of the ApplicationSignals span/metrics processors or X-Ray Sampler that we are using here. This means you should be able to rely on OTel's exports to make your own register.ts. If that's not the case, please let us know what changes you would like (or would make in your potential PR).

[mmacaula]

+1 ish, I'm in a situation where I need to initialize programmatically, and would like to use the AwsXRayRemoteSampler but cannot import it easily because its not exported. So if I want the remote sampler, I have no choice but to use register and try to do everything via environment variables. It would be nice to be able to import the utilities and helper classes in this package that are already defined

[jj22ee]

@mmacaula AWSXRayRemoteSampler source code has been contributed to OpenTelemetry JS Contrib, but is still pending release.