style: 'free to' → SHOULD/MAY #424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This replaces ambigous 'free to' with SHOULD/MAY and also replaces provisional (and unused) `X-Trace` with optional Trace Context and Server Timing headers.
lidel
commented
Jul 3, 2023
Comment on lines
+542
to
+562
| ### `Server-Timing` (response header) | ||
|
|
||
| Optional. Implementations are free to use this header to return a globally | ||
| Optional. Implementations MAY use this header to communicate one or more | ||
| metrics and descriptions for the given request-response cycle. | ||
|
|
||
| See `Server-Timing` at [W3C: Server Timing](https://www.w3.org/TR/server-timing/#the-server-timing-header-field). | ||
|
|
||
| ### `Traceparent` (response header) | ||
|
|
||
| Optional. Implementations MAY use this header to return a globally | ||
| unique identifier to help in debugging errors and performance issues. | ||
|
|
||
| A good practice is to always return it with HTTP error [status codes](#response-status-codes) >=`400`. | ||
| See `Traceparent` at [W3C: Trace Context](https://www.w3.org/TR/trace-context-1/#traceparent-header). | ||
|
|
||
| ### `Tracestate` (response header) | ||
|
|
||
| Optional. Implementations MAY use this header to return a additional | ||
| vendor-specific trace identification information across different distributed | ||
| tracing systems and is a companion header for the `Traceparent` header. | ||
|
|
||
| See `Tracestate` at [W3C: Trace Context](https://www.w3.org/TR/trace-context-1/#tracestate-header). |
There was a problem hiding this comment.
ℹ️ I've replaces provisional (and unused) X-Trace with optional Trace Context (Traceparent, Tracestate) and Server-Timing headers, ensuring implementers align on the latest best practices
lidel
commented
Jul 3, 2023
| - If TTL value is unknown, implementations are free to set it to a static | ||
| value, but it should not be lower than 60 seconds. | ||
| - Implementations MAY place an upper bound on any TTL received, as | ||
| noted in Section 8 of :cite[rfc2181]. |
There was a problem hiding this comment.
ℹ️ fixed a typo, it now points at DNS-related RFC
hacdias
approved these changes
Jul 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This editorial PR: replaces ambiguous 'free to' with SHOULD/MAY