Skip to content

refactor(config): rename 'known/unknown' to 'built-in/user-defined' terminology#5214

Open
MikeGoldsmith wants to merge 8 commits into
open-telemetry:mainfrom
MikeGoldsmith:mike/config-rename-builtin-plugin
Open

refactor(config): rename 'known/unknown' to 'built-in/user-defined' terminology#5214
MikeGoldsmith wants to merge 8 commits into
open-telemetry:mainfrom
MikeGoldsmith:mike/config-rename-builtin-plugin

Conversation

@MikeGoldsmith
Copy link
Copy Markdown
Member

@MikeGoldsmith MikeGoldsmith commented May 15, 2026

Description

Renames "known" and "unknown" to "built-in" and "user-defined" in the declarative config component loading code. The old terms mapped to JSON Schema internals (properties vs additionalProperties), but "built-in" and "user-defined" are clearer from a user's perspective.

Suggested by @tammy-baylis-swi in #5128, refined by @herin049 ("user-defined" over "plugin").

Scope

Docstrings, comments, and test names across:

  • _common.py_additional_properties decorator docstring
  • _tracer_provider.py — sampler factory docstring and error message
  • codegen/README.md and codegen/dataclass.jinja2 — template comments
  • test_tracer_provider.py — test method names

No functional changes — terminology only.

Closes #5195

Update docstrings, comments, and test names to use clearer
terminology for components that are built into the SDK vs loaded
via entry points as plugins.

Covers the already-merged sampler PR and shared infrastructure.
The pending propagator, exporter, and resource detector PRs will
need the same rename applied when they merge.

Assisted-by: Claude Opus 4.6
@MikeGoldsmith MikeGoldsmith marked this pull request as ready for review May 18, 2026 14:26
@MikeGoldsmith MikeGoldsmith requested a review from a team as a code owner May 18, 2026 14:26
@MikeGoldsmith MikeGoldsmith moved this to Ready for review in Python PR digest May 18, 2026
Comment thread opentelemetry-sdk/src/opentelemetry/sdk/_configuration/_tracer_provider.py Outdated
Rename 'plugin' to 'user-defined' throughout — pairs better with
'built-in' and is less ambiguous.

Assisted-by: Claude Opus 4.6
@MikeGoldsmith MikeGoldsmith changed the title refactor(config): rename 'known/unknown' to 'built-in/plugin' terminology refactor(config): rename 'known/unknown' to 'built-in/user-defined' terminology May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Ready for review

Development

Successfully merging this pull request may close these issues.

refactor(config): rename 'known/unknown' to 'built-in/plugin' in declarative config

2 participants