Skip to content

fix(docs): update log injection support [backport 3.10] #14052

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

Closed
wants to merge 1 commit into from

Conversation

github-actions[bot]
Copy link
Contributor

Backport 5494169 from #14031 to 3.10.

With ddtrace v3.10.0 log injection is enabled by default for structured loggers. This PR updates documentation and adds a more release note.

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

@mabdinur mabdinur closed this Jul 17, 2025
@mabdinur mabdinur reopened this Jul 17, 2025
Copy link
Contributor Author

CODEOWNERS have been resolved as:

releasenotes/notes/feat-log-injection-enabled-by-default-395259b0419c7a5f.yaml  @DataDog/apm-python
ddtrace/contrib/_logging.py                                             @DataDog/apm-core-python @DataDog/apm-idm-python
docs/configuration.rst                                                  @DataDog/python-guild

With ddtrace v3.10.0 `log injection` is enabled by default for
structured loggers. This PR updates documentation and adds a more
release note.

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

---------

Co-authored-by: Brett Langdon <[email protected]>
(cherry picked from commit 5494169)
@mabdinur mabdinur force-pushed the backport-14031-to-3.10 branch from 4404085 to 4e0b86e Compare July 17, 2025 19:39
Copy link
Contributor Author

github-actions bot commented Jul 17, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 279 ± 3 ms.

The average import time from base is: 282 ± 3 ms.

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

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 2.010 ms (0.72%)
ddtrace.bootstrap.sitecustomize 1.328 ms (0.48%)
ddtrace.bootstrap.preload 1.328 ms (0.48%)
ddtrace.internal.remoteconfig.client 0.676 ms (0.24%)
ddtrace 0.682 ms (0.24%)
ddtrace.internal._unpatched 0.032 ms (0.01%)
json 0.032 ms (0.01%)
json.decoder 0.032 ms (0.01%)
re 0.032 ms (0.01%)
enum 0.032 ms (0.01%)
types 0.032 ms (0.01%)

@pr-commenter
Copy link

pr-commenter bot commented Jul 17, 2025

Benchmarks

Benchmark execution time: 2025-07-17 20:49:19

Comparing candidate commit 4e0b86e in PR branch backport-14031-to-3.10 with baseline commit 1f8c272 in branch 3.10.

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

scenario:iastaspectsospath-ospathjoin_aspect

  • 🟥 execution_time [+785.383ns; +958.534ns] or [+12.734%; +15.542%]

scenario:iastaspectsospath-ospathnormcase_aspect

  • 🟥 execution_time [+340.982ns; +419.130ns] or [+9.768%; +12.007%]

scenario:iastaspectsospath-ospathsplit_aspect

  • 🟥 execution_time [+870.935ns; +1066.372ns] or [+17.907%; +21.926%]

@brettlangdon
Copy link
Member

This is a new feature, not a bug fix, cannot be backported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants