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.

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

fix(exporter-logs-otlp-proto): programatic headers take precedence ov… #4351

Merged
merged 11 commits into from
Jan 3, 2024
+86 −5
Merged

fix(exporter-logs-otlp-proto): programatic headers take precedence ov… #4351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3cd8c0a
fix(exporter-logs-otlp-proto): programatic headers take precedence ov…
Vunovati Dec 8, 2023
9d5c77e
chore: update PR url in changelog
Vunovati Dec 8, 2023
839e0e6
chore: fix deletion of env var
Vunovati Dec 8, 2023
77b3482
fix(exporter-logs-otlp-http): programatic headers take precedence ove…
Vunovati Dec 8, 2023
a3ac920
fix(exporter-trace-otlp-http): programatic headers take precedence ov…
Vunovati Dec 8, 2023
d6afe0d
fix(exporter-trace-otlp-proto): programatic headers take precedence o…
Vunovati Dec 8, 2023
39c76d6
chore: update CHANGELOG
Vunovati Dec 8, 2023
df74e7e
Merge branch 'main' into main
Vunovati Dec 12, 2023
0ee8001
Merge branch 'main' into main
Vunovati Jan 3, 2024
7bbf861
Merge branch 'main' into main
Vunovati Jan 3, 2024
b02f746
Merge branch 'main' into main
pichlermarc Jan 3, 2024
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
5 changes: 5 additions & 0 deletions experimental/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ All notable changes to experimental packages in this project will be documented

### :boom: Breaking Change

* fix(exporter-logs-otlp-http): programatic headers take precedence over environment variables [#2370](https://github.com/open-telemetry/opentelemetry-js/pull/4351) @Vunovati
* fix(exporter-logs-otlp-proto): programatic headers take precedence over environment variables [#2370](https://github.com/open-telemetry/opentelemetry-js/pull/4351) @Vunovati
* fix(exporter-trace-otlp-http): programatic headers take precedence over environment variables [#2370](https://github.com/open-telemetry/opentelemetry-js/pull/4351) @Vunovati
* fix(exporter-trace-otlp-proto): programatic headers take precedence over environment variables [#2370](https://github.com/open-telemetry/opentelemetry-js/pull/4351) @Vunovati

### :rocket: (Enhancement)

### :bug: (Bug Fix)
Expand Down
9 changes: 5 additions & 4 deletions experimental/packages/exporter-logs-otlp-http/src/platform/node/OTLPLogExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,13 @@ export class OTLPLogExporter
timeoutMillis: getEnv().OTEL_EXPORTER_OTLP_LOGS_TIMEOUT,
...config,
});
this.headers = {
...this.headers,
...baggageUtils.parseKeyPairsIntoRecord(
this.headers = Object.assign(
Vunovati marked this conversation as resolved.
Show resolved Hide resolved
this.headers,
baggageUtils.parseKeyPairsIntoRecord(
getEnv().OTEL_EXPORTER_OTLP_LOGS_HEADERS
),
};
config.headers
);
}

convert(logRecords: ReadableLogRecord[]): IExportLogsServiceRequest {
Expand Down
12 changes: 12 additions & 0 deletions experimental/packages/exporter-logs-otlp-http/test/node/OTLPLogExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,18 @@ describe('OTLPLogExporter', () => {
delete envSource.OTEL_EXPORTER_OTLP_LOGS_HEADERS;
delete envSource.OTEL_EXPORTER_OTLP_LOGS_TIMEOUT;
});

it('should override headers defined via env with headers defined in constructor', () => {
envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar,bar=foo';
const collectorExporter = new OTLPLogExporter({
headers: {
foo: 'constructor',
},
});
assert.strictEqual(collectorExporter.headers.foo, 'constructor');
assert.strictEqual(collectorExporter.headers.bar, 'foo');
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
});

describe('getDefaultUrl', () => {
Expand Down
3 changes: 2 additions & 1 deletion experimental/packages/exporter-logs-otlp-proto/src/platform/node/OTLPLogExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ export class OTLPLogExporter
this.headers,
baggageUtils.parseKeyPairsIntoRecord(
getEnv().OTEL_EXPORTER_OTLP_LOGS_HEADERS
)
),
config.headers
);
}
convert(logs: ReadableLogRecord[]): IExportLogsServiceRequest {
Expand Down
20 changes: 20 additions & 0 deletions experimental/packages/exporter-logs-otlp-proto/test/node/OTLPLogExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,15 @@ describe('OTLPLogExporter - node with proto over http', () => {
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
envSource.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = '';
});
it('should override url defined in env with url defined in constructor', () => {
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar/';
const constructorDefinedEndpoint = 'http://constructor/v1/logs';
const collectorExporter = new OTLPLogExporter({
url: constructorDefinedEndpoint,
});
assert.strictEqual(collectorExporter.url, constructorDefinedEndpoint);
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
});
it('should add root path when signal url defined in env contains no path and no root path', () => {
envSource.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = 'http://foo.bar';
const collectorExporter = new OTLPLogExporter();
Expand Down Expand Up @@ -143,6 +152,17 @@ describe('OTLPLogExporter - node with proto over http', () => {
envSource.OTEL_EXPORTER_OTLP_LOGS_HEADERS = '';
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
it('should override headers defined via env with headers defined in constructor', () => {
envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar,bar=foo';
const collectorExporter = new OTLPLogExporter({
headers: {
foo: 'constructor',
},
});
assert.strictEqual(collectorExporter.headers.foo, 'constructor');
assert.strictEqual(collectorExporter.headers.bar, 'foo');
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
});

describe('export', () => {
Expand Down
1 change: 1 addition & 0 deletions experimental/packages/exporter-trace-otlp-http/src/platform/node/OTLPTraceExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ export class OTLPTraceExporter
...baggageUtils.parseKeyPairsIntoRecord(
getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
),
...config.headers,
};
}

Expand Down
20 changes: 20 additions & 0 deletions experimental/packages/exporter-trace-otlp-http/test/node/CollectorTraceExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,15 @@ describe('OTLPTraceExporter - node with json over http', () => {
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = '';
});
it('should override url defined in env with url defined in constructor', () => {
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = 'http://foo.bar';
const constructorDefinedEndpoint = 'http://constructor/v1/traces';
const collectorExporter = new OTLPTraceExporter({
url: constructorDefinedEndpoint,
});
assert.strictEqual(collectorExporter.url, constructorDefinedEndpoint);
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = '';
});
it('should add root path when signal url defined in env contains no path and no root path', () => {
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = 'http://foo.bar';
const collectorExporter = new OTLPTraceExporter();
Expand Down Expand Up @@ -177,6 +186,17 @@ describe('OTLPTraceExporter - node with json over http', () => {
envSource.OTEL_EXPORTER_OTLP_TRACES_HEADERS = '';
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
it('should override headers defined via env with headers defined in constructor', () => {
envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar,bar=foo';
const collectorExporter = new OTLPTraceExporter({
headers: {
foo: 'constructor',
},
});
assert.strictEqual(collectorExporter.headers.foo, 'constructor');
assert.strictEqual(collectorExporter.headers.bar, 'foo');
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
it('should use compression defined via env', () => {
envSource.OTEL_EXPORTER_OTLP_COMPRESSION = 'gzip';
const collectorExporter = new OTLPTraceExporter();
Expand Down
1 change: 1 addition & 0 deletions experimental/packages/exporter-trace-otlp-proto/src/platform/node/OTLPTraceExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export class OTLPTraceExporter
...baggageUtils.parseKeyPairsIntoRecord(
getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
),
...config.headers,
};
}

Expand Down
20 changes: 20 additions & 0 deletions experimental/packages/exporter-trace-otlp-proto/test/node/OTLPTraceExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,15 @@ describe('OTLPTraceExporter - node with proto over http', () => {
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = '';
});
it('should override url defined in env with url defined in constructor', () => {
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar/';
const constructorDefinedEndpoint = 'http://constructor/v1/traces';
const collectorExporter = new OTLPTraceExporter({
url: constructorDefinedEndpoint,
});
assert.strictEqual(collectorExporter.url, constructorDefinedEndpoint);
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
});
it('should add root path when signal url defined in env contains no path and no root path', () => {
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = 'http://foo.bar';
const collectorExporter = new OTLPTraceExporter();
Expand Down Expand Up @@ -155,6 +164,17 @@ describe('OTLPTraceExporter - node with proto over http', () => {
envSource.OTEL_EXPORTER_OTLP_TRACES_HEADERS = '';
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
it('should override headers defined via env with headers defined in constructor', () => {
envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar,bar=foo';
const collectorExporter = new OTLPTraceExporter({
headers: {
foo: 'constructor',
},
});
assert.strictEqual(collectorExporter.headers.foo, 'constructor');
assert.strictEqual(collectorExporter.headers.bar, 'foo');
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
});

describe('export', () => {
Expand Down