Doc: Updated GraphQL settings that only work through env var #4842
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4842 +/- ##
==========================================
- Coverage 97.55% 97.55% -0.01%
==========================================
Files 1490 1490
Lines 89156 89155 -1
Branches 4713 4713
==========================================
- Hits 86978 86973 -5
- Misses 2178 2182 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
domalessi
approved these changes
Aug 6, 2025
p-datadog
reviewed
Aug 7, 2025
| | `with_unified_tracer` | `DD_TRACE_GRAPHQL_WITH_UNIFIED_TRACER` | `Bool` | (Recommended) Enable to instrument with `UnifiedTrace` tracer for `graphql` >= v2.2, **enabling support for Endpoints list** in the Service Catalog. `with_deprecated_tracer` has priority over this. Default is `false`, using `GraphQL::Tracing::DataDogTrace` instead. This option is disabled by default to maintain backwards compatibility, but **will become the default in `datadog` 3.0.0**. | `false` | | ||
| | `with_deprecated_tracer` | | `Bool` | (Not recommended) Enable to instrument with deprecated `GraphQL::Tracing::DataDogTracing`. This has priority over `with_unified_tracer`. Default is `false`, using `GraphQL::Tracing::DataDogTrace` instead | `false` | | ||
| | <!---`with_unified_tracer`--> | `DD_TRACE_GRAPHQL_WITH_UNIFIED_TRACER` | `Bool` | (Recommended) Enable to instrument with `UnifiedTrace` tracer for `graphql` >= v2.2, **enabling support for Endpoints list** in the Service Catalog. `with_deprecated_tracer` has priority over this. Default is `false`, using `GraphQL::Tracing::DataDogTrace` instead. This option is disabled by default to maintain backwards compatibility, but **will become the default in `datadog` 3.0.0**. | `false` | | ||
| | <!---`with_deprecated_tracer`--> | | `Bool` | (Not recommended) Enable to instrument with deprecated `GraphQL::Tracing::DataDogTracing`. This has priority over `with_unified_tracer`. Default is `false`, using `GraphQL::Tracing::DataDogTrace` instead | `false` | |
There was a problem hiding this comment.
The descriptions still reference with_unified_tracer / with_deprecated_tracer that no longer exist (in these docs) as far as I can tell.
y9v
approved these changes
Aug 8, 2025
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.
What does this PR do?
Related issue comment: #4170 (comment)
This PR updates the documentation on how to configure the GraphQL tracing mechanism, since it cannot be changed once first configuration today (the patching is irreversible).
Because auto-instrumentation always patches GraphQL if available at application startup, trying to change the mechanism in the
Datadog.configureblock does not work.This PR leaves only the environment variable configuration options publicly documented, since they are the only ones that always work reliably.
The ultimate fix for this patching issues is unfortunately a breaking change, thus needs to wait until the next major release.
Change log entry
No.