Skip to content

chore(profiling): add ddup_export_to_file() to address problems with uwsgi tests#11125

Closed
taegyunkim wants to merge 48 commits into
mainfrom
taegyunkim/prof-10736-v2-test
Closed

chore(profiling): add ddup_export_to_file() to address problems with uwsgi tests#11125
taegyunkim wants to merge 48 commits into
mainfrom
taegyunkim/prof-10736-v2-test

Conversation

@taegyunkim

@taegyunkim taegyunkim commented Oct 22, 2024

Copy link
Copy Markdown
Contributor

While testing stack v1 with the libdatadog exporter in #13464, notice the following. When uwsgi is invoked with --lazy-apps, tests failed to export pprof file as they're getting corrupted filename here in uploader.cpp. --lazy-apps configures uwsgi to load the application in each worker instead of loading once in the primary process and calling fork(). This also somehow changes how those workers are terminated and seemed like the filename was copied from a std::string that is already destructed. It comes from output_filename field in uploader_builder.hpp from this line.

To address this problem, I changed ddup.upload() to simply take additional parameter, output_filename which is typically set to ddtrace.settings.profiling.output_pprof. However, in _ddup.pyx, we can't set the default value of output_filename to ddtrace.settings.profiling.output_pprof, as doing so results in recursive imports leading to error. And it simply passes Python str backed string_view when exporting to a file.

Even though this PR addresses the problems with uwsgi tests, it's likely that we'd get segmentation faults in customer services with similar problems. I'd investigate that separately.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, 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

@taegyunkim taegyunkim changed the title chore(profiling): gevent tests for stack v2 chore(profiling): port gevent tests for stack v2 Oct 22, 2024
@github-actions

github-actions Bot commented Oct 22, 2024

Copy link
Copy Markdown
Contributor

CODEOWNERS have been resolved as:

tests/profiling_v2/test_uwsgi.py                                        @DataDog/profiling-python
ddtrace/internal/datadog/profiling/dd_wrapper/include/ddup_interface.hpp  @DataDog/profiling-python
ddtrace/internal/datadog/profiling/dd_wrapper/include/uploader.hpp      @DataDog/profiling-python
ddtrace/internal/datadog/profiling/dd_wrapper/include/uploader_builder.hpp  @DataDog/profiling-python
ddtrace/internal/datadog/profiling/dd_wrapper/src/ddup_interface.cpp    @DataDog/profiling-python
ddtrace/internal/datadog/profiling/dd_wrapper/src/uploader.cpp          @DataDog/profiling-python
ddtrace/internal/datadog/profiling/dd_wrapper/src/uploader_builder.cpp  @DataDog/profiling-python
ddtrace/internal/datadog/profiling/ddup/_ddup.pyi                       @DataDog/profiling-python
ddtrace/internal/datadog/profiling/ddup/_ddup.pyx                       @DataDog/profiling-python
ddtrace/profiling/profiler.py                                           @DataDog/profiling-python
ddtrace/profiling/scheduler.py                                          @DataDog/profiling-python
tests/profiling_v2/collector/test_asyncio.py                            @DataDog/profiling-python
tests/profiling_v2/collector/test_memalloc.py                           @DataDog/profiling-python
tests/profiling_v2/collector/test_stack.py                              @DataDog/profiling-python
tests/profiling_v2/collector/test_threading.py                          @DataDog/profiling-python

@pr-commenter

pr-commenter Bot commented Oct 22, 2024

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2025-05-30 03:09:45

Comparing candidate commit 96217a6 in PR branch taegyunkim/prof-10736-v2-test with baseline commit 911cf0f in branch main.

Found 1 performance improvements and 2 performance regressions! Performance is the same for 506 metrics, 7 unstable metrics.

scenario:iastaspects-rstrip_aspect

  • 🟥 execution_time [+1.113µs; +1.402µs] or [+8.674%; +10.925%]

scenario:iastaspectssplit-splitlines_aspect

  • 🟥 execution_time [+167.609ns; +198.881ns] or [+11.429%; +13.562%]

scenario:iastdjangostartup-appsec

  • 🟩 execution_time [-870.046ms; -683.967ms] or [-44.410%; -34.912%]

Comment thread tests/profiling_v2/test_uwsgi.py Fixed
Comment thread tests/profiling_v2/test_uwsgi.py Fixed
Comment thread tests/profiling_v2/test_uwsgi.py Fixed
@taegyunkim taegyunkim changed the title chore(profiling): port gevent tests for stack v2 chore(profiling): port uwsgi tests for stack v2 Oct 30, 2024
@taegyunkim taegyunkim changed the title chore(profiling): port uwsgi tests for stack v2 chore(profiling): port uwsgi tests to stack v2 Nov 12, 2024
@taegyunkim taegyunkim added the changelog/no-changelog A changelog entry is not required for this PR. label May 22, 2025
@taegyunkim
taegyunkim marked this pull request as ready for review May 22, 2025 22:31
@taegyunkim
taegyunkim requested a review from a team as a code owner May 22, 2025 22:31
@taegyunkim taegyunkim changed the title chore(profiling): port uwsgi tests to stack v2 chore(profiling): add ddup_export_to_file() to address problems with uwsgi tests May 23, 2025
taegyunkim added a commit that referenced this pull request Jun 3, 2025
**tl;dr**
1. Use `uwsgi>=2.0.30` which has
unbit/uwsgi#2726
2. When using `uwsgi<2.0.30` with `--lazy-apps`, also set
`--skip-atexit`, if you see crashes when workers exit.

-----------------------------------------------------

The following explanation happens on `uwsgi<2.0.30`

When `uwsgi` is configured with `--lazy-apps`, master doesn't load the
application, and simply `fork()` to create workers. Then, the workers
load the application. This is different from when it's not set. Without
`--lazy-apps`, master process first load the application then `fork()`.

dd-trace-py profiler uses Python stdlib `atexit` module to export the
profile when the process exits. The code run to export references global
static `std::string` variables. However, when `--lazy-apps` option is
set, they are destructed before when the profiler needs them to export
the profile, and this leads to an undefined behavior.

When `--lazy-apps` is not set the following sequence of events happens
1. uwsgi master process, initialize Python plugin, loads the
application.
3. The application calls `import ddtrace.profiling.auto` and this leads
all native extensions imported to the Python app. During the process,
the constructors for global static variables are called and their
destructors would be registered to be called by `atexit()` when the
program exits.
4. The application also registers `Profiler.stop()` function to `uwsgi`
python module's `atexit` attribute.
5. Then `uwsgi` calls `atexit(uwsgi_plugins_atexit)` to register each
plugins atexit callbacks, for Python `uwsgi_python_atexit()` function.
And the function will call `Py_Finalize()`
6. Master `fork()`s workers
7. When SIGTERM is received at the master, it sends SIGINT to its
workers
8. In each worker, `uwsgi_python_atexit()` is called, invoking
`Profiler.stop()` and `Py_Finalize()` is called, then destructors for
global static variables are called.

When `--lazy-apps` is set
1. uwsgi matser process still intializes Python interpreter, but skips
loading the application
3. Then `uwsgi` calls `atexit(uwsgi_plugins_atexit)` to register each
plugins atexit callbacks, for Python `uwsgi_python_atexit()` function.
And the function will call `Py_Finalize()`
4. Master `fork()`s workers
5. Workers load the application. The application calls `import
ddtrace.profiling.auto` and this leads all native extensions imported to
the Python app. During the process, the constructors for global static
variables are called and their destructors would be registered to be
called by C `atexit()` when the program exits.
6. When `--lazy-apps` is set, ddtrace simply uses Python's `atexit`
module to call `Profiler.stop()` when the program exits.
7. When SIGTERM is received at the master, it sends SIGINT to its
workers
8. In each worker, since global destructors are registered later than
`uwsgi_python_atexit()` , they're called first.
9. Then `Py_Finalize()` is called in part of `uwsgi_python_atexit()`
calling `Profiler.stop()`. Then it will access those destructed global
static strings leading to undefined behavior.

To workaround this I have tried three different approaches. 

1. #11125: Simply pass the needed `std::string` from Python side to
native when exporting pprof file for test
2. #13520: Leak the strings needed for exporting profile to prevent them
from destructed
3. #13535: Bundle all needed strings needed for exporting profile, and
create them whenever we try to upload.

The first approach only addresses issues from tests.

The second approach mimics what's suggested in
pytorch/pytorch#42125, but since there are a
few other global static variables we have throughout the profiler, this
still showed crashes from test.

And we got similar results from the third approach, as we did from the
second.


Another way to completely work around this problem is setting
`--skip-atexit` as suggested in
ansible/ansible-ai-connect-service#248.

When `--skip-atexit` is set, `uwsgi` uses `_exit()` instead of `exit()`,
and the former doesn't call any functions registered with `atexit()` or
`on_exit()`. So, the static variable destructors are never called, and
the app no longer crashes.

The profiler also doesn't flush the profile via `atexit()` when
`--skip-atexit` is set, but I'd argue losing a single profile at the end
is better than crashing the application even if the application is
exiting. So we'd need to require our customers to set `--skip-atexit`
when `--lazy-apps` is set.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
@taegyunkim

Copy link
Copy Markdown
Contributor Author

Closing per #13550

@taegyunkim taegyunkim closed this Jun 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/no-changelog A changelog entry is not required for this PR. Profiling Continous Profling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants