fix(profiling): export lock acquire/release call location and variable name

[taegyunkim]

We used to export ":" for the name of a lock. Whenever lock is initialized, we traverse the stack frame to populate these. However, we can't get the variable name of the lock as we haven't yet fully initialized and assigned it to a variable.

Now we traverse the frame whenever _acquire/_release is called to get the caller information. Also, when _acquire is called for the first time, we inspect local and global variables in the caller frame to find the name of this lock variable. With DD_PROFILING_LOCK_NAME_INSPECT_DIR enabled, the lock profiler also inspects attributes of local and global variables to find the name of the lock. This behavior can be turned off with the flag.

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 are followed or label changelog/no-changelog is set
• [x] Documentation is included (in-code, generated user docs, public corp docs)
• [x] Backport labels are set (if applicable)
• [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 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

[datadog-dd-trace-py-rkomorn[bot]]

Datadog Report

Branch report: taegyunkim/prof-9923-lock-names Commit report: 61bb542 Test service: dd-trace-py

:x: 9 Failed (0 Known Flaky), 750 Passed, 790 Skipped, 42m 10.62s Total duration (38m 46.27s time saved)

:x: Failed Tests (9)

This report shows up to 5 failed tests.

• test_lock_acquire_events - test_threading_asyncio.py

• test_lock_acquire_events - test_threading_asyncio.py - Details

  Expand for error

  ``` Expected status 0, got 1. === Captured STDOUT === === End of captured STDOUT === === Captured STDERR === Unable to export profile: ddtrace.profiling.exporter.ExportError: HTTP upload request failed: [Errno 99] Cannot assign requested address. Ignoring. Traceback (most recent call last): File "tests/profiling/collector/test_threading_asyncio.py", line 43, in assert lock_found == 2, lock_found AssertionError: 0 === End of captured STDERR === ```

• test_lock_acquire_events - test_threading_asyncio.py - Details

  Expand for error

  ``` Expected status 0, got 1. === Captured STDOUT === === End of captured STDOUT === === Captured STDERR === Unable to export profile: ddtrace.profiling.exporter.ExportError: HTTP upload request failed: [Errno 99] Cannot assign requested address. Ignoring. Traceback (most recent call last): File "tests/profiling/collector/test_threading_asyncio.py", line 43, in assert lock_found == 2, lock_found AssertionError: 0 === End of captured STDERR === ```

• test_lock_acquire_events - test_threading_asyncio.py - Details

  Expand for error

  ``` Expected status 0, got 1. === Captured STDOUT === === End of captured STDOUT === === Captured STDERR === Unable to export profile: ddtrace.profiling.exporter.ExportError: HTTP upload request failed: [Errno 99] Cannot assign requested address. Ignoring. Traceback (most recent call last): File "tests/profiling/collector/test_threading_asyncio.py", line 43, in assert lock_found == 2, lock_found AssertionError: 0 === End of captured STDERR === ```
• test_lock_acquire_events - test_threading_asyncio.py

[pr-commenter[bot]]

Benchmarks

Benchmark execution time: 2024-06-27 21:35:04

Comparing candidate commit 91f840c525dc42ad44868096c8cb216fbb741986 in PR branch taegyunkim/prof-9923-lock-names with baseline commit 303d20266ac4a07687ce05b0ecb8280f3a742517 in branch main.

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

[datadog-dd-trace-py-rkomorn[bot]]

Datadog Report

Branch report: taegyunkim/prof-9923-lock-names Commit report: 19cd74e Test service: dd-trace-py

:white_check_mark: 0 Failed, 812 Passed, 783 Skipped, 39m 15.07s Total duration (48m 59.42s time saved)