refactor(sdk-trace-base, sdk-node): add `TracerProvider` class and use `BasicTracerProvider` in Node SDK by david-luna · Pull Request #6640 · open-telemetry/opentelemetry-js

david-luna · 2026-04-28T15:33:22Z

Which problem is this PR solving?

As mentioned in #5290 (comment) the Node SDK should resolve the tracer provider configuration from the SDK options or the environment if necessary. Also the register method from NodeTracerProvider is not used anymore because Node SDK already registers the propagators and the context manager using the api to register the globally.

If the SDK resolved the config then the following classes are not needed

BasicTracerProvider because it has logic to get configuration from environment vars
NodeTracerProvider because the only specific logic, register method, is unused.

This PR is the 1st one to make SDK Node free from these classes and get it ready for a simple TracerProvider class which doesn't have hidden logic rather than the tracer provider creation.

Refs: #5290
Refs: #6595

Short description of the changes

mark NodeTracerProvider and NodeTracerConfig as deprecated
mark BasicTracerProvider as deprecated
replace imports of NodeTracerProvider to BasicTracerProvider
replace other imports from @opentelemetry/sdk-trace-node to point to @opentelemetry/sdk-trace-base since they are just re-exports.
export a new TracerProvider class which expects the config options resolved falling back to defaults from spec
export TracerProviderOptions interface used in the constructor of the new TracerProvider class.
BasicTracerProvider becomes a wrapper around TracerProvider class providing a merged configuration from user and environment

Type of change

Please delete options that are not relevant.

Refactor (non-breaking change which fixes an issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

npm run compile
npm run test

Checklist:

Followed the style guidelines of this project
Unit tests have been updated

codecov · 2026-04-28T15:35:58Z

Codecov Report

❌ Patch coverage is 95.55556% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.87%. Comparing base (988e765) to head (1b256ca).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...opentelemetry-sdk-trace-base/src/TracerProvider.ts	94.93%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6640      +/-   ##
==========================================
+ Coverage   94.85%   94.87%   +0.01%     
==========================================
  Files         377      378       +1     
  Lines       12751    12789      +38     
  Branches     2887     2903      +16     
==========================================
+ Hits        12095    12133      +38     
  Misses        656      656

Files with missing lines	Coverage Δ
...imental/packages/opentelemetry-sdk-node/src/sdk.ts	`95.90% <100.00%> (-0.03%)`	⬇️
...elemetry-sdk-trace-base/src/BasicTracerProvider.ts	`100.00% <100.00%> (+6.45%)`	⬆️
...telemetry-sdk-trace-node/src/NodeTracerProvider.ts	`100.00% <ø> (ø)`
...opentelemetry-sdk-trace-base/src/TracerProvider.ts	`94.93% <94.93%> (ø)`

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

trentm

Unsolicited feedback. I know this is still in draft. :)

trentm · 2026-05-05T17:23:14Z

@@ -24,105 +23,30 @@ export enum ForceFlushState {
 /**
 * This class represents a basic tracer provider which platform libraries can extend


The PR desc suggests you were going to mark this class as deprecated.

right, I'll add the deprecation mark

commit 49b3cfc

Thanks. However if we don't have a replacement yet, should we not deprecate it yet?
My (minor) concern is that users of BasicTracerProvider will get a deprecation marker in their editor/lint output (maybe), but without an alternative to use yet.

Or I suppose you could point to the TracerProvider being adding in this PR, but warning users that it no longer handles reading env vars. Hrm. That's not yet satisfying.

Eventually perhaps there is a createTracerProviderFromEnv() or similar function export from the sdk-node package.

My (minor) concern is that users of BasicTracerProvider will get a deprecation marker in their editor/lint output (maybe), but without an alternative to use yet.

I think it's a valid concern. What we can do is:

remove the deprecation

move on with SDK 3.0

once published add the deprecation notice and do a 2.X release

I suppose we won't consider dropping BasicTracerProvider in 3.0, because it is coming so soon?

If so, then yes, deprecating it some time after SDK 3.0 is released sounds good.

trentm · 2026-05-05T17:31:16Z

+/**
+ * TracerProviderConfig provides an interface for configuring a Tracer Provider.
+ */
+export type TracerProviderConfig = TracerConfig;


This reminds me of #6469

I'll rename it to TracerProviderOptions then :)

commit 49b3cfc

TracerProviderConfig is fine. The issue is that TracerConfig is currently being used (as config for a TracerProvider) in the existing released packages for something different than what the spec now uses TracerConfig for (as config for a Tracer).

The issue is that TracerConfig is currently being used (as config for a TracerProvider)...

I thought on changing the name but I think it can wait to the new major.

trentm

Just a partial review. I have to run and don't want to forget to submit this so far.

trentm · 2026-05-16T00:02:47Z

Perhaps also get the sdk-trace-node usages in the instr-http and instr-grpc README.md files?

Can the sdk-trace-node devDep be removed from those package.json files?

Perhaps also get the sdk-trace-node usages in the instr-http and instr-grpc README.md files?

commit 48a35b7

Can the sdk-trace-node devDep be removed from those package.json files?

yes, thanks for pointing it. commit 78aeba6

trentm · 2026-05-16T00:06:29Z


 * test(otlp-transformer): add metrics transform benchmark [#6628](https://github.com/open-telemetry/opentelemetry-js/pull/6628) @pichlermarc
 * refactor(opentelemetry-exporter-prometheus): do not call enforcePrometheusNamingConvention() multiple times per metric [#6636](https://github.com/open-telemetry/opentelemetry-js/pull/6636) @cjihrig
+* refactor(sdk-node): replace usage of `NodeTracerProvider` for `BasicTracerProvider` in SDK start [#6640](https://github.com/open-telemetry/opentelemetry-js/pull/6640) @david-luna


Reminder to move this up to the top Unreleased section when close to merging.

trentm · 2026-05-16T00:08:35Z

@@ -24,105 +23,30 @@ export enum ForceFlushState {
 /**
 * This class represents a basic tracer provider which platform libraries can extend


Thanks. However if we don't have a replacement yet, should we not deprecate it yet?
My (minor) concern is that users of BasicTracerProvider will get a deprecation marker in their editor/lint output (maybe), but without an alternative to use yet.

Or I suppose you could point to the TracerProvider being adding in this PR, but warning users that it no longer handles reading env vars. Hrm. That's not yet satisfying.

Eventually perhaps there is a createTracerProviderFromEnv() or similar function export from the sdk-node package.

trentm · 2026-05-16T00:15:04Z

 import { reconfigureLimits } from './utility';
+import { TracerProvider } from './TracerProvider';

 export enum ForceFlushState {


Guessing this can be dropped. I didn't check if all uses in this file were removed, and moved to TracerProvider.ts

trentm · 2026-05-16T00:15:54Z

+import { AlwaysOnSampler } from './sampler/AlwaysOnSampler';
+import { RandomIdGenerator } from './platform';
+
+export enum ForceFlushState {


Does this need to be exported? This could totally be addressed in a separate PR. I know you are copying BasicTracerProvider.ts with minimal changes.

New @opentelemetry/sdk-trace pacakge will have this export but it is not necessary to export this class right now.

commit 86d391e

That commit stops exporting TracerProvider. I was talking about whether enum ForceFlushState needs to be exported. AFAICT it is only used internally in this file.

trentm · 2026-05-19T20:09:34Z

 const { XMLHttpRequestInstrumentation } = require('@opentelemetry/instrumentation-xml-http-request');
 const { WebTracerProvider } = require('@opentelemetry/sdk-trace-web');

+// XXX


Should this be removed or replaced?

trentm · 2026-05-19T20:12:29Z

@@ -24,105 +23,30 @@ export enum ForceFlushState {
 /**
 * This class represents a basic tracer provider which platform libraries can extend


I suppose we won't consider dropping BasicTracerProvider in 3.0, because it is coming so soon?

If so, then yes, deprecating it some time after SDK 3.0 is released sounds good.

trentm · 2026-05-19T20:14:38Z

+import { AlwaysOnSampler } from './sampler/AlwaysOnSampler';
+import { RandomIdGenerator } from './platform';
+
+export enum ForceFlushState {


That commit stops exporting TracerProvider. I was talking about whether enum ForceFlushState needs to be exported. AFAICT it is only used internally in this file.

chore(sdk-node): move away from sdk-trace-node

51bcdd9

david-luna added this to the SDK 3.0 milestone Apr 28, 2026

david-luna added sdk:traces Issues and PRs related to the Traces SDK pkg:sdk-node labels Apr 28, 2026

david-luna marked this pull request as ready for review April 28, 2026 17:15

david-luna requested a review from a team as a code owner April 28, 2026 17:15

david-luna added 3 commits April 28, 2026 19:29

chore: update changelog

866ef94

chore(sdk-trace-base): add TracerProvider class

4f0099e

Merge branch 'main' into sdk-node-basic-trace-provider

191e845

david-luna marked this pull request as draft May 4, 2026 14:50

david-luna changed the title ~~chore(sdk-node): move away from @opentelemetry/sdk-trace-node~~ refactor(sdk-trace-base, sdk-node): add TracerProvider class and resolve traces config from env in Node SDK May 4, 2026

trentm reviewed May 5, 2026

View reviewed changes

david-luna changed the title ~~refactor(sdk-trace-base, sdk-node): add TracerProvider class and resolve traces config from env in Node SDK~~ refactor(sdk-trace-base, sdk-node): add TracerProvider class and use BasicTracerProvider in Node SDK May 6, 2026

chore: restore exports

49b3cfc

david-luna marked this pull request as ready for review May 6, 2026 07:41

chore: add exports

1e7860e

david-luna mentioned this pull request May 6, 2026

Rename TracerConfig out of the way for eventual TracerConfig used by TracerConfigurator #6469

Open

david-luna requested a review from trentm May 6, 2026 07:52

david-luna self-assigned this May 6, 2026

david-luna mentioned this pull request May 6, 2026

[sdk-trace-*] remove env-var configuration #6595

Open

1 task

pichlermarc self-assigned this May 6, 2026

trentm reviewed May 16, 2026

View reviewed changes

david-luna added 5 commits May 18, 2026 12:29

Merge branch 'main' into sdk-node-basic-trace-provider

b831f01

chore: remove remainig references to sdk-trace-node

78aeba6

chore: put back missing dependency

09b5d31

chore: update docs

48a35b7

chore: remove internal export

86d391e

david-luna requested a review from trentm May 19, 2026 10:48

chore: fix lint issue

1b256ca

trentm reviewed May 19, 2026

View reviewed changes

		@@ -24,105 +23,30 @@ export enum ForceFlushState {
		/**
		* This class represents a basic tracer provider which platform libraries can extend

Conversation

david-luna commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Which problem is this PR solving?

Short description of the changes

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

codecov Bot commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

david-luna commented Apr 28, 2026 •

edited

Loading

codecov Bot commented Apr 28, 2026 •

edited

Loading