Skip to content

refactor!(otlp-grpc-exporter-base): remove headers from gRPC config type #6487

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.

Sign up for GitHub

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

Merged
dyladan merged 7 commits into from
Mar 11, 2026
Merged

refactor!(otlp-grpc-exporter-base): remove headers from gRPC config type #6487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
05de16b
fix(otlp-grpc-exporter-base): remove headers from gRPC config type
pratik50 Mar 10, 2026
a9356c7
chore: fix lint and update CHANGELOG
pratik50 Mar 10, 2026
f45ce74
Merge remote-tracking branch 'upstream/main' into fix/grpc-exporter-r…
pratik50 Mar 10, 2026
d462ed7
resolve merge conflict with upstream/main
pratik50 Mar 10, 2026
6b10bfa
fix CHANGELOG entries and proper package-lock.json
pratik50 Mar 10, 2026
dff2829
refactor(otlp-grpc-exporter-base): use Omit to exclude headers from g…
pratik50 Mar 11, 2026
6241597
chore: restore accidentally deleted CHANGELOG entry
pratik50 Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions experimental/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
### :boom: Breaking Changes

* feat(configuration)!: rename OTEL_EXPERIMENTAL_CONFIG_FILE to OTEL_CONFIG_FILE [#6486](https://github.com/open-telemetry/opentelemetry-js/pull/6486) @maryliag
* refactor!(otlp-grpc-exporter-base): remove `headers` from gRPC exporter config type, passing headers now results in a compile-time error instead of being silently ignored [#6487](https://github.com/open-telemetry/opentelemetry-js/pull/6487)

### :rocket: Features

Expand Down
5 changes: 0 additions & 5 deletions ...al/packages/otlp-grpc-exporter-base/src/configuration/convert-legacy-otlp-grpc-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
* SPDX-License-Identifier: Apache-2.0
*/
import type { OTLPGRPCExporterConfigNode } from '../types';
import { diag } from '@opentelemetry/api';
import type { OtlpGrpcConfiguration } from './otlp-grpc-configuration';
import {
getOtlpGrpcDefaultConfiguration,
Expand All @@ -21,10 +20,6 @@ export function convertLegacyOtlpGrpcOptions(
config: OTLPGRPCExporterConfigNode,
signalIdentifier: string
): OtlpGrpcConfiguration {
if (config.headers) {
diag.warn('Headers cannot be set when using grpc');
}

// keep credentials locally in case user updates the reference on the config object
const userProvidedCredentials = config.credentials;
return mergeOtlpGrpcConfigurationWithDefaults(
Expand Down
4 changes: 2 additions & 2 deletions experimental/packages/otlp-grpc-exporter-base/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
*/

import type { ChannelCredentials, Metadata } from '@grpc/grpc-js';

import type {
CompressionAlgorithm,
OTLPExporterConfigBase,
Expand All @@ -13,7 +12,8 @@ import type {
/**
* OTLP Exporter Config for Node
*/
export interface OTLPGRPCExporterConfigNode extends OTLPExporterConfigBase {
export interface OTLPGRPCExporterConfigNode
extends Omit<OTLPExporterConfigBase, 'headers'> {
credentials?: ChannelCredentials;
metadata?: Metadata;
compression?: CompressionAlgorithm;
Expand Down
Loading