Skip to content

Commit eb7ebd1

Browse files
authored
refactor: OpenTracingPropagator -> OTTracePropagator rename (open-telemetry#329)
1 parent d59bd00 commit eb7ebd1

13 files changed

+21
-23
lines changed

propagators/opentelemetry-propagator-opentracing/README.md renamed to propagators/opentelemetry-propagator-ot-trace/README.md

+12-14
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# OpenTelemetry Propagator OpenTracing
1+
# OpenTelemetry OTTracePropagator
22

33
[![Gitter chat][gitter-image]][gitter-url]
44
[![NPM Published Version][npm-img]][npm-url]
55
[![dependencies][dependencies-image]][dependencies-url]
66
[![devDependencies][devdependencies-image]][devdependencies-url]
77
[![Apache License][license-image]][license-image]
88

9-
## OpenTracing Format
9+
## OT Trace Format
1010

1111
| Header Name | Description | Required |
1212
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
@@ -17,7 +17,7 @@
1717

1818
### Interop and trace ids
1919

20-
The OpenTracing propagation format expects trace ids to be 64-bits. In order to
20+
The OT trace propagation format expects trace ids to be 64-bits. In order to
2121
interop with OpenTelemetry, trace ids need to be truncated to 64-bits before
2222
sending them on the wire. When truncating, the least significant (right-most)
2323
bits MUST be retained. For example, a trace id of
@@ -29,7 +29,7 @@ Baggage keys and values are validated according to [rfc7230][rfc7230-url]. Any
2929
keys or values that would result in invalid HTTP headers will be silently
3030
dropped during inject.
3131

32-
OpenTelemetry Baggage is represented as multiple headers where the
32+
OT Baggage is represented as multiple headers where the
3333
names are carrier dependent. For this reason, they are omitted from the `fields`
3434
method. This behavior should be taken into account if your application relies
3535
on the `fields` functionality. See the [specification][fields-spec-url] for
@@ -39,11 +39,9 @@ more details.
3939

4040
```javascript
4141
const api = require('@opentelemetry/api');
42-
const {
43-
OpenTracingPropagator,
44-
} = require('@opentelemetry/propagator-opentracing');
42+
const { OTTracePropagator } = require('@opentelemetry/propagator-ot-trace');
4543

46-
api.propagation.setGlobalPropagator(new OpenTracingPropagator());
44+
api.propagation.setGlobalPropagator(new OTTracePropagator());
4745
```
4846

4947
## Useful links
@@ -60,11 +58,11 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
6058
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
6159
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/master/LICENSE
6260
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
63-
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/status.svg?path=packages/opentelemetry-propagator-opentracing
64-
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-propagator-opentracing
65-
[devdependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/dev-status.svg?path=packages/opentelemetry-propagator-opentracing
66-
[devdependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-propagator-opentracing&type=dev
67-
[npm-url]: https://www.npmjs.com/package/@opentelemetry/propagator-opentracing
68-
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fpropagator-opentracing.svg
61+
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/status.svg?path=packages/opentelemetry-propagator-ot-trace
62+
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-propagator-ot-trace
63+
[devdependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib/dev-status.svg?path=packages/opentelemetry-propagator-ot-trace
64+
[devdependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-propagator-ot-trace&type=dev
65+
[npm-url]: https://www.npmjs.com/package/@opentelemetry/propagator-ot-trace
66+
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fpropagator-ot-trace.svg
6967
[rfc7230-url]: https://tools.ietf.org/html/rfc7230#section-3.2
7068
[fields-spec-url]: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md#fields

propagators/opentelemetry-propagator-opentracing/package.json renamed to propagators/opentelemetry-propagator-ot-trace/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@opentelemetry/propagator-opentracing",
2+
"name": "@opentelemetry/propagator-ot-trace",
33
"version": "0.13.0",
4-
"description": "OpenTelemetry propagator OpenTracing provides context propagation for systems that are using the OpenTracing header format",
4+
"description": "The OpenTelemetry OTTracepropagator implements the propagation format used by the \"basic tracer\" implementations from the OpenTracing project",
55
"main": "build/src/index.js",
66
"types": "build/src/index.d.ts",
77
"repository": "open-telemetry/opentelemetry-js-contrib",

propagators/opentelemetry-propagator-opentracing/src/OpenTracingPropagator.ts renamed to propagators/opentelemetry-propagator-ot-trace/src/OTTracePropagator.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ function isValidHeaderValue(value: string): boolean {
6262
}
6363

6464
/**
65-
* Propagator for the OpenTracing HTTP format.
65+
* Propagator for the ot-trace HTTP format from OpenTracing.
6666
*/
67-
export class OpenTracingPropagator implements TextMapPropagator {
67+
export class OTTracePropagator implements TextMapPropagator {
6868
inject(context: Context, carrier: unknown, setter: TextMapSetter) {
6969
const spanContext = getSpanContext(context);
7070
if (!spanContext || !isSpanContextValid(spanContext)) return;

propagators/opentelemetry-propagator-opentracing/src/index.ts renamed to propagators/opentelemetry-propagator-ot-trace/src/index.ts

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

17-
export * from './OpenTracingPropagator';
17+
export * from './OTTracePropagator';

propagators/opentelemetry-propagator-opentracing/test/OpenTracingPropagator.test.ts renamed to propagators/opentelemetry-propagator-ot-trace/test/OTTracePropagator.test.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ import {
3030
} from '@opentelemetry/api';
3131
import * as assert from 'assert';
3232
import {
33-
OpenTracingPropagator,
33+
OTTracePropagator,
3434
OT_TRACE_ID_HEADER,
3535
OT_SPAN_ID_HEADER,
3636
OT_SAMPLED_HEADER,
3737
OT_BAGGAGE_PREFIX,
38-
} from '../src/OpenTracingPropagator';
38+
} from '../src/OTTracePropagator';
3939

40-
describe('OpenTracingPropagator', () => {
41-
const propagator = new OpenTracingPropagator();
40+
describe('OTTracePropagator', () => {
41+
const propagator = new OTTracePropagator();
4242
let carrier: { [key: string]: unknown };
4343

4444
beforeEach(() => {

0 commit comments

Comments
 (0)