chore(asm): improve logs for appsec #12928
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
christophe-papazian
added
changelog/no-changelog
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
|
|
Bootstrap import analysisComparison of import times between this PR and base. SummaryThe average import time from this PR is: 243 ± 5 ms. The average import time from base is: 244 ± 4 ms. The import time difference between this PR and base is: -0.8 ± 0.2 ms. Import time breakdownThe following import paths have grown:
|
BenchmarksBenchmark execution time: 2025-04-03 08:29:08 Comparing candidate commit 6278805 in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 498 metrics, 2 unstable metrics. |
…mproving_appsec_log_mechanism
…bug if debug mode
gnufede
reviewed
Mar 31, 2025
gnufede
reviewed
Mar 31, 2025
|
|
…mproving_appsec_log_mechanism
emmettbutler
approved these changes
Apr 1, 2025
ZStriker19
approved these changes
Apr 2, 2025
|
|
christophe-papazian
deleted the
christophe-papazian/improving_appsec_log_mechanism
branch
chojomok
pushed a commit
that referenced
this pull request
Apr 7, 2025
APPSEC-57090
Improve log semantic for the tracer logger.
Motivation: current default rate limit for the tracer log is based on
log position in the file and is the same for all logs. But AppSec would
like to be able to get different rate limit for different logs.
- without any extra arguments, we almost keep the legacy behavior (the
skip message is shorter)
- with `extra={"product":"asm"}` (replace asm by any product or
integration), the main message of the log is considered as a the main
log tag, while the extra dictionary can contains further formatting
options and additions, allowing more context. The main log tag is used
as a key for the rate limiter.
- a function `set_tag_rate_limit` allows to change the rate limit
duration for any specific tag
- At debug level, we still disable any rate limiter.
- We handle the exec_info and stack_info directly to allow customize
depth stack size in reported logs
## 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)
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
APPSEC-57090
Improve log semantic for the tracer logger.
Motivation: current default rate limit for the tracer log is based on log position in the file and is the same for all logs. But AppSec would like to be able to get different rate limit for different logs.
extra={"product":"asm"}(replace asm by any product or integration), the main message of the log is considered as a the main log tag, while the extra dictionary can contains further formatting options and additions, allowing more context. The main log tag is used as a key for the rate limiter.set_tag_rate_limitallows to change the rate limit duration for any specific tagChecklist
Reviewer Checklist