Skip to content

docs: instrumentation telemetry usage [LANGPLAT-352] #13647

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

Conversation

emmettbutler
Copy link
Collaborator

@emmettbutler emmettbutler commented Jun 11, 2025

This change adds minimal documentation explaining how contributors should use Instrumentation Telemetry.

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

Copy link
Contributor

github-actions bot commented Jun 11, 2025

CODEOWNERS have been resolved as:

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

@emmettbutler emmettbutler added the changelog/no-changelog A changelog entry is not required for this PR. label Jun 11, 2025
@emmettbutler emmettbutler requested a review from mabdinur June 11, 2025 17:45
Copy link
Contributor

github-actions bot commented Jun 11, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

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

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

The import time difference between this PR and base is: -1.5 ± 0.09 ms.

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 1.987 ms (0.73%)
ddtrace.bootstrap.sitecustomize 1.311 ms (0.48%)
ddtrace.bootstrap.preload 1.311 ms (0.48%)
ddtrace.internal.remoteconfig.client 0.633 ms (0.23%)
ddtrace 0.676 ms (0.25%)
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 11, 2025

Benchmarks

Benchmark execution time: 2025-06-12 15:26:29

Comparing candidate commit 63875be in PR branch emmett.butler/telemetry-docs with baseline commit fd2bcdf in branch main.

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

@emmettbutler emmettbutler requested review from wantsui and juanjux June 12, 2025 14:31
@emmettbutler emmettbutler enabled auto-merge (squash) June 17, 2025 21:37
@emmettbutler emmettbutler merged commit 494c4d5 into main Jun 17, 2025
296 of 297 checks passed
@emmettbutler emmettbutler deleted the emmett.butler/telemetry-docs branch June 17, 2025 21:53
sydney-tung pushed a commit that referenced this pull request Jun 24, 2025
This change adds minimal documentation explaining how contributors
should use Instrumentation Telemetry.

## 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)
happynancee pushed a commit that referenced this pull request Jul 7, 2025
This change adds minimal documentation explaining how contributors
should use Instrumentation Telemetry.

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