Skip to content
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

fix(tracing): do not raise exception if partial flush is triggered without any spans [backport 2.9] #9575

Merged
merged 8 commits into from
Jul 1, 2024

Conversation

github-actions[bot]
Copy link

@github-actions github-actions bot commented Jun 18, 2024

Backport fffab01 from #9349 to 2.9.

Adds a guard against on_span_finish() with partial flushing on running into an IndexError because there are no spans to flush (which may happen if tracer.configure() was called between the time a span was created and the time it was finished).

In practice, this turns into:

>>> import ddtrace
>>> with ddtrace.tracer.trace("regression"):
...     ddtrace.tracer.configure(partial_flush_min_spans=1)
...
Partial flush triggered but no spans to flush (was tracer reconfigured?)

This also refactors the test for our os.fork() wrapper to have the child process unpatch coverage (just in case, since it occasionally causes exceptions on exit) and exit cleanly (otherwise it would continue running other tests which is not what we want).

Checklist

  • Change(s) are motivated and described in the PR description
  • Testing strategy is described if automated tests are not included in the PR
  • Risks are described (performance impact, potential for breakage, maintainability)
  • Change is maintainable (easy to change, telemetry, documentation)
  • Library release note guidelines are followed or label changelog/no-changelog is set
  • Documentation is included (in-code, generated user docs, public corp docs)
  • Backport labels are set (if applicable)
  • If this PR changes the public interface, I've notified @DataDog/apm-tees.

Reviewer Checklist

  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Description motivates each change
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Change is maintainable (easy to change, telemetry, documentation)
  • Release note makes sense to a user of the library
  • Author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

…thout any spans (#9349)

Adds a guard against `on_span_finish()` with partial flushing on running
into an `IndexError` because there are no spans to flush (which may
happen if `tracer.configure()` was called between the time a span was
created and the time it was finished).

In practice, this turns into:
```
>>> import ddtrace
>>> with ddtrace.tracer.trace("regression"):
...     ddtrace.tracer.configure(partial_flush_min_spans=1)
...
Partial flush triggered but no spans to flush (was tracer reconfigured?)
```

This also refactors the test for our `os.fork()` wrapper to have the
child process unpatch `coverage` (just in case, since it occasionally
causes exceptions on exit) and exit cleanly (otherwise it would continue
running other tests which is not what we want).

## 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] Risks are described (performance impact, potential for breakage,
maintainability)
- [x] Change is maintainable (easy to change, telemetry, documentation)
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed or label `changelog/no-changelog` is set
- [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))
- [x] If this PR changes the public interface, I've notified
`@DataDog/apm-tees`.

## Reviewer Checklist

- [x] Title is accurate
- [x] All changes are related to the pull request's stated goal
- [x] Description motivates each change
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- [x] Testing strategy adequately addresses listed risks
- [x] Change is maintainable (easy to change, telemetry, documentation)
- [x] Release note makes sense to a user of the library
- [x] Author has 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)

---------

Co-authored-by: Brett Langdon <brett.langdon@datadoghq.com>
Co-authored-by: Federico Mon <federico.mon@datadoghq.com>
Co-authored-by: Emmett Butler <723615+emmettbutler@users.noreply.github.com>
(cherry picked from commit fffab01)
@github-actions github-actions bot requested review from a team as code owners June 18, 2024 09:11
@romainkomorndatadog romainkomorndatadog enabled auto-merge (squash) June 18, 2024 09:34
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Jun 18, 2024

Datadog Report

Branch report: backport-9349-to-2.9
Commit report: 40a6360
Test service: dd-trace-py

✅ 0 Failed, 116363 Passed, 55167 Skipped, 3h 1m 41.52s Total duration (5h 39m 44.18s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jun 18, 2024

Benchmarks

Benchmark execution time: 2024-06-28 08:17:25

Comparing candidate commit eed64d8 in PR branch backport-9349-to-2.9 with baseline commit cf72ae9 in branch 2.9.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 201 metrics, 9 unstable metrics.

@gnufede gnufede closed this Jun 19, 2024
auto-merge was automatically disabled June 19, 2024 07:48

Pull request was closed

@gnufede gnufede reopened this Jun 19, 2024
@gnufede gnufede enabled auto-merge (squash) June 19, 2024 07:49
@romainkomorndatadog romainkomorndatadog self-assigned this Jun 26, 2024
@gnufede gnufede merged commit a3010a9 into 2.9 Jul 1, 2024
159 of 165 checks passed
@gnufede gnufede deleted the backport-9349-to-2.9 branch July 1, 2024 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants