Skip to content

opentelemetry-sdk: cache tracer configs in Tracer#5007

Merged
xrmx merged 13 commits intoopen-telemetry:mainfrom
xrmx:cache-tracer-config
Apr 1, 2026
Merged

opentelemetry-sdk: cache tracer configs in Tracer#5007
xrmx merged 13 commits intoopen-telemetry:mainfrom
xrmx:cache-tracer-config

Conversation

@xrmx
Copy link
Copy Markdown
Contributor

@xrmx xrmx commented Mar 23, 2026 •
edited
Loading

Description

Instead of creating the TracerConfig at each start_span call, just compute it on change. This changes an internal interface. This also introduces a change in behavior where only a tracer for the same instrumentation scope will be created and then cached.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@xrmx
opentelemetry-sdk: cache tracer configs in Tracer
311d99f 
Instead of creating the TracerConfig at each start_span call, just
compute it on change.
@xrmx xrmx requested a review from a team as a code owner March 23, 2026 17:08
@xrmx xrmx mentioned this pull request Mar 23, 2026
Merged
10 tasks
@xrmx xrmx moved this to Ready for review in Python PR digest Mar 23, 2026
@xrmx
Copy link
Copy Markdown
Contributor Author

xrmx commented Mar 23, 2026 •
edited
Loading

Benchmarks

-------------------------------------------------------------------------------------------------------- benchmark: 6 tests -------------------------------------------------------------------------------------------------------
Name (time in us)                                                 Min                 Max               Mean            StdDev             Median               IQR            Outliers  OPS (Kops/s)            Rounds  Iterations
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_simple_start_span_with_tracer_configurator_rules[None]     12.7530 (1.0)      39.7900 (1.53)     14.0253 (1.0)      0.9216 (1.46)     13.8770 (1.0)      0.7010 (1.17)      744;279       71.3000 (1.0)        8740           1
test_simple_start_span_with_tracer_configurator_rules[10]       12.8790 (1.01)     25.9930 (1.0)      14.2303 (1.01)     0.6878 (1.09)     14.1430 (1.02)     0.5973 (1.0)        374;75       70.2724 (0.99)       2909           1
test_simple_start_span_with_tracer_configurator_rules[1]        13.0920 (1.03)     28.6730 (1.10)     14.3815 (1.03)     0.6356 (1.01)     14.3170 (1.03)     0.6070 (1.02)     1181;152       69.5339 (0.98)       7239           1
test_simple_start_span_with_tracer_configurator_rules[0]        13.1550 (1.03)     30.4540 (1.17)     14.3915 (1.03)     0.6302 (1.0)      14.3320 (1.03)     0.6125 (1.03)     2882;316       69.4855 (0.97)      17352           1
test_simple_start_span_with_tracer_configurator_rules[50]       13.2760 (1.04)     27.8670 (1.07)     14.3546 (1.02)     0.8041 (1.28)     14.2400 (1.03)     0.6080 (1.02)        49;18       69.6643 (0.98)        727           1

-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

after

-------------------------------------------------------------------------------------------------------- benchmark: 6 tests -------------------------------------------------------------------------------------------------------
Name (time in us)                                                 Min                 Max               Mean            StdDev             Median               IQR            Outliers  OPS (Kops/s)            Rounds  Iterations
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_simple_start_span_with_tracer_configurator_rules[0]      12.7130 (1.0)       34.4780 (1.0)      13.9008 (1.0)      0.6829 (1.0)      13.8050 (1.0)      0.5950 (1.14)     1285;287       71.9383 (1.0)        9127           1
test_simple_start_span_with_tracer_configurator_rules[50]     12.8570 (1.01)      85.8870 (2.49)     14.1029 (1.01)     1.0369 (1.52)     13.9990 (1.01)     0.5490 (1.05)      429;429       70.9077 (0.99)      14893           1
test_simple_start_span_with_tracer_configurator_rules[10]     12.8640 (1.01)      57.6480 (1.67)     14.0218 (1.01)     1.1011 (1.61)     13.9040 (1.01)     0.5220 (1.0)       459;583       71.3176 (0.99)      20711           1
test_simple_start_span_with_tracer_configurator_rules[1]      12.9070 (1.02)     186.0220 (5.40)     14.4462 (1.04)     2.6857 (3.93)     14.0930 (1.02)     0.6400 (1.23)     593;1007       69.2222 (0.96)      19222           1
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

herin049
herin049 reviewed Mar 24, 2026
View reviewed changes
Comment thread opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py Outdated
Comment thread opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py Outdated
@xrmx xrmx force-pushed the cache-tracer-config branch from 116b776 to 2dbca74 Compare March 25, 2026 09:49
xrmx
xrmx commented Mar 25, 2026
View reviewed changes
Comment thread opentelemetry-sdk/tests/trace/test_trace.py Outdated
pmcollins
pmcollins reviewed Mar 25, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@pmcollins pmcollins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a positive change overall, thanks for doing this.

Comment thread opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py
pmcollins
pmcollins reviewed Mar 30, 2026
View reviewed changes
Comment thread opentelemetry-sdk/tests/trace/test_trace.py Outdated
Comment thread opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py Outdated
Comment thread opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py Outdated
@xrmx xrmx mentioned this pull request Mar 30, 2026
Closed
pmcollins
pmcollins approved these changes Mar 30, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@pmcollins pmcollins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

lzchen
lzchen reviewed Mar 30, 2026
View reviewed changes
Comment thread opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py
@xrmx xrmx added the Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary label Mar 31, 2026
@xrmx xrmx enabled auto-merge (squash) April 1, 2026 07:09
@xrmx xrmx moved this from Ready for review to Approved PRs in Python PR digest Apr 1, 2026
@xrmx xrmx merged commit 9ed343a into open-telemetry:main Apr 1, 2026
508 checks passed
@github-project-automation github-project-automation Bot moved this from Approved PRs to Done in Python PR digest Apr 1, 2026
@xrmx xrmx mentioned this pull request Apr 14, 2026
Closed
6 tasks
Vitexus pushed a commit to Vitexus/opentelemetry-python that referenced this pull request Apr 30, 2026
@xrmx @Vitexus
opentelemetry-sdk: cache tracer configs in Tracer (open-telemetry#5007)
bb0a3bb 
* opentelemetry-sdk: cache tracer configs in Tracer

Instead of creating the TracerConfig at each start_span call, just
compute it on change.

* Add CHANGELOG

* Fix benchmarks

* Apply Lukas feedback

* Test _set_tracer_configurator handling of broken configurator

* Implement equality dunder method for _TracerConfig

* Reuse tracer for the same instrumentation scope

* Fix typecheck

* Fix typo

* Pablo comments

* Assert equality of tracer configs as dict
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lzchen lzchen lzchen approved these changes

@pmcollins pmcollins pmcollins approved these changes

@herin049 herin049 herin049 approved these changes

Assignees

No one assigned

Labels

Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary

Projects

Python PR digest
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@xrmx @pmcollins @lzchen @herin049
⚡