fix(sdk-node): pass OTLP HTTP metric config by cyphercodes · Pull Request #6666 · open-telemetry/opentelemetry-js

cyphercodes · 2026-05-02T16:51:26Z

Which problem is this PR solving?

startNodeSDK was creating OTLP HTTP metric exporters from declarative config with only compression wired through, so settings such as endpoint, headers, timeout, TLS, temporality, and histogram aggregation were ignored.

Short description of the changes

Map OTLP HTTP metric exporter declarative config into the exporter constructor options.
Support both headers_list and structured headers, with structured headers taking precedence.
Add regression coverage for connection and aggregation exporter options.
Add an experimental changelog entry.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

cd experimental/packages/opentelemetry-sdk-node && npm run lint
cd experimental/packages/opentelemetry-sdk-node && npm run compile
cd experimental/packages/opentelemetry-sdk-node && npm test -- --grep "passes OTLP HTTP metric exporter"
cd experimental/packages/opentelemetry-sdk-node && npm test (190 passing, 3 pending)
npx markdownlint-cli2 experimental/CHANGELOG.md
git diff --check

Checklist:

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

Signed-off-by: cyphercodes <cyphercodes@users.noreply.github.com>

codecov · 2026-05-04T13:08:14Z

Codecov Report

❌ Patch coverage is 94.87179% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.93%. Comparing base (c0bfea7) to head (7191c49).
⚠️ Report is 7 commits behind head on main.

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

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6666   +/-   ##
=======================================
  Coverage   94.92%   94.93%           
=======================================
  Files         377      377           
  Lines       12817    12840   +23     
  Branches     2924     2929    +5     
=======================================
+ Hits        12167    12190   +23     
  Misses        650      650

Files with missing lines	Coverage Δ
...ental/packages/opentelemetry-sdk-node/src/utils.ts	`97.23% <94.87%> (+0.11%)`	⬆️

🚀 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

Nice. Thanks for taking this. I just have some minor nits.

Heads up that there will be conflicts with #6679 but I can help with merge conflicts.

trentm · 2026-05-07T22:10:28Z


+type OtlpHttpMetricExporterConfigModel = NonNullable<
+  PeriodicMetricReaderConfigModel['exporter']['otlp_http']
+>;


nit: This type could be exported from the configuration package and used directly.

trentm · 2026-05-07T22:20:42Z

+}
+
+function getMetricExporterTemporalityPreference(
+  temporalityPreference: OtlpHttpMetricExporterConfigModel['temporality_preference']


nit: Likewise, we could add an ExporterTemporalityPreferenceConfigModel export from the configuration package.

trentm · 2026-05-07T23:05:38Z

    );
  });

+  it('passes OTLP HTTP metric exporter connection options from configuration', async function () {


nit: Move this it(...) case to a new describe('getPeriodicMetricReaderFromConfiguration', ... section. If I read this correctly, this is currently in the getBatchLogRecordProcessorConfigFromEnv describe block.

trentm · 2026-05-07T23:10:49Z

+    });
+
+    assert.ok(reader);
+    const exporter = getMetricExporterInternals(reader);


Could the same thing be accomplished with a type assertion to any? E.g.:

Suggested change

const exporter = getMetricExporterInternals(reader);

const exporter = (reader as any)._exporter;

I guess I'm expressing a personal preference to avoid defining interface FooInterals types that give the veneer of type safety for spelunking into internal object details.

MikeGoldsmith

This looks good to me, thanks @cyphercodes.

A gap I still see, that I tried to resolve in my accidental duplicate PR (#6707), is the gRPC metric exporter only passes compression. It's missing endpoint, timeout, credentials (TLS), and metadata (headers) — same properties you're now passing for HTTP. This matches the pattern in the trace exporter gRPC path (#6705).

I'd be happy to do a follow-up for the gRPC parameters if you'd prefer to keep this PR scoped to HTTP.

maryliag · 2026-05-19T13:56:28Z

Hey @cyphercodes do you still plan on working on this PR?

cyphercodes · 2026-05-19T17:19:15Z

Updated this PR to resolve the merge conflict with current main.

What changed:

Merged upstream main into the PR branch.
Resolved the conflict in experimental/packages/opentelemetry-sdk-node/test/utils.test.ts by keeping the upstream LoggerProviderOptions rename and preserving the metric exporter aggregation typings added by this PR.

Local verification:

npm ci ✅
npm run version:update ✅
npm --prefix experimental/packages/otlp-transformer run protos ✅
npm --prefix experimental/packages/opentelemetry-sdk-node run compile ✅
npm --prefix experimental/packages/opentelemetry-sdk-node run lint -- --quiet ✅
(cd experimental/packages/opentelemetry-sdk-node && npx mocha test/utils.test.ts) ✅
git diff --check ✅

MikeGoldsmith · 2026-05-27T13:00:26Z

@cyphercodes did you see my message regarding the other paramters to the grpc exporter constructor? Please confirm you don't intend to add them here, and I can do them in a follow-up PR.

cyphercodes · 2026-05-27T14:50:09Z

Updated this PR against current main and resolved the merge conflict in experimental/packages/opentelemetry-sdk-node/src/utils.ts.

Also confirming the gRPC metric exporter constructor params are intentionally left out of this PR to keep this focused on the OTLP HTTP metric config path. Happy for those to be handled in a follow-up PR.

Local verification:

npm ci ✅
npm run version:update ✅
npm --prefix experimental/packages/otlp-transformer run protos ✅
npm --prefix experimental/packages/opentelemetry-sdk-node run compile ✅
npm --prefix experimental/packages/opentelemetry-sdk-node run lint -- --quiet ✅
(cd experimental/packages/opentelemetry-sdk-node && npx mocha test/utils.test.ts) ✅
git diff --check ✅

MikeGoldsmith

Looks good to me. We can do the follow-up work for additional constructor params in a new PR.H

trentm · 2026-05-29T22:27:03Z

[I'd had a number of nits in my review from 3w ago. Did you intended to look into those?

trentm · 2026-06-03T18:20:12Z


 ### :bug: Bug Fixes

+* fix(sdk-node): pass OTLP HTTP metric exporter configuration from declarative config [#6665](https://github.com/open-telemetry/opentelemetry-js/issues/6665) @cyphercodes


This now needs to move up to the unreleased section.

Signed-off-by: cyphercodes <cyphercodes@users.noreply.github.com>

cyphercodes · 2026-06-05T18:45:01Z

Updated this PR to resolve the current merge conflict with main.

What changed:

Merged upstream main into fix/sdk-node-otlp-http-metric-config.
Resolved the conflict in experimental/packages/opentelemetry-sdk-node/src/utils.ts by keeping the OTLP HTTP metric exporter config mapping and upstream's metric producer support.
Preserved upstream exporter timeout validation for metric HTTP exporter config.

Local verification:

npm ci
npm run version:update
npm --prefix experimental/packages/otlp-transformer run protos
npm --prefix experimental/packages/opentelemetry-sdk-node run compile
(cd experimental/packages/opentelemetry-sdk-node && npx mocha test/utils.test.ts) — 56 passing
npm --prefix experimental/packages/opentelemetry-sdk-node run lint -- --quiet
git diff --check

maryliag · 2026-06-08T19:46:27Z

Hi @cyphercodes, there were several comments added by Trent and Mike that you still need to address, your latest commit is merging with master but not addressing any of them.

I also want to take this opportunity for a reminder of OpenTelemetry Generative AI Contribution Policy. The policy allows AI-assisted contributions, but contributors remain responsible for understanding, validating, and meaningfully owning the work they submit. That includes replying on PRs, we would like to hear directly from you, specially replying to other humans that are taking the time to review your contribution, so please avoid just copying AI generated output that don't add value to the conversation.

Thank you!

maryliag · 2026-06-23T15:18:27Z

There has been no activity in this PR, so I will go ahead and close without merging.

@MikeGoldsmith do you want to take over? Let me know if so, and if you want to make changes on top of this PR (in this case I will leave it open) or just create a new one

…ttp-metric-config # Conflicts: # experimental/packages/opentelemetry-sdk-node/test/utils.test.ts

cyphercodes · 2026-06-23T18:03:18Z

Updated this PR against current main and addressed the outstanding review nits.\n\nWhat changed:\n- Resolved the current merge conflict in experimental/packages/opentelemetry-sdk-node/test/utils.test.ts.\n- Exported/used the generated configuration types for OTLP HTTP metric exporter temporality/config.\n- Moved the periodic metric reader tests into their own describe block.\n- Simplified the metric reader test internals cast per review.\n- Moved the changelog entry back to the Unreleased bug fixes section.\n\nVerification run locally:\n- npm ci\n- npm run version:update\n- npm --prefix experimental/packages/otlp-transformer run protos\n- npm --prefix experimental/packages/opentelemetry-sdk-node run compile\n- (cd experimental/packages/opentelemetry-sdk-node && npx mocha test/utils.test.ts) — 54 passing\n- npm --prefix experimental/packages/opentelemetry-sdk-node run lint -- --quiet\n- git diff --check

MikeGoldsmith · 2026-06-24T14:04:31Z

Sorry @cyphercodes, #6814 superseded this and has merged. The linked issue is now closed so I think we should close this PR too.

maryliag · 2026-06-24T20:42:02Z

Closing this issue, per @MikeGoldsmith latest comment

fix(sdk-node): pass OTLP HTTP metric config

ac5a078

Signed-off-by: cyphercodes <cyphercodes@users.noreply.github.com>

cyphercodes requested a review from a team as a code owner May 2, 2026 16:51

trentm reviewed May 7, 2026

View reviewed changes

maryliag mentioned this pull request May 14, 2026

fix(sdk-node): pass all config properties to metric exporters in declarative config #6707

Closed

4 tasks

MikeGoldsmith approved these changes May 14, 2026

View reviewed changes

Merge upstream main into sdk-node OTLP config PR

2ab245d

Merge upstream main into fix/sdk-node-otlp-http-metric-config

7191c49

MikeGoldsmith approved these changes May 28, 2026

View reviewed changes

trentm reviewed Jun 3, 2026

View reviewed changes

Merge upstream main into fix/sdk-node-otlp-http-metric-config

507b9e8

Signed-off-by: cyphercodes <cyphercodes@users.noreply.github.com>

Merge remote-tracking branch 'upstream/main' into fix/sdk-node-otlp-h…

a9a1683

…ttp-metric-config # Conflicts: # experimental/packages/opentelemetry-sdk-node/test/utils.test.ts

maryliag closed this Jun 24, 2026

	const exporter = getMetricExporterInternals(reader);
	const exporter = (reader as any)._exporter;


		### :bug: Bug Fixes

		* fix(sdk-node): pass OTLP HTTP metric exporter configuration from declarative config [#6665](https://github.com/open-telemetry/opentelemetry-js/issues/6665) @cyphercodes

Uh oh!

Conversation

cyphercodes commented May 2, 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 4, 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!

trentm May 7, 2026

Choose a reason for hiding this comment

Uh oh!

trentm May 7, 2026

Choose a reason for hiding this comment

Uh oh!

trentm May 7, 2026

Choose a reason for hiding this comment

Uh oh!

trentm May 7, 2026

Choose a reason for hiding this comment

Uh oh!

MikeGoldsmith left a comment

Choose a reason for hiding this comment

Uh oh!

maryliag commented May 19, 2026

Uh oh!

cyphercodes commented May 19, 2026

Uh oh!

MikeGoldsmith commented May 27, 2026

Uh oh!

cyphercodes commented May 27, 2026

Uh oh!

MikeGoldsmith left a comment

Choose a reason for hiding this comment

Uh oh!

trentm commented May 29, 2026

Uh oh!

trentm Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

cyphercodes commented Jun 5, 2026

Uh oh!

maryliag commented Jun 8, 2026

Uh oh!

maryliag commented Jun 23, 2026

Uh oh!

cyphercodes commented Jun 23, 2026

Uh oh!

MikeGoldsmith commented Jun 24, 2026

Uh oh!

maryliag commented Jun 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented May 4, 2026 •

edited

Loading