1
- # OpenTelemetry Propagator OpenTracing
1
+ # OpenTelemetry OTTracePropagator
2
2
3
3
[ ![ Gitter chat] [ gitter-image ]] [ gitter-url ]
4
4
[ ![ NPM Published Version] [ npm-img ]] [ npm-url ]
5
5
[ ![ dependencies] [ dependencies-image ]] [ dependencies-url ]
6
6
[ ![ devDependencies] [ devdependencies-image ]] [ devdependencies-url ]
7
7
[ ![ Apache License] [ license-image ]] [ license-image ]
8
8
9
- ## OpenTracing Format
9
+ ## OT Trace Format
10
10
11
11
| Header Name | Description | Required |
12
12
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
17
17
18
18
### Interop and trace ids
19
19
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
21
21
interop with OpenTelemetry, trace ids need to be truncated to 64-bits before
22
22
sending them on the wire. When truncating, the least significant (right-most)
23
23
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
29
29
keys or values that would result in invalid HTTP headers will be silently
30
30
dropped during inject.
31
31
32
- OpenTelemetry Baggage is represented as multiple headers where the
32
+ OT Baggage is represented as multiple headers where the
33
33
names are carrier dependent. For this reason, they are omitted from the ` fields `
34
34
method. This behavior should be taken into account if your application relies
35
35
on the ` fields ` functionality. See the [ specification] [ fields-spec-url ] for
@@ -39,11 +39,9 @@ more details.
39
39
40
40
``` javascript
41
41
const api = require (' @opentelemetry/api' );
42
- const {
43
- OpenTracingPropagator ,
44
- } = require (' @opentelemetry/propagator-opentracing' );
42
+ const { OTTracePropagator } = require (' @opentelemetry/propagator-ot-trace' );
45
43
46
- api .propagation .setGlobalPropagator (new OpenTracingPropagator ());
44
+ api .propagation .setGlobalPropagator (new OTTracePropagator ());
47
45
```
48
46
49
47
## Useful links
@@ -60,11 +58,11 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
60
58
[ gitter-url ] : https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
61
59
[ license-url ] : https://github.com/open-telemetry/opentelemetry-js-contrib/blob/master/LICENSE
62
60
[ 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
69
67
[ rfc7230-url ] : https://tools.ietf.org/html/rfc7230#section-3.2
70
68
[ fields-spec-url ] : https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md#fields
0 commit comments