Skip to content

Commit

Permalink
fix: linting errors in jaeger propagator README
Browse files Browse the repository at this point in the history
  • Loading branch information
jtmalinowski authored and dyladan committed Mar 29, 2021
1 parent 1c6a16c commit 2332b02
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions packages/opentelemetry-propagator-jaeger/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# OpenTelemetry Propagator Jaeger

[![Gitter chat][gitter-image]][gitter-url]
[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
Expand All @@ -11,19 +12,20 @@ Format:
{trace-id}:{span-id}:{parent-span-id}:{flags}

* {trace-id}
* 64-bit or 128-bit random number in base16 format.
* Can be variable length, shorter values are 0-padded on the left.
* Value of 0 is invalid.
* 64-bit or 128-bit random number in base16 format.
* Can be variable length, shorter values are 0-padded on the left.
* Value of 0 is invalid.

* {span-id}
* 64-bit random number in base16 format.
* 64-bit random number in base16 format.

* {parent-span-id}
* Set to 0 because this field is deprecated.
* Set to 0 because this field is deprecated.
* {flags}
* One byte bitmap, as two hex digits.
* One byte bitmap, as two hex digits.

Example of usage:

```javascript
const { NodeTracerProvider } = require('@opentelemetry/node');
const { JaegerHttpTracePropagator } = require('@opentelemetry/propagator-jaeger');
Expand All @@ -40,9 +42,10 @@ provider.register({
![example image](jaeger-tracing.png)

## Useful links
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
- For help or feedback on this project, join us on [gitter][gitter-url]

* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
* For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
* For help or feedback on this project, join us on [gitter][gitter-url]

## License

Expand Down

0 comments on commit 2332b02

Please sign in to comment.