Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alternative to deprecated addSpanProcessor #2615

Closed
satazor opened this issue Dec 25, 2024 · 0 comments
Closed

Alternative to deprecated addSpanProcessor #2615

satazor opened this issue Dec 25, 2024 · 0 comments

Comments

@satazor
Copy link
Contributor

satazor commented Dec 25, 2024

Is your feature request related to a problem? Please describe

I'm using the OpenTelemetry Node SDK to initialize OpenTelemetry because it does most of the work of setting it up. Besides the default span processor, I want to add some more span processors. I was using addSpanProcessor but it was deprecated here: open-telemetry/opentelemetry-js#5134

At first, spanProcessors constructor option of NodeSDK seems designed for this use-case, but it has a shortcoming: you must specify the extra ones plus the default BatchSpanProcessor. However, the BatchSpanProcessor requires an instance of exporter, that it's created automatically for us via environment variables. Currently, it's not feasible to create an exporter based on environment variables without duplicating code, since the code that does it is hidden via private functions, e.g.: _buildExporterFromEnv and _getSpanExporter within BasicTracerProvider class.

Describe the solution you'd like to see

I would like an easy way to add span processors without having to duplicate the initialization of BatchSpanProcessor and the initialization of the exporter based on environment variables.

Approach 1:
Allow spanProcessors to be a function in order to append / prepend processors:

new NodeSDK({
  spanProcessors: (spanProcessors) => [mySpanProcessor, ...spanProcessors],
});

The same logic could be applied to logRecordProcessors .

Approach 2:
Export the necessary functionality to create stuff from env, such as exposing _buildExporterFromEnv, _buildPropagatorFromEnv, etc.

Describe alternatives you've considered

  • Keep using the deprecated addSpanProcessor for now.
  • Duplicate the code necessary to build an exporter from env to set up BatchSpanProcessor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant