-
Notifications
You must be signed in to change notification settings - Fork 10
docs(traces): document trace context propagation controls #473
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -111,6 +111,8 @@ We currently support the following configuration options. We will update this li | |
| </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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 |
||
|
|
||
|
|
||
| <Warning> | ||
| A check using [the Playwright Test Runner (`@playwright/test`)](https://playwright.dev/docs/intro) will currently run around 30-50% longer than [a regular Playwright check (`playwright`)](https://playwright.dev/docs/library). This is caused by the automatic creation of trace and video assets. We are aware of this and are investigating solutions. If this is significantly degrading the performance of your check, we recommend to divide longer tests into multiple checks. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,9 @@ | |
| | `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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Don't we also support that on PWCS after your recent PR merged? Or did I hallucinate that? |
||
| | `CHECKLY_TRACESTATE` | The W3C `tracestate` header value of the check run's trace. Use it with `CHECKLY_TRACEPARENT` to propagate the full trace context. | Only in Browser and Multistep checks, and only when [Traces](/resolve/traces/overview) is active for the check; unset otherwise. | | ||
| | `PUBLIC_IP_V4` | The IPv4 of the check run execution. | | | ||
| | `PUBLIC_IP_V6` | The IPv6 of the check run execution. | | | ||
| | `REGION` | The current region, e.g. `us-west-1`. | | | ||
| | `RUNTIME_VERSION` | The version of the runtime, e.g, `2023.09`. | Only in Browser, Multistep, and API setup/teardown scripts. | | ||
| | `RUNTIME_VERSION` | The version of the runtime, e.g, `2023.09`. | Only in Browser, Multistep, and API setup/teardown scripts. | | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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