Skip to content

feat(opentelemetry-config): set headers from headers_list #6060

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
+313 −168
Draft

feat(opentelemetry-config): set headers from headers_list #6060

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f12baa3
feat(opentelemetry-config): set headers from headers_list
JamieDanielson Oct 28, 2025
ccad42a
update changelog
JamieDanielson Oct 28, 2025
5979289
Merge branch 'main' into jamie.config-headers-list
JamieDanielson Nov 6, 2025
38bda18
refactor and add more tests
JamieDanielson Nov 6, 2025
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 @@ -20,6 +20,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
### :rocket: Features

* feat(instrumentation): allow error of safeExecuteInTheMiddleAsync to be async [#6032](https://github.com/open-telemetry/opentelemetry-js/pull/6032) @JPeer264
* feat(opentelemetry-config): set headers from headers_list [#6060](https://github.com/open-telemetry/opentelemetry-js/pull/6060) @JamieDanielson

### :bug: Bug Fixes

Expand Down
44 changes: 44 additions & 0 deletions experimental/packages/opentelemetry-configuration/src/FileConfigProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,17 @@ function parseConfigSpanOrLogRecordExporter(
headersList = getStringFromConfigFile(e['headers_list']);
if (headersList && parsedExporter.otlp_http) {
parsedExporter.otlp_http.headers_list = headersList;
const list = getStringListFromConfigFile(e['headers_list']);
if (list && list.length > 0 && e['headers'] == null) {
parsedExporter.otlp_http.headers = [];
for (let i = 0; i < list.length; i++) {
const element = list[i].split('=');
parsedExporter.otlp_http.headers.push({
name: element[0],
value: element[1],
});
}
}
}
headers = getConfigHeaders(e['headers']);
if (headers && parsedExporter.otlp_http) {
Expand Down Expand Up @@ -396,6 +407,17 @@ function parseConfigSpanOrLogRecordExporter(
headersList = getStringFromConfigFile(e['headers_list']);
if (headersList && parsedExporter.otlp_grpc) {
parsedExporter.otlp_grpc.headers_list = headersList;
const list = getStringListFromConfigFile(e['headers_list']);
if (list && list.length > 0 && e['headers'] == null) {
parsedExporter.otlp_grpc.headers = [];
for (let i = 0; i < list.length; i++) {
const element = list[i].split('=');
parsedExporter.otlp_grpc.headers.push({
name: element[0],
value: element[1],
});
}
}
}
headers = getConfigHeaders(e['headers']);
if (headers && parsedExporter.otlp_grpc) {
Expand Down Expand Up @@ -687,6 +709,17 @@ function parseMetricExporter(exporter: PushMetricExporter): PushMetricExporter {
headersList = getStringFromConfigFile(e['headers_list']);
if (headersList && parsedExporter.otlp_http) {
parsedExporter.otlp_http.headers_list = headersList;
const list = getStringListFromConfigFile(e['headers_list']);
if (list && list.length > 0 && e['headers'] == null) {
parsedExporter.otlp_http.headers = [];
for (let i = 0; i < list.length; i++) {
const element = list[i].split('=');
parsedExporter.otlp_http.headers.push({
name: element[0],
value: element[1],
});
}
}
}
headers = getConfigHeaders(e['headers']);
if (headers && parsedExporter.otlp_http) {
Expand Down Expand Up @@ -731,6 +764,17 @@ function parseMetricExporter(exporter: PushMetricExporter): PushMetricExporter {
headersList = getStringFromConfigFile(e['headers_list']);
if (headersList && parsedExporter.otlp_grpc) {
parsedExporter.otlp_grpc.headers_list = headersList;
const list = getStringListFromConfigFile(e['headers_list']);
if (list && list.length > 0 && e['headers'] == null) {
parsedExporter.otlp_grpc.headers = [];
for (let i = 0; i < list.length; i++) {
const element = list[i].split('=');
parsedExporter.otlp_grpc.headers.push({
name: element[0],
value: element[1],
});
}
}
}
headers = getConfigHeaders(e['headers']);
if (headers && parsedExporter.otlp_grpc) {
Expand Down
42 changes: 42 additions & 0 deletions experimental/packages/opentelemetry-configuration/test/ConfigProvider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1395,6 +1395,48 @@ describe('ConfigProvider', function () {
},
],
},
tracer_provider: {
Copy link
Contributor

@maryliag maryliag Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code looks good, you will just need more tests. It's hard to get tests for all possible options, it takes some work 😓

processors: [
{
batch: {
schedule_delay: 5000,
export_timeout: 30000,
max_queue_size: 2048,
max_export_batch_size: 512,
exporter: {
otlp_http: {
endpoint: 'http://localhost:4318/v1/traces',
timeout: 10000,
encoding: OtlpHttpEncoding.Protobuf,
headers_list: 'api-key=1234',
headers: [
{
name: 'api-key',
value: '1234',
},
],
},
},
},
},
],
limits: {
attribute_count_limit: 128,
event_count_limit: 128,
link_count_limit: 128,
event_attribute_count_limit: 128,
link_attribute_count_limit: 128,
},
sampler: {
parent_based: {
root: { always_on: undefined },
remote_parent_sampled: { always_on: undefined },
remote_parent_not_sampled: { always_off: undefined },
local_parent_sampled: { always_on: undefined },
local_parent_not_sampled: { always_off: undefined },
},
},
},
};
assert.deepStrictEqual(
configProvider.getInstrumentationConfig(),
Expand Down
9 changes: 8 additions & 1 deletion experimental/packages/opentelemetry-configuration/test/fixtures/short-config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
file_format: "1.0-rc.1"
disabled: false
resource:
attributes_list: service.instance.id=123
attributes_list: service.instance.id=123

tracer_provider:
processors:
- batch:
exporter:
otlp_http:
headers_list: api-key=1234