refactor: extract OpenTelemetryServiceFieldsConfig mixin#94
Merged
Conversation
opentelemetry_service_name and opentelemetry_namespace were declared identically on both OpentelemetryConfig and PyroscopeConfig. In the four framework configs (Free, FastAPI, Litestar, FastStream) that inherit from both parents, Python's MRO happened to pick one declaration; the fact that defaults matched is what kept behavior consistent. Without the mixin, drifting defaults on one side would silently misbehave on the framework configs. Extract OpenTelemetryServiceFieldsConfig(BaseConfig) — a tiny mixin declaring just those two fields. Both OpentelemetryConfig and PyroscopeConfig now inherit from it (no longer from BaseConfig directly). The duplicate declarations are removed. PyroscopeConfig's standalone use case (without OpentelemetryConfig in the MRO) is preserved — exercised by test_pyroscope_standalone_config_accepts_otel_fields. Closes DES-2 from the audit.
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
opentelemetry_service_nameandopentelemetry_namespacewere declared identically on bothOpentelemetryConfigandPyroscopeConfig. In the four framework configs (Free, FastAPI, Litestar, FastStream) that inherit from both parents, Python's MRO happened to pick one declaration; the fact that defaults matched is what kept behavior consistent. Without the mixin, drifting defaults on one side would silently misbehave on the framework configs.Extract
OpenTelemetryServiceFieldsConfig(BaseConfig)— a tiny mixin declaring just those two fields. BothOpentelemetryConfigandPyroscopeConfignow inherit from it (no longer fromBaseConfigdirectly). The duplicate declarations are removed.PyroscopeConfig's standalone use case (withoutOpentelemetryConfigin the MRO) is preserved — exercised bytest_pyroscope_standalone_config_accepts_otel_fields.Closes DES-2 from an internal audit.
Test plan
just test -- tests/instruments/test_opentelemetry_instrument.py tests/instruments/test_pyroscope_instrument.py -v— pass.just test— full suite 89/89.just lint— clean.pyroscope_instrument→opentelemetry_instrument) is acceptable. Code review confirmed: no circular import —opentelemetry_instrumentimports thepyroscopepackage, notpyroscope_instrument.Notes for reviewer
The MRO for
FreeBootstrapperConfig(LoggingConfig, OpentelemetryConfig, PyroscopeConfig, SentryConfig)resolves as:FreeBootstrapperConfig → LoggingConfig → OpentelemetryConfig → PyroscopeConfig → OpenTelemetryServiceFieldsConfig → SentryConfig → BaseConfig → objectOpenTelemetryServiceFieldsConfigappears exactly once via C3 linearization — both children share the same ancestor.Cosmetic future-work note:
OpentelemetryConfig(lowercaset) sits next to the newOpenTelemetryServiceFieldsConfig(uppercaseT) — same module, different casing. Worth a rename + deprecation alias in a follow-up PR. Out of scope here.🤖 Generated with Claude Code