Skip to content

Commit dbdbcb9

Browse files
committed
fix!: remove 'Http' from W3C propagator names
- `HttpTraceContextPropagator` to `W3CTraceContextPropagator` - `HttpBaggagePropagator` to `W3CBaggagePropagator`
1 parent 1465865 commit dbdbcb9

File tree

12 files changed

+38
-38
lines changed

12 files changed

+38
-38
lines changed

benchmark/propagator.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ const setups = [
1717
}
1818
},
1919
{
20-
name: 'HttpTraceContextPropagator',
21-
propagator: new opentelemetry.HttpTraceContextPropagator(),
20+
name: 'W3CTraceContextPropagator',
21+
propagator: new opentelemetry.W3CTraceContextPropagator(),
2222
injectCarrier: {},
2323
extractCarrier: {
2424
traceparent: '00-d4cda95b652f4a1592b449d5929fda1b-6e0c63257de34c92-00'

integration-tests/propagation-validation-server/validation-server.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const axios = require("axios");
2-
const { HttpTraceContextPropagator } = require("@opentelemetry/core");
2+
const { W3CTraceContextPropagator } = require("@opentelemetry/core");
33
const { BasicTracerProvider } = require("@opentelemetry/sdk-trace-base");
44
const { context, propagation, trace, ROOT_CONTEXT } = require("@opentelemetry/api");
55
const {
@@ -8,7 +8,7 @@ const {
88
const bodyParser = require("body-parser");
99

1010
// set global propagator
11-
propagation.setGlobalPropagator(new HttpTraceContextPropagator());
11+
propagation.setGlobalPropagator(new W3CTraceContextPropagator());
1212

1313
// set global context manager
1414
context.setGlobalContextManager(new AsyncHooksContextManager());

packages/opentelemetry-core/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This package provides default implementations of the OpenTelemetry API for trace
1212
- [OpenTelemetry Core](#opentelemetry-core)
1313
- [Built-in Implementations](#built-in-implementations)
1414
- [Built-in Propagators](#built-in-propagators)
15-
- [HttpTraceContextPropagator Propagator](#httptracecontext-propagator)
15+
- [W3CTraceContextPropagator Propagator](#httptracecontext-propagator)
1616
- [Composite Propagator](#composite-propagator)
1717
- [Baggage Propagator](#baggage-propagator)
1818
- [Built-in Sampler](#built-in-sampler)
@@ -25,16 +25,16 @@ This package provides default implementations of the OpenTelemetry API for trace
2525

2626
### Built-in Propagators
2727

28-
#### HttpTraceContextPropagator Propagator
28+
#### W3CTraceContextPropagator Propagator
2929

3030
OpenTelemetry provides a text-based approach to propagate context to remote services using the [W3C Trace Context](https://www.w3.org/TR/trace-context/) HTTP headers.
3131

3232
```js
3333
const api = require("@opentelemetry/api");
34-
const { HttpTraceContextPropagator } = require("@opentelemetry/core");
34+
const { W3CTraceContextPropagator } = require("@opentelemetry/core");
3535

3636
/* Set Global Propagator */
37-
api.propagation.setGlobalPropagator(new HttpTraceContextPropagator());
37+
api.propagation.setGlobalPropagator(new W3CTraceContextPropagator());
3838
```
3939

4040
#### Composite Propagator
@@ -57,10 +57,10 @@ Provides a text-based approach to propagate [baggage](https://w3c.github.io/bagg
5757

5858
```js
5959
const api = require("@opentelemetry/api");
60-
const { HttpBaggagePropagator } = require("@opentelemetry/core");
60+
const { W3CBaggagePropagator } = require("@opentelemetry/core");
6161

6262
/* Set Global Propagator */
63-
api.propagation.setGlobalPropagator(new HttpBaggagePropagator());
63+
api.propagation.setGlobalPropagator(new W3CBaggagePropagator());
6464
```
6565

6666
### Built-in Sampler

packages/opentelemetry-core/src/baggage/propagation/HttpBaggagePropagator.ts renamed to packages/opentelemetry-core/src/baggage/propagation/W3CBaggagePropagator.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ import {
4242
* Based on the Baggage specification:
4343
* https://w3c.github.io/baggage/
4444
*/
45-
export class HttpBaggagePropagator implements TextMapPropagator {
45+
export class W3CBaggagePropagator implements TextMapPropagator {
4646
inject(context: Context, carrier: unknown, setter: TextMapSetter): void {
4747
const baggage = propagation.getBaggage(context);
4848
if (!baggage || isTracingSuppressed(context)) return;

packages/opentelemetry-core/src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
export * from './baggage/propagation/HttpBaggagePropagator';
17+
export * from './baggage/propagation/W3CBaggagePropagator';
1818
export * from './common/attributes';
1919
export * from './common/global-error-handler';
2020
export * from './common/logging-error-handler';
@@ -25,7 +25,7 @@ export * from './version';
2525
export * as baggageUtils from './baggage/utils';
2626
export * from './platform';
2727
export * from './propagation/composite';
28-
export * from './trace/HttpTraceContextPropagator';
28+
export * from './trace/W3CTraceContextPropagator';
2929
export * from './trace/IdGenerator';
3030
export * from './trace/rpc-metadata';
3131
export * from './trace/sampler/AlwaysOffSampler';

packages/opentelemetry-core/src/trace/HttpTraceContextPropagator.ts renamed to packages/opentelemetry-core/src/trace/W3CTraceContextPropagator.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export function parseTraceParent(traceParent: string): SpanContext | null {
7070
* Based on the Trace Context specification:
7171
* https://www.w3.org/TR/trace-context/
7272
*/
73-
export class HttpTraceContextPropagator implements TextMapPropagator {
73+
export class W3CTraceContextPropagator implements TextMapPropagator {
7474
inject(context: Context, carrier: unknown, setter: TextMapSetter): void {
7575
const spanContext = trace.getSpanContext(context);
7676
if (

packages/opentelemetry-core/test/baggage/HttpBaggagePropagator.test.ts renamed to packages/opentelemetry-core/test/baggage/W3CBaggagePropagator.test.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ import {
2323
} from '@opentelemetry/api';
2424
import { ROOT_CONTEXT } from '@opentelemetry/api';
2525
import * as assert from 'assert';
26-
import { HttpBaggagePropagator } from '../../src/baggage/propagation/HttpBaggagePropagator';
26+
import { W3CBaggagePropagator } from '../../src/baggage/propagation/W3CBaggagePropagator';
2727
import { BAGGAGE_HEADER } from '../../src/baggage/constants';
2828

29-
describe('HttpBaggagePropagator', () => {
30-
const httpBaggagePropagator = new HttpBaggagePropagator();
29+
describe('W3CBaggagePropagator', () => {
30+
const httpBaggagePropagator = new W3CBaggagePropagator();
3131

3232
let carrier: { [key: string]: unknown };
3333

@@ -196,7 +196,7 @@ describe('HttpBaggagePropagator', () => {
196196

197197
describe('fields()', () => {
198198
it('returns the fields used by the baggage spec', () => {
199-
const propagator = new HttpBaggagePropagator();
199+
const propagator = new W3CBaggagePropagator();
200200
assert.deepStrictEqual(propagator.fields(), [BAGGAGE_HEADER]);
201201
});
202202
});

packages/opentelemetry-core/test/propagation/composite.test.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ import { Context, ROOT_CONTEXT } from '@opentelemetry/api';
2626
import * as assert from 'assert';
2727
import {
2828
CompositePropagator,
29-
HttpTraceContextPropagator,
29+
W3CTraceContextPropagator,
3030
RandomIdGenerator,
3131
} from '../../src';
3232
import {
3333
TRACE_PARENT_HEADER,
3434
TRACE_STATE_HEADER,
35-
} from '../../src/trace/HttpTraceContextPropagator';
35+
} from '../../src/trace/W3CTraceContextPropagator';
3636
import { TraceState } from '../../src/trace/TraceState';
3737

3838
class DummyPropagator implements TextMapPropagator {
@@ -78,7 +78,7 @@ describe('Composite Propagator', () => {
7878

7979
it('should inject context using all configured propagators', () => {
8080
const composite = new CompositePropagator({
81-
propagators: [new DummyPropagator(), new HttpTraceContextPropagator()],
81+
propagators: [new DummyPropagator(), new W3CTraceContextPropagator()],
8282
});
8383
composite.inject(ctxWithSpanContext, carrier, defaultTextMapSetter);
8484

@@ -94,7 +94,7 @@ describe('Composite Propagator', () => {
9494
const composite = new CompositePropagator({
9595
propagators: [
9696
new ThrowingPropagator(),
97-
new HttpTraceContextPropagator(),
97+
new W3CTraceContextPropagator(),
9898
],
9999
});
100100
composite.inject(ctxWithSpanContext, carrier, defaultTextMapSetter);
@@ -119,7 +119,7 @@ describe('Composite Propagator', () => {
119119

120120
it('should extract context using all configured propagators', () => {
121121
const composite = new CompositePropagator({
122-
propagators: [new DummyPropagator(), new HttpTraceContextPropagator()],
122+
propagators: [new DummyPropagator(), new W3CTraceContextPropagator()],
123123
});
124124
const spanContext = trace.getSpanContext(
125125
composite.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
@@ -140,7 +140,7 @@ describe('Composite Propagator', () => {
140140
const composite = new CompositePropagator({
141141
propagators: [
142142
new ThrowingPropagator(),
143-
new HttpTraceContextPropagator(),
143+
new W3CTraceContextPropagator(),
144144
],
145145
});
146146
const spanContext = trace.getSpanContext(

packages/opentelemetry-core/test/trace/HttpTraceContextPropagator.test.ts renamed to packages/opentelemetry-core/test/trace/W3CTraceContextPropagator.test.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ import {
2525
} from '@opentelemetry/api';
2626
import * as assert from 'assert';
2727
import {
28-
HttpTraceContextPropagator,
28+
W3CTraceContextPropagator,
2929
TRACE_PARENT_HEADER,
3030
TRACE_STATE_HEADER,
31-
} from '../../src/trace/HttpTraceContextPropagator';
31+
} from '../../src/trace/W3CTraceContextPropagator';
3232
import { suppressTracing } from '../../src/trace/suppress-tracing';
3333
import { TraceState } from '../../src/trace/TraceState';
3434

35-
describe('HttpTraceContextPropagator', () => {
36-
const httpTraceContext = new HttpTraceContextPropagator();
35+
describe('W3CTraceContextPropagator', () => {
36+
const httpTraceContext = new W3CTraceContextPropagator();
3737
let carrier: { [key: string]: unknown };
3838

3939
beforeEach(() => {

packages/opentelemetry-instrumentation-grpc/test/helper.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import {
1919
SpanKind,
2020
propagation, trace,
2121
} from '@opentelemetry/api';
22-
import { HttpTraceContextPropagator } from '@opentelemetry/core';
22+
import { W3CTraceContextPropagator } from '@opentelemetry/core';
2323
import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
2424
import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
2525
import { ContextManager } from '@opentelemetry/api';
@@ -386,7 +386,7 @@ export const runTests = (
386386
let contextManager: ContextManager;
387387

388388
before(() => {
389-
propagation.setGlobalPropagator(new HttpTraceContextPropagator());
389+
propagation.setGlobalPropagator(new W3CTraceContextPropagator());
390390
});
391391

392392
beforeEach(() => {

packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ import {
2424
} from '@opentelemetry/api';
2525
import {
2626
CompositePropagator,
27-
HttpBaggagePropagator,
28-
HttpTraceContextPropagator,
27+
W3CBaggagePropagator,
28+
W3CTraceContextPropagator,
2929
getEnv,
3030
} from '@opentelemetry/core';
3131
import { Resource } from '@opentelemetry/resources';
@@ -57,8 +57,8 @@ export class BasicTracerProvider implements TracerProvider {
5757
string,
5858
PROPAGATOR_FACTORY
5959
>([
60-
['tracecontext', () => new HttpTraceContextPropagator()],
61-
['baggage', () => new HttpBaggagePropagator()],
60+
['tracecontext', () => new W3CTraceContextPropagator()],
61+
['baggage', () => new W3CBaggagePropagator()],
6262
]);
6363

6464
protected static readonly _registeredExporters = new Map<

packages/opentelemetry-shim-opentracing/test/Shim.test.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import { BasicTracerProvider, Span } from '@opentelemetry/sdk-trace-base';
2020
import { SpanContextShim, SpanShim, TracerShim } from '../src/shim';
2121
import {
2222
CompositePropagator,
23-
HttpBaggagePropagator,
24-
HttpTraceContextPropagator,
23+
W3CBaggagePropagator,
24+
W3CTraceContextPropagator,
2525
timeInputToHrTime,
2626
} from '@opentelemetry/core';
2727
import {
@@ -41,8 +41,8 @@ import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
4141
describe('OpenTracing Shim', () => {
4242
const compositePropagator = new CompositePropagator({
4343
propagators: [
44-
new HttpTraceContextPropagator(),
45-
new HttpBaggagePropagator(),
44+
new W3CTraceContextPropagator(),
45+
new W3CBaggagePropagator(),
4646
],
4747
});
4848

0 commit comments

Comments
 (0)