docs: Traceparent

ipfs · Jun 26, 2024 · 99f0b46 · 99f0b46
1 parent 0a58582
commit 99f0b46
Showing 1 changed file with 22 additions and 2 deletions.
diff --git a/docs/headers.md b/docs/headers.md
@@ -6,11 +6,31 @@ See [`RAINBOW_TRACING_AUTH`](./environment-variables.md#rainbow_tracing_auth)
 
 ## `Traceparent`
 
-See [`RAINBOW_TRACING_AUTH`](./environment-variables.md#rainbow_tracing_auth)
+Optional. Clients may use this header to return a additional vendor-specific trace identification information across different distributed tracing systems.
+
+Currently ignored unless `Authorization` matches [`RAINBOW_TRACING_AUTH`](./environment-variables.md#rainbow_tracing_auth).
+
+> [!TIP]
+> `Traceparent` value format is `00-32HEX-16HEX-2HEX`, for example:
+> ```
+> Traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00
+> base16(version) = 00 // version, currently always 00
+> base16(trace-id) = 4bf92f3577b34da6a3ce929d0e0e4736
+> base16(parent-id) = 00f067aa0ba902b7
+> base16(trace-flags) = 00  // 00 means not sampled (manual), 01 means sampled
+> ```
+> 
+> See [W3C Trace Context Specification](https://www.w3.org/TR/trace-context-1/#trace-context-http-headers-format) for more details.
 
 ## `Tracestate`
 
-See [`RAINBOW_TRACING_AUTH`](./environment-variables.md#rainbow_tracing_auth)
+Optional. Clients may use this header to return a additional vendor-specific trace identification information in addition to `Traceparent`.
+
+Currently ignored unless `Authorization` matches [`RAINBOW_TRACING_AUTH`](./environment-variables.md#rainbow_tracing_auth).
+
+> [!TIP]
+> `Tracestate` value format is 
+> See [W3C Trace Context Specification](https://www.w3.org/TR/trace-context-1/#trace-context-http-headers-format).
 
 ## Rainbow-No-Blockcache