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.7] #9587

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

romainkomorndatadog
Copy link
Collaborator

Backport fffab01 from #9349 to 2.7.

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).

- [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`.

- [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)
@datadog-dd-trace-py-rkomorn
Copy link

Datadog Report

Branch report: backport-9349-to-2.7
Commit report: 1181227
Test service: dd-trace-py

❌ 1 Failed (0 Known Flaky), 54742 Passed, 115761 Skipped, 10h 31m 32.23s Total duration (2h 20m 29.71s time saved)

❌ Failed Tests (1)

  • test_get_distributions - test_packages.py - Details

    Expand for error
     assert {'Deprecated'...dsketch', ...} == {'Deprecated'...dsketch', ...}
       Extra items in the left set:
       'importlib-metadata'
       Extra items in the right set:
       'importlib_metadata'
       Full diff:
         {
          'Deprecated',
          'attrs',
          'bytecode',
     ...
    

@pr-commenter
Copy link

pr-commenter bot commented Jun 18, 2024

Benchmarks

Benchmark execution time: 2024-06-18 18:22:06

Comparing candidate commit 1181227 in PR branch backport-9349-to-2.7 with baseline commit ece781c in branch 2.7.

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

@romainkomorndatadog romainkomorndatadog merged commit 623bfdf into 2.7 Jun 25, 2024
158 of 166 checks passed
@romainkomorndatadog romainkomorndatadog deleted the backport-9349-to-2.7 branch June 25, 2024 13:20
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.

3 participants