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.

Sign up for GitHub

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

Jump to bottom

fix(logging): only add StreamHandler to logger if not already configured #7359

Merged
merged 13 commits into from
Nov 14, 2023
Merged

fix(logging): only add StreamHandler to logger if not already configured #7359

merged 13 commits into from
Nov 14, 2023

Conversation

ZStriker19
Copy link
Contributor

@ZStriker19 ZStriker19 commented Oct 25, 2023 •
edited by emmettbutler
Loading

#7347

Checklist

  • Change(s) are motivated and described in the PR description.
  • Testing strategy is described if automated tests are not included in the PR.
  • Risk is outlined (performance impact, potential for breakage, maintainability, etc).
  • Change is maintainable (easy to change, telemetry, documentation).
  • Library release note guidelines are followed. If no release note is required, add label changelog/no-changelog.
  • Documentation is included (in-code, generated user docs, public corp docs).
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Title is accurate.
  • No unnecessary changes are introduced.
  • Description motivates each change.
  • Avoids breaking API changes unless absolutely necessary.
  • Testing strategy adequately addresses listed risk(s).
  • Change is maintainable (easy to change, telemetry, documentation).
  • Release note makes sense to a user of the library.
  • Reviewer has explicitly 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
  • If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from @DataDog/security-design-and-guidance.
  • This PR doesn't touch any of that.

@ZStriker19 ZStriker19 requested review from a team as code owners October 25, 2023 16:14
@ZStriker19 ZStriker19 changed the title fix (logging): only add StreamHandler to logger if not already configured fix(logging): only add StreamHandler to logger if not already configured Oct 25, 2023
@ZStriker19 ZStriker19 force-pushed the zachg/only_add_log_handler_if_not_already_configured branch from fba61db to bb4871a Compare October 25, 2023 16:50
brettlangdon
brettlangdon reviewed Oct 25, 2023
View reviewed changes
ddtrace/_logger.py Show resolved Hide resolved
ddtrace/_logger.py Outdated Show resolved Hide resolved
@ZStriker19 ZStriker19 enabled auto-merge (squash) October 25, 2023 17:36
@pr-commenter
Copy link

pr-commenter bot commented Oct 25, 2023 •
edited
Loading

Benchmarks

Benchmark execution time: 2023-11-13 16:30:46

Comparing candidate commit 47bb99e in PR branch zachg/only_add_log_handler_if_not_already_configured with baseline commit 39a4d02 in branch 2.x.

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

scenario:flasksimple-appsec-post

  • 🟩 execution_time [-416.177µs; -284.838µs] or [-6.288%; -4.304%]

scenario:sethttpmeta-obfuscation-regular-case-implicit-query

  • 🟩 max_rss_usage [-746.058KB; -599.069KB] or [-2.521%; -2.025%]

scenario:sethttpmeta-obfuscation-worst-case-explicit-query

  • 🟥 max_rss_usage [+617.267KB; +780.698KB] or [+2.133%; +2.698%]

scenario:sethttpmeta-useragentvariant_not_exists_2

  • 🟩 max_rss_usage [-803.396KB; -596.207KB] or [-2.729%; -2.026%]

scenario:span-start-finish

  • 🟩 max_rss_usage [-725.132KB; -592.141KB] or [-2.491%; -2.034%]

scenario:tracer-medium

  • 🟥 max_rss_usage [+599.198KB; +763.951KB] or [+2.116%; +2.698%]

brettlangdon
brettlangdon reviewed Oct 31, 2023
View reviewed changes
ddtrace/_logger.py Outdated Show resolved Hide resolved
@ZStriker19 ZStriker19 merged commit 5cb0b45 into 2.x Nov 14, 2023
131 checks passed
@ZStriker19 ZStriker19 deleted the zachg/only_add_log_handler_if_not_already_configured branch November 14, 2023 20:47
@github-actions github-actions bot mentioned this pull request Nov 14, 2023
Merged
18 tasks
github-actions bot pushed a commit that referenced this pull request Nov 14, 2023
@ZStriker19 @github-actions
fix(logging): only add StreamHandler to logger if not already configu…
2706161 
…red (#7359)

#7347

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [ ] Title is accurate.
- [ ] No unnecessary changes are introduced.
- [ ] Description motivates each change.
- [ ] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [ ] Testing strategy adequately addresses listed risk(s).
- [ ] Change is maintainable (easy to change, telemetry, documentation).
- [ ] Release note makes sense to a user of the library.
- [ ] Reviewer has explicitly 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)
- [ ] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [ ] This PR doesn't touch any of that.

(cherry picked from commit 5cb0b45)
@github-actions github-actions bot mentioned this pull request Nov 14, 2023
Merged
18 tasks
github-actions bot pushed a commit that referenced this pull request Nov 14, 2023
@ZStriker19 @github-actions
fix(logging): only add StreamHandler to logger if not already configu…
4b9b993 
…red (#7359)

#7347

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [ ] Title is accurate.
- [ ] No unnecessary changes are introduced.
- [ ] Description motivates each change.
- [ ] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [ ] Testing strategy adequately addresses listed risk(s).
- [ ] Change is maintainable (easy to change, telemetry, documentation).
- [ ] Release note makes sense to a user of the library.
- [ ] Reviewer has explicitly 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)
- [ ] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [ ] This PR doesn't touch any of that.

(cherry picked from commit 5cb0b45)
mabdinur pushed a commit that referenced this pull request Nov 16, 2023
@github-actions @ZStriker19
fix(logging): only add StreamHandler to logger if not already configu…
a1ad9b0 
…red [backport 2.0] (#7594)

Backport 5cb0b45 from #7359 to 2.0.

#7347

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] 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)
- [x] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [x] This PR doesn't touch any of that.

Co-authored-by: Zachary Groves <32471391+ZStriker19@users.noreply.github.com>
mabdinur pushed a commit that referenced this pull request Nov 16, 2023
@github-actions @ZStriker19
fix(logging): only add StreamHandler to logger if not already configu…
465e286 
…red [backport 2.1] (#7595)

Backport 5cb0b45 from #7359 to 2.1.

#7347

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] 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)
- [x] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [x] This PR doesn't touch any of that.

Co-authored-by: Zachary Groves <32471391+ZStriker19@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emmettbutler emmettbutler emmettbutler approved these changes

@majorgreys majorgreys Awaiting requested review from majorgreys majorgreys is a code owner automatically assigned from DataDog/apm-core-python

@brettlangdon brettlangdon Awaiting requested review from brettlangdon

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ZStriker19 @emmettbutler @brettlangdon