Skip to content

Commit 55d0572

Browse files
authored
Use consistent vocabulary in reference to components and plugins (#4806)
In response to this feedback: #4568 (comment) The declarative config SDK spec uses "component", "extension plugin interface", "SDK extension plugins" somewhat interchangeable. This PR makes the vocabulary consistent: - component: any part of the SDK, i.e. TracerProvider, SpanExporter, OtlpHttpSpanExporter, Sampler, SpanProcessor, BatchSpanProcessor, etc - plugin component: also called a SDK extension plugin interface elsewhere, any SDK component which is pluggable, i.e. Sampler, SpanExporter, SpanProcessor, **but not** ParentBasedSampler To facilitate, this PR: - Renames `ComponentProvider` to `PluginComponentProvider`. This makes it clear that only plugins are being provided rather than all components. - Rename `ComponentProvider.createPlugin` to `PluginComponentProvider.createComponent`. There are no functional changes in this PR, just naming updates.
1 parent 75c4c54 commit 55d0572

18 files changed

Lines changed: 102 additions & 102 deletions

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ release.
2929

3030
### SDK Configuration
3131

32+
- Declarative configuration: rename `ComponentProvider` to
33+
`PluginComponentProvider`, `CreatePlugin` to `CreateComponent` in effort to
34+
use consistent vocabulary
35+
([#4806](https://github.com/open-telemetry/opentelemetry-specification/pull/4806))
36+
3237
### Supplementary Guidelines
3338

3439
### OTEPs

spec-compliance-matrix.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,15 +297,15 @@ Disclaimer: Declarative configuration is currently in Development status - work
297297
| The `Parse` operation accepts the configuration YAML file format | + | + | + | | | | + | | + | | |
298298
| The `Parse` operation performs environment variable substitution | + | + | | | | | + | | + | | |
299299
| The `Parse` operation returns configuration model | + | + | + | | | | + | | + | | |
300-
| The `Parse` operation resolves extension component configuration to `properties` | | + | | | | | + | | + | | |
300+
| The `Parse` operation resolves plugin component configuration to `properties` | | + | | | | | + | | + | | |
301301
| `Create` SDK components | + | + | | | | | + | | + | | |
302302
| The `Create` operation accepts configuration model | + | + | | | | | + | | + | | |
303303
| The `Create` operation returns `TracerProvider` | + | + | | | | | + | | + | | |
304304
| The `Create` operation returns `MeterProvider` | + | + | | | | | + | | + | | |
305305
| The `Create` operation returns `LoggerProvider` | + | + | | | | | + | | + | | |
306306
| The `Create` operation returns `Propagators` | | + | | | | | + | | + | | |
307-
| The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components | | + | | | | | + | | + | | |
308-
| Register a `ComponentProvider` | | + | | | | | + | | + | | |
307+
| The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components | | + | | | | | + | | + | | |
308+
| Register a `PluginComponentProvider` | | + | | | | | + | | + | | |
309309

310310
## Exporters
311311

spec-compliance-matrix/cpp.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '+'
510510
- name: The `Parse` operation returns configuration model
511511
status: '+'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '+'
514514
- name: '`Create` SDK components'
515515
status: '+'
@@ -523,9 +523,9 @@ sections:
523523
status: '+'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '+'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '+'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '+'
530530
- name: Exporters
531531
features:

spec-compliance-matrix/dotnet.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '?'
510510
- name: The `Parse` operation returns configuration model
511511
status: '?'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '?'
514514
- name: '`Create` SDK components'
515515
status: '?'
@@ -523,9 +523,9 @@ sections:
523523
status: '?'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '?'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '?'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '?'
530530
- name: Exporters
531531
features:

spec-compliance-matrix/erlang.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '?'
510510
- name: The `Parse` operation returns configuration model
511511
status: '?'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '?'
514514
- name: '`Create` SDK components'
515515
status: '?'
@@ -523,9 +523,9 @@ sections:
523523
status: '?'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '?'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '?'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '?'
530530
- name: Exporters
531531
features:

spec-compliance-matrix/go.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '+'
510510
- name: The `Parse` operation returns configuration model
511511
status: '+'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '?'
514514
- name: '`Create` SDK components'
515515
status: '+'
@@ -523,9 +523,9 @@ sections:
523523
status: '+'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '?'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '?'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '?'
530530
- name: Exporters
531531
features:

spec-compliance-matrix/java.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '+'
510510
- name: The `Parse` operation returns configuration model
511511
status: '+'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '+'
514514
- name: '`Create` SDK components'
515515
status: '+'
@@ -523,9 +523,9 @@ sections:
523523
status: '+'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '+'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '+'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '+'
530530
- name: Exporters
531531
features:

spec-compliance-matrix/js.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '?'
510510
- name: The `Parse` operation returns configuration model
511511
status: '+'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '?'
514514
- name: '`Create` SDK components'
515515
status: '?'
@@ -523,9 +523,9 @@ sections:
523523
status: '?'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '?'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '?'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '?'
530530
- name: Exporters
531531
features:

spec-compliance-matrix/php.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '+'
510510
- name: The `Parse` operation returns configuration model
511511
status: '+'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '+'
514514
- name: '`Create` SDK components'
515515
status: '+'
@@ -523,9 +523,9 @@ sections:
523523
status: '+'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '+'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '+'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '+'
530530
- name: Exporters
531531
features:

spec-compliance-matrix/python.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ sections:
509509
status: '?'
510510
- name: The `Parse` operation returns configuration model
511511
status: '?'
512-
- name: The `Parse` operation resolves extension component configuration to `properties`
512+
- name: The `Parse` operation resolves plugin component configuration to `properties`
513513
status: '?'
514514
- name: '`Create` SDK components'
515515
status: '?'
@@ -523,9 +523,9 @@ sections:
523523
status: '?'
524524
- name: The `Create` operation returns `Propagators`
525525
status: '?'
526-
- name: The `Create` operation calls `CreatePlugin` of corresponding `ComponentProvider` when encountering extension components
526+
- name: The `Create` operation calls `CreateComponent` of corresponding `PluginComponentProvider` when encountering plugin components
527527
status: '?'
528-
- name: Register a `ComponentProvider`
528+
- name: Register a `PluginComponentProvider`
529529
status: '?'
530530
- name: Exporters
531531
features:

0 commit comments

Comments
 (0)