fix(ci_visibility): fix distributed tracing when using CIVisibility [backport 2.1] (#7224)

Backport 0fec776 from #7210 to 2.1.

`CIContextProvider` was introduced in #6548 to enable running tests in
this
repo with the `pytest` plugin, but disabled distributed tracing.

`_DD_CIVISIBILITY_USE_CI_CONTEXT_PROVIDER` is introduced as a private
env var that can be used to activate the `CIContextProvider`. It is
false by
default, returning the behavior of the tracer for regular users to what
it was
before the CI context provider was introduced.

This is primarily a band-aid patch. Using the pytest plugin in this repo
remains a WIP.

This change also sets `_DD_CIVISIBILITY_USE_CI_CONTEXT_PROVIDER`
in `riotfile.py` so that the change is transparent in this repo's CI
runs.

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
- [x] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [x] This PR doesn't touch any of that.

---------

Co-authored-by: Romain Komorn <[email protected]>

Author: github-actions[bot]

ddtrace/internal/ci_visibility/recorder.py

@@ -97,8 +97,11 @@ def __init__(self, tracer=None, config=None, service=None):
         if tracer:
             self.tracer = tracer
         else:
-            # Create a new CI tracer
-            self.tracer = Tracer(context_provider=CIContextProvider())
+            if asbool(os.getenv("_DD_CIVISIBILITY_USE_CI_CONTEXT_PROVIDER")):
+                # Create a new CI tracer
+                self.tracer = Tracer(context_provider=CIContextProvider())
+            else:
+                self.tracer = Tracer()
 
         self._api_key = os.getenv("_CI_DD_API_KEY", os.getenv("DD_API_KEY"))
 

releasenotes/notes/ci_visibility-fix-distributed_tracing-733103ba3a19f3f7.yaml

@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    CI Visibility: fixes distributed tracing when using the CI Visibility
+    integration
+    

riotfile.py

@@ -98,6 +98,7 @@ def select_pys(min_version=MIN_PYTHON_VERSION, max_version=MAX_PYTHON_VERSION):
         "hypothesis": "<6.45.1",
     },
     env={
+        "_DD_CIVISIBILITY_USE_CI_CONTEXT_PROVIDER": "1",
         "DD_TESTING_RAISE": "1",
         "DD_REMOTE_CONFIGURATION_ENABLED": "false",
         "DD_CIVISIBILITY_AGENTLESS_ENABLED": "1",