Skip to content

Commit

Permalink
Updated the flags description in version format (w3c#505)
Browse files Browse the repository at this point in the history
* Updated the flags description in version format

Updated flags description in version format to specify the right number of bits used in the flags.

* Incorporate PR feedback

Incorporated PR feedback to keep the spec less error-prone.
  • Loading branch information
kalyanaj authored and basti1302 committed May 9, 2023
1 parent 387f9b1 commit a08b822
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions spec/20-http_request_header_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The following `version-format` definition is used for version `00`.
version-format = trace-id "-" parent-id "-" trace-flags
trace-id = 32HEXDIGLC ; 16 bytes array identifier. All zeroes forbidden
parent-id = 16HEXDIGLC ; 8 bytes array identifier. All zeroes forbidden
trace-flags = 2HEXDIGLC ; 8 bit flags. Currently, only one bit is used. See below for details
trace-flags = 2HEXDIGLC ; 8 bit flags.
```

#### trace-id
Expand All @@ -118,9 +118,7 @@ Vendors MUST ignore the `traceparent` when the `parent-id` is invalid (for examp

#### trace-flags

The current version of this specification (`00`) supports only two flags: `sampled` and `random-trace-id`.

An <a data-cite='!BIT-FIELD#firstHeading'>8-bit field</a> that controls tracing flags such as sampling, trace level, etc. These flags are recommendations given by the caller rather than strict rules to follow for three reasons:
This is an <a data-cite='!BIT-FIELD#firstHeading'>8-bit field</a> that controls tracing flags such as sampling, trace level, etc. These flags are recommendations given by the caller rather than strict rules to follow for three reasons:

1. An untrusted caller may be able to abuse a tracing system by setting these flags maliciously.
2. A caller may have a bug which causes the tracing system to have a problem.
Expand Down

0 comments on commit a08b822

Please sign in to comment.