Skip to content

docs: add writeup of how autoinstrumentation works [LANGPLAT-352] #13640

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 11 commits into from
Jun 11, 2025

Conversation

emmettbutler
Copy link
Collaborator

@emmettbutler emmettbutler commented Jun 10, 2025

This change adds a written description of the technical design of autoinstrumentation, for the purpose of making it easier to contribute changes to the library.

The new writing is in contributing-design.rst.

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

@emmettbutler emmettbutler requested a review from a team as a code owner June 10, 2025 17:48
@emmettbutler emmettbutler requested a review from avara1986 June 10, 2025 17:48
@emmettbutler emmettbutler added the changelog/no-changelog A changelog entry is not required for this PR. label Jun 10, 2025
Copy link
Contributor

github-actions bot commented Jun 10, 2025

CODEOWNERS have been resolved as:

docs/contributing-design.rst                                            @DataDog/python-guild
docs/contributing.rst                                                   @DataDog/python-guild
docs/spelling_wordlist.txt                                              @DataDog/python-guild

Copy link
Contributor

github-actions bot commented Jun 10, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

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

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

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

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 2.019 ms (0.72%)
ddtrace.bootstrap.sitecustomize 1.336 ms (0.48%)
ddtrace.bootstrap.preload 1.336 ms (0.48%)
ddtrace.internal.remoteconfig.client 0.640 ms (0.23%)
ddtrace 0.683 ms (0.24%)
ddtrace.internal._unpatched 0.031 ms (0.01%)
json 0.031 ms (0.01%)
json.decoder 0.031 ms (0.01%)
re 0.031 ms (0.01%)
enum 0.031 ms (0.01%)
types 0.031 ms (0.01%)

@pr-commenter
Copy link

pr-commenter bot commented Jun 10, 2025

Benchmarks

Benchmark execution time: 2025-06-11 15:19:05

Comparing candidate commit b7df5a7 in PR branch emmett.butler/design-docs with baseline commit e7c0d74 in branch main.

Found 0 performance improvements and 1 performance regressions! Performance is the same for 555 metrics, 6 unstable metrics.

scenario:iastaspects-format_map_aspect

  • 🟥 execution_time [+425.129ns; +507.787ns] or [+13.121%; +15.672%]

emmettbutler and others added 3 commits June 10, 2025 12:52
Co-authored-by: wantsui <wan.tsui@datadoghq.com>
Co-authored-by: wantsui <wan.tsui@datadoghq.com>
@emmettbutler emmettbutler requested a review from wantsui June 10, 2025 19:55
Co-authored-by: Juanjo Alvarez Martinez <juanjo.alvarezmartinez@datadoghq.com>
@emmettbutler emmettbutler enabled auto-merge (squash) June 11, 2025 13:15
@emmettbutler emmettbutler merged commit 55e0c06 into main Jun 11, 2025
359 checks passed
@emmettbutler emmettbutler deleted the emmett.butler/design-docs branch June 11, 2025 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants