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

chore(asm): improve logs in asm_request_context [backport 2.16] #11325

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Nov 7, 2024

Backport 1141754 from #11307 to 2.16.

Improve logs in asm_request_context

  • Use log strings with context::function::info
  • Add tool to get the previous frame info to know where the function was called from (disabled for python 3.7)
  • Add unit test
  • Upgrade a few logs from debug to warning

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

Improve logs in asm_request_context

- Use log strings with context::function::info
- Add tool to get the previous frame info to know where the function was
called from (disabled for python 3.7)
- Add unit test
- Upgrade a few logs from debug to warning

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

(cherry picked from commit 1141754)
@github-actions github-actions bot requested a review from a team as a code owner November 7, 2024 13:20
@github-actions github-actions bot added changelog/no-changelog A changelog entry is not required for this PR. ASM Application Security Monitoring labels Nov 7, 2024
@christophe-papazian christophe-papazian enabled auto-merge (squash) November 7, 2024 13:27
Copy link
Contributor Author

github-actions bot commented Nov 7, 2024

CODEOWNERS have been resolved as:

ddtrace/appsec/_asm_request_context.py                                  @DataDog/asm-python
ddtrace/appsec/_utils.py                                                @DataDog/asm-python
tests/appsec/appsec/test_asm_request_context.py                         @DataDog/asm-python

@pr-commenter
Copy link

pr-commenter bot commented Nov 7, 2024

Benchmarks

Benchmark execution time: 2024-11-07 14:06:08

Comparing candidate commit f40d864 in PR branch backport-11307-to-2.16 with baseline commit 0d585b0 in branch 2.16.

Found 3 performance improvements and 2 performance regressions! Performance is the same for 383 metrics, 2 unstable metrics.

scenario:iast_aspects-ospathjoin_aspect

  • 🟥 execution_time [+530.633ns; +599.963ns] or [+10.576%; +11.958%]

scenario:iast_aspects-ospathsplit_aspect

  • 🟥 execution_time [+329.922ns; +401.607ns] or [+8.273%; +10.070%]

scenario:iast_aspects-replace_aspect

  • 🟩 execution_time [-586.027ns; -510.573ns] or [-8.134%; -7.087%]

scenario:iast_aspects-rsplit_aspect

  • 🟩 execution_time [-188.240ns; -162.528ns] or [-10.196%; -8.803%]

scenario:iast_aspects-split_aspect

  • 🟩 execution_time [-202.475ns; -178.374ns] or [-11.053%; -9.738%]

@christophe-papazian christophe-papazian merged commit ecee3b9 into 2.16 Nov 7, 2024
519 checks passed
@christophe-papazian christophe-papazian deleted the backport-11307-to-2.16 branch November 7, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ASM Application Security Monitoring changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant