Skip to content

chore(asm): more tags for appsec telemetry #13005

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

Conversation

christophe-papazian
Copy link
Contributor

@christophe-papazian christophe-papazian commented Apr 1, 2025

APPSEC-56592

  • small type refactor, moving some classes from inside _ddwaf to appsec._utils
  • small telemetry refactor with proper definition of a class to accumulate results instead of just using dictionaries.
  • add 2 missing telemetry tags waf_error and rate_limited and telemetry config_error metric counter.
  • update some tests to handle the new tags and metrics

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

@christophe-papazian christophe-papazian added changelog/no-changelog A changelog entry is not required for this PR. ASM Application Security Monitoring labels Apr 1, 2025
Copy link
Contributor

github-actions bot commented Apr 1, 2025

CODEOWNERS have been resolved as:

ddtrace/appsec/_asm_request_context.py                                  @DataDog/asm-python
ddtrace/appsec/_ddwaf/__init__.py                                       @DataDog/asm-python
ddtrace/appsec/_ddwaf/waf_stubs.py                                      @DataDog/asm-python
ddtrace/appsec/_metrics.py                                              @DataDog/asm-python
ddtrace/appsec/_processor.py                                            @DataDog/asm-python
ddtrace/appsec/_utils.py                                                @DataDog/asm-python
tests/appsec/appsec/test_telemetry.py                                   @DataDog/asm-python
tests/appsec/contrib_appsec/utils.py                                    @DataDog/asm-python

Copy link
Contributor

github-actions bot commented Apr 1, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

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

The average import time from base is: 232 ± 2 ms.

The import time difference between this PR and base is: -2.1 ± 0.1 ms.

Import time breakdown

The following import paths have grown:

ddtrace.auto 0.101 ms (0.04%)
ddtrace.bootstrap.sitecustomize 0.101 ms (0.04%)
ddtrace.appsec._common_module_patches 0.101 ms (0.04%)
ddtrace.appsec._asm_request_context 0.101 ms (0.04%)
ddtrace.appsec._utils 0.101 ms (0.04%)

The following import paths have shrunk:

ddtrace.auto 2.022 ms (0.88%)
ddtrace.bootstrap.sitecustomize 1.333 ms (0.58%)
ddtrace.bootstrap.preload 1.284 ms (0.56%)
ddtrace.internal.products 1.284 ms (0.56%)
ddtrace.internal.remoteconfig.client 0.643 ms (0.28%)
ddtrace.appsec._common_module_patches 0.049 ms (0.02%)
ddtrace.appsec._asm_request_context 0.049 ms (0.02%)
ddtrace 0.689 ms (0.30%)
ddtrace.trace 0.017 ms (0.01%)
ddtrace._trace.tracer 0.017 ms (0.01%)
ddtrace.internal.peer_service.processor 0.017 ms (0.01%)

@pr-commenter
Copy link

pr-commenter bot commented Apr 1, 2025

Benchmarks

Benchmark execution time: 2025-04-02 12:20:49

Comparing candidate commit 96bc672 in PR branch christophe-papazian/more_metric_tags_for_waf with baseline commit 5b3a8f2 in branch main.

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

@christophe-papazian christophe-papazian marked this pull request as ready for review April 2, 2025 12:35
@christophe-papazian christophe-papazian requested a review from a team as a code owner April 2, 2025 12:35
@christophe-papazian christophe-papazian enabled auto-merge (squash) April 2, 2025 12:36
@christophe-papazian christophe-papazian merged commit 4ba8976 into main Apr 2, 2025
401 checks passed
@christophe-papazian christophe-papazian deleted the christophe-papazian/more_metric_tags_for_waf branch April 2, 2025 12:42
chojomok pushed a commit that referenced this pull request Apr 7, 2025
APPSEC-56592

- small type refactor, moving some classes from inside _ddwaf to
appsec._utils
- small telemetry refactor with proper definition of a class to
accumulate results instead of just using dictionaries.
- add 2 missing telemetry tags `waf_error` and `rate_limited` and
telemetry config_error metric counter.
- update some tests to handle the new tags and metrics

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