docs(traces): document trace context propagation controls - #473
Open
timohuovinen wants to merge 1 commit into
Open
docs(traces): document trace context propagation controls#473timohuovinen wants to merge 1 commit into
timohuovinen wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
thebiglabasky
requested changes
Aug 6, 2026
thebiglabasky
left a comment
thebiglabasky
left a comment
Contributor
There was a problem hiding this comment.
Couple of nits, mostly one question to clarify things really well
| | `CHECK_RUN_ID` | The UUID of the check run execution. | Only available on scheduled runs. | | ||
| | `CHECK_TYPE` | The type of the check, e.g. `BROWSER`. | | | ||
| | `CHECKLY_TRACE_ID` | The OpenTelemetry trace ID of the check run. Use it to correlate the run with the trace in your own observability backend. | Only in Browser and Multistep checks and API setup & teardown scripts, and only when [Traces](/resolve/traces/overview) is active for the check; unset otherwise. | | ||
| | `CHECKLY_TRACEPARENT` | The W3C `traceparent` header value of the check run's trace. Use it to propagate the trace context to your own tooling. | Only in Browser and Multistep checks, and only when [Traces](/resolve/traces/overview) is active for the check; unset otherwise. | |
Contributor
There was a problem hiding this comment.
Don't we also support that on PWCS after your recent PR merged? Or did I hallucinate that?
| </Tab> | ||
| </Tabs> | ||
|
|
||
| To disable automatic trace header injection for Browser checks that use the Playwright Test Runner, define `use.extraHTTPHeaders` in the Playwright configuration. An empty object also disables injection. Checkly preserves the headers that you define, and the [built-in trace environment variables](/detect/synthetic-monitoring/browser-checks/mac-structure#built-in-runtime-variables) remain available. |
Contributor
There was a problem hiding this comment.
I'd put that in a callout and move the warning callout that's below above the tabs to ensure both get eyes attention, but that's a nit
| </Tab> | ||
| </Tabs> | ||
|
|
||
| To disable automatic trace header injection for Browser checks that use the Playwright Test Runner, define `use.extraHTTPHeaders` in the Playwright configuration. An empty object also disables injection. Checkly preserves the headers that you define, and the [built-in trace environment variables](/detect/synthetic-monitoring/browser-checks/mac-structure#built-in-runtime-variables) remain available. |
Contributor
There was a problem hiding this comment.
Shouldn't we elaborate on the specific case when you set traceparent and tracestate in your own extraHTTPHeaders? Are those overriden by us or kept? I think that's worth clarifying too
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 depends on https://github.com/checkly/monorepo/pull/3524 going in first.
Summary
Document how checks can access and control Checkly's W3C trace context:
CHECKLY_TRACEPARENTandCHECKLY_TRACESTATEto the Browser and Multistep runtime variable reference.use.extraHTTPHeaders, including an empty object, disables automatic trace header injection for Browser checks that use the Playwright Test Runner.Affected Components
Test plan
python3 .github/scripts/check_frontmatter.pynpx mint broken-linksgit diff --checkNotes for the Reviewer
New Dependency Submission
Not applicable.
Screenshots
Not applicable. This change only updates reference text.