Skip to content

Commit dae8496

Browse files
Yosef Arbivvmarchaud
andauthored
ci: add markdown lint and fixed markdown files (#716)
Co-authored-by: Valentin Marchaud <[email protected]>
1 parent 473ad4c commit dae8496

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ This propagator translates the OpenTelemetry SpanContext into the equivalent AWS
1313

1414
Compatible with OpenTelemetry JS API and SDK `1.0+`.
1515

16-
### Installation
16+
## Installation
1717

18-
```
18+
```sh
1919
npm install --save @opentelemetry/propagator-aws-xray
2020
```
2121

22-
### Usage
22+
## Usage
2323

2424
In the [global tracer configuration file](https://github.com/open-telemetry/opentelemetry-js/blob/master/getting-started/README.md#initialize-a-global-tracer), configure the following:
2525

@@ -36,38 +36,38 @@ provider.register({
3636
});
3737
```
3838

39-
### Propagator Details
39+
## Propagator Details
4040

4141
Example header:`X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1`
4242

4343
The header consists of three parts: the root trace ID, the parent ID and the sampling decision.
4444

45-
#### Root - The AWS X-Ray format trace ID
45+
### Root - The AWS X-Ray format trace ID
4646

4747
* Format: (spec-version)-(timestamp)-(UUID)
48-
* spec_version - The version of the AWS X-Ray header format. Currently, only "1" is valid.
49-
* timestamp - 32-bit number in base16 format, corresponds to the first 8 characters of the OpenTelemetry trace ID. Note, while X-Ray calls this timestamp, for the purpose of propagation it is opaque and any value will work.
50-
* UUID - 96-bit random number in base16 format, corresponds to the last 10 characters of the OpenTelemetry trace ID.
48+
* spec_version - The version of the AWS X-Ray header format. Currently, only "1" is valid.
49+
* timestamp - 32-bit number in base16 format, corresponds to the first 8 characters of the OpenTelemetry trace ID. Note, while X-Ray calls this timestamp, for the purpose of propagation it is opaque and any value will work.
50+
* UUID - 96-bit random number in base16 format, corresponds to the last 10 characters of the OpenTelemetry trace ID.
5151

5252
Root is analogous to the [OpenTelemetry Trace ID](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext), with some small format changes.
5353
For additional reading, see the [AWS X-Ray Trace ID](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-sendingdata.html#xray-api-traceids) public documentation.
5454

55-
#### Parent - The ID of the AWS X-Ray Segment
55+
### Parent - The ID of the AWS X-Ray Segment
5656

5757
* 64-bit random number in base16 format. Populated from the [OpenTelemetry Span ID](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
5858

59-
#### Sampled - The sampling decision
59+
### Sampled - The sampling decision
6060

6161
* Defined in the AWS X-Ray specification as a tri-state field, with "0", "1" and "?" as valid values. Only "0" and "1" are used in this propagator. If "?", a new trace will be started.
6262
* Populated from the [OpenTelemetry trace flags](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
6363

6464
## Useful links
6565

66-
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
67-
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
68-
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
66+
* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
67+
* For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
68+
* For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
6969

70-
### License
70+
## License
7171

7272
Apache 2.0 - See [LICENSE][license-url] for more information.
7373

0 commit comments

Comments
 (0)