feat(sdk-node): wire up metric producers from declarative config by MikeGoldsmith · Pull Request #6712 · open-telemetry/opentelemetry-js

MikeGoldsmith · 2026-05-13T15:23:55Z

Which problem is this PR solving?

The declarative config schema supports producers on periodic metric readers (currently only opencensus), but getMeterReadersFromConfiguration ignores them — producers are never passed to PeriodicExportingMetricReader.

Short description of the changes

Add getMetricProducersFromConfiguration that resolves config model producers to SDK MetricProducer instances
For opencensus: dynamically require('@opentelemetry/shim-opencensus') to avoid a hard dependency — users who configure opencensus producers must install the shim package separately
Warn if the shim package is not installed, or if an unknown producer type is configured
Pass resolved metricProducers to PeriodicExportingMetricReader for both OTLP and console exporters

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

189 sdk-node tests pass. Full lint passes.

Checklist:

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

Closes #6424

Pass the `producers` config to PeriodicExportingMetricReader when creating metric readers from declarative config. Currently only opencensus is defined in the config schema. The implementation dynamically requires @opentelemetry/shim-opencensus at runtime to avoid adding it as a hard dependency — users who configure opencensus producers must install the shim package separately. A warning is emitted if the package is not found. Closes open-telemetry#6424 Assisted-by: Claude Opus 4.6

codecov · 2026-05-13T15:26:24Z

Codecov Report

❌ Patch coverage is 92.85714% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 94.85%. Comparing base (c390f54) to head (9f88a33).
⚠️ Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...ental/packages/opentelemetry-sdk-node/src/utils.ts	92.85%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6712      +/-   ##
==========================================
- Coverage   94.86%   94.85%   -0.02%     
==========================================
  Files         376      377       +1     
  Lines       12717    12765      +48     
  Branches     2884     2891       +7     
==========================================
+ Hits        12064    12108      +44     
- Misses        653      657       +4

Files with missing lines	Coverage Δ
...ental/packages/opentelemetry-sdk-node/src/utils.ts	`97.08% <92.85%> (-0.12%)`	⬇️

... and 5 files 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.

Assisted-by: Claude Opus 4.6

trentm

Just a nit. Not merging yet, to give Mike a chance to address the nit.

…ucer

Export MetricProducer as MetricProducerConfigModel from the configuration package and use it as the function parameter type instead of PeriodicMetricReaderConfigModel['producers']. This decouples the function from PeriodicMetricReader so it can be reused for PullMetricReader later. Assisted-by: Claude Opus 4.6

trentm · 2026-05-15T18:32:12Z

@MikeGoldsmith I broke test/start.test.ts in a mismerge (using the GitHub UI to resolve a conflict).
Here is a fix:

diff --git a/experimental/packages/opentelemetry-sdk-node/test/start.test.ts b/experimental/packages/opentelemetry-sdk-node/test/start.test.ts
index ede4ccd37..8f6021b06 100644
--- a/experimental/packages/opentelemetry-sdk-node/test/start.test.ts
+++ b/experimental/packages/opentelemetry-sdk-node/test/start.test.ts
@@ -986,6 +986,8 @@ describe('startNodeSDK', function () {
         )
       );
       await (reader as PeriodicExportingMetricReader).shutdown();
+    });
+
     it('should warn when exporter timeout is 0', async () => {
       const warnSpy = Sinon.spy(diag, 'warn');
       const exporter = getSpanExporter({

Can you please apply this?
I'm unable to push to your branch:

% git push honeycombio mike/set-meter-producer
ERROR: Permission to honeycombio/opentelemetry-js.git denied to trentm.
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

which I think is (always/often?) the case with corporate forks.

(Aside: I find it inconsistent that I cannot push to this fork, but if there is a merge conflict, the GitHub UI allows me to push a commit along with any edits I've made to that file.)

trentm

See the fix from #6712 (comment) (comment just above) because I mucked up a merge conflict.

Assisted-by: Claude Opus 4.6

MikeGoldsmith · 2026-05-18T13:49:43Z

Thanks @trentm - I've applied the fix, should be good now.

trentm

I'll add to the JS SIG agenda for tomorrow for the side questions I have below.

Approving to remove my block on this, though I think the test case should be updated (see comment below).

trentm · 2026-05-19T22:00:23Z

+        const {
+          OpenCensusMetricProducer,
+          // eslint-disable-next-line @typescript-eslint/no-require-imports
+        } = require('@opentelemetry/shim-opencensus');


This will be one of the very few conditional imports that we have in OTel JS.

FWIW, we currently do this for:

require(): lazy load of @grpc/grpc-js in otlp-grpc-exporter-base to avoid loading it before instrumentation-grpc is possibly in place

await import(): for platform-specific code in packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId.ts

await import(): lazy load of http or https in experimental/packages/otlp-exporter-base/src/transport/http-exporter-transport.ts and experimental/packages/otlp-exporter-base/src/configuration/otlp-node-http-configuration.ts

I think having a dynamic import here is a better option than having a dep on shim-opencensus and always importing it.

Aside: I'm kinda curious if, given https://opentelemetry.io/blog/2023/sunsetting-opencensus/, we could eventually/soon/now remove opencensus support. https://opentelemetry.io/blog/2023/sunsetting-opencensus/#fn:3 mentions supporting the OpenCensus shims for a year. It has been more than a year since the shim-opencensus package was released.

@maryliag Do you happen to know?

Whereever we have Node.js-specific usage docs for declarative config, I think we should add a note that using producers: ["opencensus"] requires the user to separately install the @opentelemetry/shim-opencensus dep.

trentm · 2026-05-19T22:15:59Z

+      });
+      assert.ok(reader !== undefined);
+      await (reader as PeriodicExportingMetricReader).shutdown();
+    });


This test isn't actually testing that the shim producer is working. If I make this change:

diff --git a/experimental/packages/opentelemetry-sdk-node/src/utils.ts b/experimental/packages/opentelemetry-sdk-node/src/utils.ts index d80eb9a36..9495a2d01 100644 --- a/experimental/packages/opentelemetry-sdk-node/src/utils.ts +++ b/experimental/packages/opentelemetry-sdk-node/src/utils.ts @@ -529,7 +529,7 @@ function getMetricProducersFromConfiguration( const { OpenCensusMetricProducer, // eslint-disable-next-line @typescript-eslint/no-require-imports - } = require('@opentelemetry/shim-opencensus'); + } = require('@opentelemetry/shim-opencensusXXX'); result.push(new OpenCensusMetricProducer()); } catch { diag.warn(

the test case still passes.

I think this could cheat and look at reader._metricProducers[0].constructor.name matches "OpenCensusMetricProducer".

MikeGoldsmith requested a review from a team as a code owner May 13, 2026 15:23

add tests for metric producer configuration

1e473e4

Assisted-by: Claude Opus 4.6

trentm approved these changes May 14, 2026

View reviewed changes

Comment thread experimental/packages/opentelemetry-sdk-node/src/utils.ts Outdated

MikeGoldsmith added 2 commits May 15, 2026 12:09

Merge remote-tracking branch 'upstream/main' into mike/set-meter-prod…

cce2e63

…ucer

trentm added this pull request to the merge queue May 15, 2026

github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch May 15, 2026

Merge branch 'main' into mike/set-meter-producer

76f26f3

trentm enabled auto-merge May 15, 2026 18:23

trentm requested changes May 15, 2026

View reviewed changes

fix missing closing brace from merge conflict resolution

9f88a33

Assisted-by: Claude Opus 4.6

auto-merge was automatically disabled May 18, 2026 13:40
Head branch was pushed to by a user without write access

MikeGoldsmith requested a review from trentm May 19, 2026 08:40

maryliag approved these changes May 19, 2026

View reviewed changes

trentm approved these changes May 19, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(sdk-node): wire up metric producers from declarative config#6712

feat(sdk-node): wire up metric producers from declarative config#6712
MikeGoldsmith wants to merge 6 commits into
open-telemetry:mainfrom
honeycombio:mike/set-meter-producer

MikeGoldsmith commented May 13, 2026

Uh oh!

codecov Bot commented May 13, 2026 •

edited

Loading

Uh oh!

trentm left a comment

Uh oh!

Uh oh!

trentm commented May 15, 2026

Uh oh!

trentm left a comment •

edited

Loading

Uh oh!

MikeGoldsmith commented May 18, 2026

Uh oh!

trentm left a comment

Uh oh!

trentm May 19, 2026

Uh oh!

trentm May 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

MikeGoldsmith commented May 13, 2026

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 May 13, 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!

trentm commented May 15, 2026

Uh oh!

trentm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MikeGoldsmith commented May 18, 2026

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

trentm May 19, 2026

Choose a reason for hiding this comment

Uh oh!

trentm May 19, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented May 13, 2026 •

edited

Loading

trentm left a comment •

edited

Loading