Skip to content

fix(otlp-exporter-base): remove sendBeacon in favor of fetch with keepalive #6391

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
overbalance merged 9 commits into from
Feb 16, 2026
Merged

fix(otlp-exporter-base): remove sendBeacon in favor of fetch with keepalive #6391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
34240bd
fix: remove sendbeacon
overbalance Feb 10, 2026
ed17d13
docs(otlp-exporter-base): add changelog entry for sendBeacon removal
overbalance Feb 10, 2026
ef6b294
chore: add browser paths to CODEOWNERS
overbalance Feb 10, 2026
cac8c03
docs: remove link
overbalance Feb 10, 2026
55ffcb1
wrong
overbalance Feb 10, 2026
ea23d30
docs: sendBeacon polyfill if needed
overbalance Feb 16, 2026
33f78a3
Update CHANGELOG.md
overbalance Feb 16, 2026
6c55d9b
Merge remote-tracking branch 'upstream/main' into overbalance/remove-…
overbalance Feb 16, 2026
ae60364
move changelog into current version
overbalance Feb 16, 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
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ experimental/packages/api-logs/ @open-telemetry/javascript-maintainers
# Any browser-specific code is co-owned by Browser SIG and JS SIG (list more packages here as needed):
bundler-tests/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
examples/opentelemetry-web/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
experimental/packages/**/*browser* @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
experimental/packages/opentelemetry-browser-detector/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
experimental/packages/opentelemetry-instrumentation-fetch/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
experimental/packages/opentelemetry-instrumentation-xml-http-request/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
experimental/packages/otlp-exporter-base/src/transport/fetch-transport.ts @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
experimental/packages/web-common/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
packages/opentelemetry-context-zone/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
packages/opentelemetry-context-zone-peer-dep/ @open-telemetry/browser-maintainers @open-telemetry/javascript-approvers
Expand Down
3 changes: 3 additions & 0 deletions experimental/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2

### :bug: Bug Fixes

* fix(otlp-exporter-base): remove sendBeacon in favor of fetch with keepalive [#6391](https://github.com/open-telemetry/opentelemetry-js/pull/6391) @overbalance
* (user-facing) createOtlpSendBeaconExportDelegate will be removed in a future version

### :books: Documentation

### :house: Internal
Expand Down
66 changes: 18 additions & 48 deletions experimental/packages/exporter-logs-otlp-http/test/browser/OTLPLogExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,56 +35,26 @@ describe('OTLPLogExporter', function () {
});

describe('export', function () {
describe('when sendBeacon is available', function () {
it('should successfully send data using sendBeacon', async function () {
// arrange
const stubBeacon = sinon.stub(navigator, 'sendBeacon');
const loggerProvider = new LoggerProvider({
processors: [new SimpleLogRecordProcessor(new OTLPLogExporter())],
});

// act
loggerProvider.getLogger('test-logger').emit({ body: 'test-body' });
await loggerProvider.shutdown();

// assert
const args = stubBeacon.args[0];
const blob: Blob = args[1] as unknown as Blob;
const body = await blob.text();
assert.doesNotThrow(
() => JSON.parse(body),
'expected requestBody to be in JSON format, but parsing failed'
);
});
});

describe('when sendBeacon is not available', function () {
beforeEach(function () {
// fake sendBeacon not being available
(window.navigator as any).sendBeacon = false;
it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const loggerProvider = new LoggerProvider({
processors: [new SimpleLogRecordProcessor(new OTLPLogExporter())],
});

it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const loggerProvider = new LoggerProvider({
processors: [new SimpleLogRecordProcessor(new OTLPLogExporter())],
});

// act
loggerProvider.getLogger('test-logger').emit({ body: 'test-body' });
await loggerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.doesNotThrow(
() => JSON.parse(body),
'expected requestBody to be in JSON format, but parsing failed'
);
});
// act
loggerProvider.getLogger('test-logger').emit({ body: 'test-body' });
await loggerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.doesNotThrow(
() => JSON.parse(body),
'expected requestBody to be in JSON format, but parsing failed'
);
});
});
});
66 changes: 18 additions & 48 deletions experimental/packages/exporter-logs-otlp-proto/test/browser/OTLPLogExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,56 +35,26 @@ describe('OTLPLogExporter', function () {
});

describe('export', function () {
describe('when sendBeacon is available', function () {
it('should successfully send data using sendBeacon', async function () {
// arrange
const stubBeacon = sinon.stub(navigator, 'sendBeacon');
const loggerProvider = new LoggerProvider({
processors: [new SimpleLogRecordProcessor(new OTLPLogExporter())],
});

// act
loggerProvider.getLogger('test-logger').emit({ body: 'test-body' });
await loggerProvider.shutdown();

// assert
const args = stubBeacon.args[0];
const blob: Blob = args[1] as unknown as Blob;
const body = await blob.text();
assert.throws(
() => JSON.parse(body),
'expected requestBody to be in protobuf format, but parsing as JSON succeeded'
);
});
});

describe('when sendBeacon is not available', function () {
beforeEach(function () {
// fake sendBeacon not being available
(window.navigator as any).sendBeacon = false;
it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const loggerProvider = new LoggerProvider({
processors: [new SimpleLogRecordProcessor(new OTLPLogExporter())],
});

it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const loggerProvider = new LoggerProvider({
processors: [new SimpleLogRecordProcessor(new OTLPLogExporter())],
});

// act
loggerProvider.getLogger('test-logger').emit({ body: 'test-body' });
await loggerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.throws(
() => JSON.parse(body),
'expected requestBody to be in protobuf format, but parsing as JSON succeeded'
);
});
// act
loggerProvider.getLogger('test-logger').emit({ body: 'test-body' });
await loggerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.throws(
() => JSON.parse(body),
'expected requestBody to be in protobuf format, but parsing as JSON succeeded'
);
});
});
});
66 changes: 18 additions & 48 deletions experimental/packages/exporter-trace-otlp-http/test/browser/OTLPTraceExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,56 +36,26 @@ describe('OTLPTraceExporter', () => {
});

describe('export', function () {
describe('when sendBeacon is available', function () {
it('should successfully send data using sendBeacon', async function () {
// arrange
const stubBeacon = sinon.stub(navigator, 'sendBeacon');
const tracerProvider = new BasicTracerProvider({
spanProcessors: [new SimpleSpanProcessor(new OTLPTraceExporter())],
});

// act
tracerProvider.getTracer('test-tracer').startSpan('test-span').end();
await tracerProvider.shutdown();

// assert
const args = stubBeacon.args[0];
const blob: Blob = args[1] as unknown as Blob;
const body = await blob.text();
assert.doesNotThrow(
() => JSON.parse(body),
'expected requestBody to be in JSON format, but parsing failed'
);
});
});

describe('when sendBeacon is not available', function () {
beforeEach(function () {
// fake sendBeacon not being available
(window.navigator as any).sendBeacon = false;
it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const tracerProvider = new BasicTracerProvider({
spanProcessors: [new SimpleSpanProcessor(new OTLPTraceExporter())],
});

it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const tracerProvider = new BasicTracerProvider({
spanProcessors: [new SimpleSpanProcessor(new OTLPTraceExporter())],
});

// act
tracerProvider.getTracer('test-tracer').startSpan('test-span').end();
await tracerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.doesNotThrow(
() => JSON.parse(body),
'expected requestBody to be in JSON format, but parsing failed'
);
});
// act
tracerProvider.getTracer('test-tracer').startSpan('test-span').end();
await tracerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.doesNotThrow(
() => JSON.parse(body),
'expected requestBody to be in JSON format, but parsing failed'
);
});
});
});
66 changes: 18 additions & 48 deletions experimental/packages/exporter-trace-otlp-proto/test/browser/OTLPTraceExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,56 +36,26 @@ describe('OTLPTraceExporter', () => {
});

describe('export', function () {
describe('when sendBeacon is available', function () {
it('should successfully send data using sendBeacon', async function () {
// arrange
const stubBeacon = sinon.stub(navigator, 'sendBeacon');
const tracerProvider = new BasicTracerProvider({
spanProcessors: [new SimpleSpanProcessor(new OTLPTraceExporter())],
});

// act
tracerProvider.getTracer('test-tracer').startSpan('test-span').end();
await tracerProvider.shutdown();

// assert
const args = stubBeacon.args[0];
const blob: Blob = args[1] as unknown as Blob;
const body = await blob.text();
assert.throws(
() => JSON.parse(body),
'expected requestBody to be in protobuf format, but parsing as JSON succeeded'
);
});
});

describe('when sendBeacon is not available', function () {
beforeEach(function () {
// fake sendBeacon not being available
(window.navigator as any).sendBeacon = false;
it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const tracerProvider = new BasicTracerProvider({
spanProcessors: [new SimpleSpanProcessor(new OTLPTraceExporter())],
});

it('should successfully send data using fetch', async function () {
// arrange
const stubFetch = sinon
.stub(window, 'fetch')
.resolves(new Response('', { status: 200 }));
const tracerProvider = new BasicTracerProvider({
spanProcessors: [new SimpleSpanProcessor(new OTLPTraceExporter())],
});

// act
tracerProvider.getTracer('test-tracer').startSpan('test-span').end();
await tracerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.throws(
() => JSON.parse(body),
'expected request body to be in protobuf format, but parsing as JSON succeeded'
);
});
// act
tracerProvider.getTracer('test-tracer').startSpan('test-span').end();
await tracerProvider.shutdown();

// assert
const request = new Request(...stubFetch.args[0]);
const body = await request.text();
assert.throws(
() => JSON.parse(body),
'expected request body to be in protobuf format, but parsing as JSON succeeded'
);
});
});
});
Loading