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(profiling): reduce lock profiler log spam #11377

Merged
merged 3 commits into from
Nov 13, 2024

Conversation

nsrip-dd
Copy link
Contributor

@nsrip-dd nsrip-dd commented Nov 13, 2024

The lock profiler would log a warning if it couldn't determine a
name for a lock, and it would try determining a name multiple times for
the same lock. This lead to excessive log spam. Downgrade this to a
debug log and only try to determine the name once.

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

PROF-10898

The lock profiler would log a warning if it couldn't determine a name
for a lock. This lead to excessive log spam. Downgrade this to a debug
log.
@nsrip-dd nsrip-dd marked this pull request as ready for review November 13, 2024 14:48
@nsrip-dd nsrip-dd requested review from a team as code owners November 13, 2024 14:48
Copy link
Contributor

CODEOWNERS have been resolved as:

releasenotes/notes/profiling-reduce-lock-profiler-log-spam-5931d957ff1becd4.yaml  @DataDog/apm-python
ddtrace/profiling/collector/_lock.py                                    @DataDog/profiling-python

We check "if self._self_name" to avoid setting the name more than once,
but that will evaluate to false for `self._self_name == ""`, so we do
the name check every time even if we failed the first time.
@taegyunkim
Copy link
Contributor

Thank you for the fix!

@pr-commenter
Copy link

pr-commenter bot commented Nov 13, 2024

Benchmarks

Benchmark execution time: 2024-11-13 15:38:04

Comparing candidate commit f6fb08c in PR branch nick.ripley/fix-lock-profiler-log-spam with baseline commit 48e8952 in branch main.

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

scenario:iast_aspects-ospathnormcase_aspect

  • 🟩 execution_time [-287.466ns; -259.614ns] or [-10.640%; -9.609%]

@nsrip-dd
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 13, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-13 15:33:56 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2024-11-13 15:34:01 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2024-11-13 16:18:44 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2024-11-13 17:00:51 UTCMergeQueue: This merge request was updated

This PR is rejected because it was updated

@nsrip-dd
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 13, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-13 17:05:54 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2024-11-13 17:05:58 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2024-11-13 17:39:39 UTCMergeQueue: The checks failed on this merge request

Tests failed on this commit 8c0e0cf:

What to do next?

  • Investigate the failures and when ready, re-add your pull request to the queue!
  • Any question, go check the FAQ.

@nsrip-dd
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 13, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-13 17:52:54 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2024-11-13 17:52:57 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2024-11-13 18:25:35 UTCMergeQueue: The checks failed on this merge request

Tests failed on this commit ab1ac09:

What to do next?

  • Investigate the failures and when ready, re-add your pull request to the queue!
  • Any question, go check the FAQ.

@nsrip-dd
Copy link
Contributor Author

For those watching at home, I've tried the merge queue 3 times and it's failed for different reasons each time :( I'm just going to squash and merge, I'm reasonably confident that the failures are not related to this change.

@nsrip-dd nsrip-dd merged commit 079e478 into main Nov 13, 2024
676 of 677 checks passed
@nsrip-dd nsrip-dd deleted the nick.ripley/fix-lock-profiler-log-spam branch November 13, 2024 18:57
github-actions bot pushed a commit that referenced this pull request Nov 13, 2024
The lock profiler would log a warning if it couldn't determine a
name for a lock, and it would try determining a name multiple times for
the same lock. This lead to excessive log spam. Downgrade this to a
debug log and only try to determine the name once.

(cherry picked from commit 079e478)
github-actions bot pushed a commit that referenced this pull request Nov 13, 2024
The lock profiler would log a warning if it couldn't determine a
name for a lock, and it would try determining a name multiple times for
the same lock. This lead to excessive log spam. Downgrade this to a
debug log and only try to determine the name once.

(cherry picked from commit 079e478)
Copy link
Contributor

The backport to 2.17 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.17 2.17
# Navigate to the new working tree
cd .worktrees/backport-2.17
# Create a new branch
git switch --create backport-11377-to-2.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 079e4789ccd86b1aa567238d525ba45c1cedce56
# Push it to GitHub
git push --set-upstream origin backport-11377-to-2.17
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.17

Then, create a pull request where the base branch is 2.17 and the compare/head branch is backport-11377-to-2.17.

Copy link
Contributor

The backport to 2.17 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.17 2.17
# Navigate to the new working tree
cd .worktrees/backport-2.17
# Create a new branch
git switch --create backport-11377-to-2.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 079e4789ccd86b1aa567238d525ba45c1cedce56
# Push it to GitHub
git push --set-upstream origin backport-11377-to-2.17
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.17

Then, create a pull request where the base branch is 2.17 and the compare/head branch is backport-11377-to-2.17.

taegyunkim added a commit that referenced this pull request Nov 13, 2024
Backport 079e478 from #11377 to 2.16.

The lock profiler would log a warning if it couldn't determine a
name for a lock, and it would try determining a name multiple times for
the same lock.  This lead to excessive log spam. Downgrade this to a
debug log and only try to determine the name once.

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

PROF-10898

Co-authored-by: Nick Ripley <[email protected]>
Co-authored-by: Taegyun Kim <[email protected]>
taegyunkim pushed a commit that referenced this pull request Nov 13, 2024
Backport 079e478 from #11377 to 2.15.

The lock profiler would log a warning if it couldn't determine a
name for a lock, and it would try determining a name multiple times for
the same lock.  This lead to excessive log spam. Downgrade this to a
debug log and only try to determine the name once.

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

PROF-10898

Co-authored-by: Nick Ripley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants