Skip to content

chore(iast): improve microbenchmarks accuracy #13160

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

Merged
merged 2 commits into from
Apr 11, 2025

Conversation

avara1986
Copy link
Member

@avara1986 avara1986 commented Apr 10, 2025

  • remove loops and value config from appsec_iast_aspects/config.yaml and use the default values
  • split appsec_iast_aspects into smaller steps due to the default values returns timeout in the CI
  • Fix exception in appsec_iast_propagation/scenario.py
 File "/app/benchmarks/.venv_baseline/lib/python3.9/site-packages/pyperf/_runner.py", line 494, in task_func
    return time_func(loops, *args)
  File "/app/benchmarks/bm/_scenario.py", line 64, in _pyperf
    run(loops)
  File "/app/benchmarks/scenario.py", line 99, in _
    launch_function(self.iast_enabled, func, self.internal_loop, caller_loop)
  File "/app/benchmarks/scenario.py", line 81, in launch_function
    tainted_value = new_request(enable_propagation)
  File "/app/benchmarks/scenario.py", line 75, in new_request
    taint_pyobject_with_ranges(tainted, (CHECK_RANGES[0],))
  File "/app/benchmarks/scenario.py", line 41, in taint_pyobject_with_ranges
    set_ranges(pyobject, tuple(ranges))
ValueError: iast::propagation::native::error::Tainted Map isn't initialized
Traceback (most recent call last):

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

@avara1986 avara1986 added changelog/no-changelog A changelog entry is not required for this PR. ASM Application Security Monitoring backport 2.21 backport 3.3 backport 3.4 labels Apr 10, 2025
Copy link
Contributor

github-actions bot commented Apr 10, 2025

CODEOWNERS have been resolved as:

benchmarks/appsec_iast_aspects_ospath/config.yaml                       @DataDog/asm-python
benchmarks/appsec_iast_aspects_ospath/functions.py                      @DataDog/asm-python
benchmarks/appsec_iast_aspects_ospath/scenario.py                       @DataDog/asm-python
benchmarks/appsec_iast_aspects_re_module/config.yaml                    @DataDog/asm-python
benchmarks/appsec_iast_aspects_re_module/functions.py                   @DataDog/asm-python
benchmarks/appsec_iast_aspects_re_module/scenario.py                    @DataDog/asm-python
benchmarks/appsec_iast_aspects_split/config.yaml                        @DataDog/asm-python
benchmarks/appsec_iast_aspects_split/functions.py                       @DataDog/asm-python
benchmarks/appsec_iast_aspects_split/scenario.py                        @DataDog/asm-python
.gitlab/benchmarks/microbenchmarks.yml                                  @DataDog/python-guild @DataDog/apm-core-python
benchmarks/appsec_iast_aspects/config.yaml                              @DataDog/asm-python
benchmarks/appsec_iast_aspects/functions.py                             @DataDog/asm-python
benchmarks/appsec_iast_propagation/scenario.py                          @DataDog/asm-python

Copy link
Contributor

github-actions bot commented Apr 10, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 228 ± 2 ms.

The average import time from base is: 230 ± 1 ms.

The import time difference between this PR and base is: -1.28 ± 0.08 ms.

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 1.922 ms (0.84%)
ddtrace.bootstrap.sitecustomize 1.265 ms (0.55%)
ddtrace.bootstrap.preload 1.265 ms (0.55%)
ddtrace.internal.products 1.265 ms (0.55%)
ddtrace.internal.remoteconfig.client 0.606 ms (0.27%)
ddtrace 0.657 ms (0.29%)

@pr-commenter
Copy link

pr-commenter bot commented Apr 10, 2025

Benchmarks

Benchmark execution time: 2025-04-10 18:39:04

Comparing candidate commit 23debd8 in PR branch avara1986/improve_benchmarks with baseline commit 3712041 in branch main.

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

@avara1986 avara1986 marked this pull request as ready for review April 10, 2025 18:11
@avara1986 avara1986 requested review from a team as code owners April 10, 2025 18:11
@avara1986 avara1986 merged commit b1950af into main Apr 11, 2025
690 of 692 checks passed
@avara1986 avara1986 deleted the avara1986/improve_benchmarks branch April 11, 2025 11:18
Copy link
Contributor

The backport to 2.21 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.21 2.21
# Navigate to the new working tree
cd .worktrees/backport-2.21
# Create a new branch
git switch --create backport-13160-to-2.21
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 b1950af570271cc1a17e3b3c484aa9613df72002
# Push it to GitHub
git push --set-upstream origin backport-13160-to-2.21
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.21

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

Copy link
Contributor

The backport to 3.3 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-3.3 3.3
# Navigate to the new working tree
cd .worktrees/backport-3.3
# Create a new branch
git switch --create backport-13160-to-3.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 b1950af570271cc1a17e3b3c484aa9613df72002
# Push it to GitHub
git push --set-upstream origin backport-13160-to-3.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-3.3

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

Copy link
Contributor

The backport to 3.4 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-3.4 3.4
# Navigate to the new working tree
cd .worktrees/backport-3.4
# Create a new branch
git switch --create backport-13160-to-3.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 b1950af570271cc1a17e3b3c484aa9613df72002
# Push it to GitHub
git push --set-upstream origin backport-13160-to-3.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-3.4

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

avara1986 added a commit that referenced this pull request Apr 11, 2025
- remove `loops` and `value` config from appsec_iast_aspects/config.yaml
and use the default values
- split `appsec_iast_aspects` into smaller steps due to the default
values returns timeout in the CI
- Fix exception in `appsec_iast_propagation/scenario.py`
```
 File "/app/benchmarks/.venv_baseline/lib/python3.9/site-packages/pyperf/_runner.py", line 494, in task_func
    return time_func(loops, *args)
  File "/app/benchmarks/bm/_scenario.py", line 64, in _pyperf
    run(loops)
  File "/app/benchmarks/scenario.py", line 99, in _
    launch_function(self.iast_enabled, func, self.internal_loop, caller_loop)
  File "/app/benchmarks/scenario.py", line 81, in launch_function
    tainted_value = new_request(enable_propagation)
  File "/app/benchmarks/scenario.py", line 75, in new_request
    taint_pyobject_with_ranges(tainted, (CHECK_RANGES[0],))
  File "/app/benchmarks/scenario.py", line 41, in taint_pyobject_with_ranges
    set_ranges(pyobject, tuple(ranges))
ValueError: iast::propagation::native::error::Tainted Map isn't initialized
Traceback (most recent call last):
```
- [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))

- [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 b1950af)
avara1986 added a commit that referenced this pull request Apr 11, 2025
- remove `loops` and `value` config from appsec_iast_aspects/config.yaml
and use the default values
- split `appsec_iast_aspects` into smaller steps due to the default
values returns timeout in the CI
- Fix exception in `appsec_iast_propagation/scenario.py`
```
 File "/app/benchmarks/.venv_baseline/lib/python3.9/site-packages/pyperf/_runner.py", line 494, in task_func
    return time_func(loops, *args)
  File "/app/benchmarks/bm/_scenario.py", line 64, in _pyperf
    run(loops)
  File "/app/benchmarks/scenario.py", line 99, in _
    launch_function(self.iast_enabled, func, self.internal_loop, caller_loop)
  File "/app/benchmarks/scenario.py", line 81, in launch_function
    tainted_value = new_request(enable_propagation)
  File "/app/benchmarks/scenario.py", line 75, in new_request
    taint_pyobject_with_ranges(tainted, (CHECK_RANGES[0],))
  File "/app/benchmarks/scenario.py", line 41, in taint_pyobject_with_ranges
    set_ranges(pyobject, tuple(ranges))
ValueError: iast::propagation::native::error::Tainted Map isn't initialized
Traceback (most recent call last):
```
- [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))

- [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 b1950af)
avara1986 added a commit that referenced this pull request Apr 22, 2025
Backport #13160 to 3.4

- remove `loops` and `value` config from appsec_iast_aspects/config.yaml
and use the default values
- split `appsec_iast_aspects` into smaller steps due to the default
values returns timeout in the CI
- Fix exception in `appsec_iast_propagation/scenario.py`
```
 File "/app/benchmarks/.venv_baseline/lib/python3.9/site-packages/pyperf/_runner.py", line 494, in task_func
    return time_func(loops, *args)
  File "/app/benchmarks/bm/_scenario.py", line 64, in _pyperf
    run(loops)
  File "/app/benchmarks/scenario.py", line 99, in _
    launch_function(self.iast_enabled, func, self.internal_loop, caller_loop)
  File "/app/benchmarks/scenario.py", line 81, in launch_function
    tainted_value = new_request(enable_propagation)
  File "/app/benchmarks/scenario.py", line 75, in new_request
    taint_pyobject_with_ranges(tainted, (CHECK_RANGES[0],))
  File "/app/benchmarks/scenario.py", line 41, in taint_pyobject_with_ranges
    set_ranges(pyobject, tuple(ranges))
ValueError: iast::propagation::native::error::Tainted Map isn't initialized
Traceback (most recent call last):
```
## 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)
avara1986 added a commit that referenced this pull request May 7, 2025
Backport #13160 to 2.21

- remove `loops` and `value` config from appsec_iast_aspects/config.yaml
and use the default values
- split `appsec_iast_aspects` into smaller steps due to the default
values returns timeout in the CI
- Fix exception in `appsec_iast_propagation/scenario.py`
```
 File "/app/benchmarks/.venv_baseline/lib/python3.9/site-packages/pyperf/_runner.py", line 494, in task_func
    return time_func(loops, *args)
  File "/app/benchmarks/bm/_scenario.py", line 64, in _pyperf
    run(loops)
  File "/app/benchmarks/scenario.py", line 99, in _
    launch_function(self.iast_enabled, func, self.internal_loop, caller_loop)
  File "/app/benchmarks/scenario.py", line 81, in launch_function
    tainted_value = new_request(enable_propagation)
  File "/app/benchmarks/scenario.py", line 75, in new_request
    taint_pyobject_with_ranges(tainted, (CHECK_RANGES[0],))
  File "/app/benchmarks/scenario.py", line 41, in taint_pyobject_with_ranges
    set_ranges(pyobject, tuple(ranges))
ValueError: iast::propagation::native::error::Tainted Map isn't initialized
Traceback (most recent call last):
```
## 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ASM Application Security Monitoring backport 2.21 backport 3.3 backport 3.4 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.

2 participants