Skip to content

Commit 7601df4

Browse files
authored
Clarify declarative config component provider type parameter (#4799)
From feedback here: #4568 (comment) /cc @open-telemetry/configuration-maintainers, @pellared
1 parent c2cfe71 commit 7601df4

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ release.
4444
- Declarative configuration: add links between SDK extension plugins and
4545
corresponding declarative config types.
4646
([#4802](https://github.com/open-telemetry/opentelemetry-specification/pull/4802))
47+
- Declarative configuration: clarify Registry ComponentProvider `type` parameter
48+
([#4799](https://github.com/open-telemetry/opentelemetry-specification/pull/4799))
4749

4850
### Common
4951

specification/configuration/sdk.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,15 +339,19 @@ as `ComponentProvider`s.
339339
**Parameters:**
340340

341341
* `component_provider` - The `ComponentProvider`.
342-
* `type` - The type of plugin interface it provides (e.g. SpanExporter, Sampler,
343-
etc).
342+
* `type` - The type of plugin interface it provides.
344343
* `name` - The name used to identify the type of component. This is used
345344
in [configuration model](./data-model.md) to specify that the
346345
corresponding `component_provider` is to provide the component.
347346

348347
The `type` and `name` comprise a unique key. Register MUST return an error if it
349348
is called multiple times with the same `type` and `name` combination.
350349

350+
SDKs SHOULD represent `type` in a manner that is idiomatic for their language.
351+
For example, a class literal, an enumeration, or similar.
352+
See [supported SDK extension plugins](#sdk-extension-components) for the set of
353+
supported `type` values.
354+
351355
### Examples
352356

353357
#### Via configuration API

0 commit comments

Comments
 (0)