Skip to content

Commit

Permalink
[component] Rename "In development" stability level to "Development"
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitryax committed Nov 16, 2022
1 parent 65dfc32 commit d21c7f5
Show file tree
Hide file tree
Showing 14 changed files with 40 additions and 31 deletions.
6 changes: 6 additions & 0 deletions .chloggen/rename-dev-stability-level.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
change_type: deprecation
component: component
note: Deprecate `StabilityLevelInDevelopment` enum const in favor of `StabilityLevelDevelopment`.
issues: [6561]
subtext: |-
Also rename all mentions of "In development" stability level to "Development".
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ we intend to provide high-quality components as part of this repository, we ackn
for prime time. As such, each component should list its current stability level for each telemetry signal, according to
the following definitions:

### In development
### Development

Not all pieces of the component are in place yet and it might not be available as part of any distributions yet. Bugs and performance issues should be reported, but it is likely that the component owners might not give them much attention. Your feedback is still desired, especially when it comes to the user-experience (configuration options, component observability, technical implementation details, ...). Configuration options might break often depending on how things evolve. The component should not be used in production.

Expand Down
13 changes: 8 additions & 5 deletions component/component.go
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,15 @@ const (
StabilityLevelUndefined StabilityLevel = iota // skip 0, start types from 1.
StabilityLevelUnmaintained
StabilityLevelDeprecated
StabilityLevelInDevelopment
StabilityLevelDevelopment
StabilityLevelAlpha
StabilityLevelBeta
StabilityLevelStable
)

// Deprecated: [0.65.0] Use StabilityLevelDevelopment instead.
const StabilityLevelInDevelopment = StabilityLevelDevelopment

func (sl StabilityLevel) String() string {
switch sl {
case StabilityLevelUndefined:
Expand All @@ -130,8 +133,8 @@ func (sl StabilityLevel) String() string {
return "Unmaintained"
case StabilityLevelDeprecated:
return "Deprecated"
case StabilityLevelInDevelopment:
return "In development"
case StabilityLevelDevelopment:
return "development"
case StabilityLevelAlpha:
return "Alpha"
case StabilityLevelBeta:
Expand All @@ -148,8 +151,8 @@ func (sl StabilityLevel) LogMessage() string {
return "Unmaintained component. Actively looking for contributors. Component will become deprecated after 6 months of remaining unmaintained."
case StabilityLevelDeprecated:
return "Deprecated component. Will be removed in future releases."
case StabilityLevelInDevelopment:
return "In development component. May change in the future."
case StabilityLevelDevelopment:
return "Development component. May change in the future."
case StabilityLevelAlpha:
return "Alpha component. May change in the future."
case StabilityLevelBeta:
Expand Down
4 changes: 2 additions & 2 deletions component/exporter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ func TestNewExporterFactory_WithOptions(t *testing.T) {
factory := component.NewExporterFactory(
typeStr,
func() component.ExporterConfig { return &defaultCfg },
component.WithTracesExporter(createTracesExporter, component.StabilityLevelInDevelopment),
component.WithTracesExporter(createTracesExporter, component.StabilityLevelDevelopment),
component.WithMetricsExporter(createMetricsExporter, component.StabilityLevelAlpha),
component.WithLogsExporter(createLogsExporter, component.StabilityLevelDeprecated))
assert.EqualValues(t, typeStr, factory.Type())
assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())

assert.Equal(t, component.StabilityLevelInDevelopment, factory.TracesExporterStability())
assert.Equal(t, component.StabilityLevelDevelopment, factory.TracesExporterStability())
_, err := factory.CreateTracesExporter(context.Background(), component.ExporterCreateSettings{}, &defaultCfg)
assert.NoError(t, err)

Expand Down
4 changes: 2 additions & 2 deletions component/extension_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ func TestNewExtensionFactory(t *testing.T) {
func(ctx context.Context, settings component.ExtensionCreateSettings, extension component.ExtensionConfig) (component.Extension, error) {
return nopExtensionInstance, nil
},
component.StabilityLevelInDevelopment)
component.StabilityLevelDevelopment)
assert.EqualValues(t, typeStr, factory.Type())
assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())

assert.Equal(t, component.StabilityLevelInDevelopment, factory.ExtensionStability())
assert.Equal(t, component.StabilityLevelDevelopment, factory.ExtensionStability())
ext, err := factory.CreateExtension(context.Background(), component.ExtensionCreateSettings{}, &defaultCfg)
assert.NoError(t, err)
assert.Same(t, nopExtensionInstance, ext)
Expand Down
2 changes: 1 addition & 1 deletion docs/scraping-receivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ All the requirements defined for components in [the Collector's README](../READM
applicable to the scraping receivers as well. In addition, the following rules applied specifically to scraping
metrics receivers:

### In development
### Development

The receiver is not ready for use. All the metrics emitted by the receiver are not finalized and can change in any way.

Expand Down
12 changes: 6 additions & 6 deletions exporter/loggingexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Logging Exporter

| Status | |
| ------------------------ | ----------------------- |
| Stability | [In development] |
| Supported pipeline types | traces, metrics, logs |
| Distributions | [core], [contrib] |
| Status | |
| ------------------------ |-----------------------|
| Stability | [Development] |
| Supported pipeline types | traces, metrics, logs |
| Distributions | [core], [contrib] |

Exports data to the console via zap.Logger.

Expand Down Expand Up @@ -43,4 +43,4 @@ exporters:
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
[In development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[Development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
6 changes: 3 additions & 3 deletions exporter/loggingexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ func NewFactory() component.ExporterFactory {
return component.NewExporterFactory(
typeStr,
createDefaultConfig,
component.WithTracesExporter(createTracesExporter, component.StabilityLevelInDevelopment),
component.WithMetricsExporter(createMetricsExporter, component.StabilityLevelInDevelopment),
component.WithLogsExporter(createLogsExporter, component.StabilityLevelInDevelopment),
component.WithTracesExporter(createTracesExporter, component.StabilityLevelDevelopment),
component.WithMetricsExporter(createMetricsExporter, component.StabilityLevelDevelopment),
component.WithLogsExporter(createLogsExporter, component.StabilityLevelDevelopment),
)
}

Expand Down
4 changes: 2 additions & 2 deletions service/extensions/extensions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ func newBadExtensionFactory() component.ExtensionFactory {
func(ctx context.Context, set component.ExtensionCreateSettings, extension component.ExtensionConfig) (component.Extension, error) {
return nil, nil
},
component.StabilityLevelInDevelopment,
component.StabilityLevelDevelopment,
)
}

Expand All @@ -135,6 +135,6 @@ func newCreateErrorExtensionFactory() component.ExtensionFactory {
func(ctx context.Context, set component.ExtensionCreateSettings, extension component.ExtensionConfig) (component.Extension, error) {
return nil, errors.New("cannot create \"err\" extension type")
},
component.StabilityLevelInDevelopment,
component.StabilityLevelDevelopment,
)
}
2 changes: 1 addition & 1 deletion service/internal/components/components.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
)

// LogStabilityLevel logs the stability level of a component. The log level is set to info for
// undefined, unmaintained, deprecated and in development. The log level is set to debug
// undefined, unmaintained, deprecated and development. The log level is set to debug
// for alpha, beta and stable.
func LogStabilityLevel(logger *zap.Logger, sl component.StabilityLevel) {
if sl >= component.StabilityLevelAlpha {
Expand Down
2 changes: 1 addition & 1 deletion service/internal/components/components_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func TestLogStabilityLevel(t *testing.T) {
LogStabilityLevel(logger, component.StabilityLevelUndefined)
LogStabilityLevel(logger, component.StabilityLevelUnmaintained)
LogStabilityLevel(logger, component.StabilityLevelDeprecated)
LogStabilityLevel(logger, component.StabilityLevelInDevelopment)
LogStabilityLevel(logger, component.StabilityLevelDevelopment)
LogStabilityLevel(logger, component.StabilityLevelAlpha)
LogStabilityLevel(logger, component.StabilityLevelBeta)
LogStabilityLevel(logger, component.StabilityLevelStable)
Expand Down
2 changes: 1 addition & 1 deletion service/internal/testcomponents/example_exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (

const (
typeStr = "exampleexporter"
stability = component.StabilityLevelInDevelopment
stability = component.StabilityLevelDevelopment
)

// ExampleExporterConfig config for ExampleExporter.
Expand Down
6 changes: 3 additions & 3 deletions service/internal/testcomponents/example_processor.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ type ExampleProcessorConfig struct {
var ExampleProcessorFactory = component.NewProcessorFactory(
procType,
createDefaultConfig,
component.WithTracesProcessor(createTracesProcessor, component.StabilityLevelInDevelopment),
component.WithMetricsProcessor(createMetricsProcessor, component.StabilityLevelInDevelopment),
component.WithLogsProcessor(createLogsProcessor, component.StabilityLevelInDevelopment))
component.WithTracesProcessor(createTracesProcessor, component.StabilityLevelDevelopment),
component.WithMetricsProcessor(createMetricsProcessor, component.StabilityLevelDevelopment),
component.WithLogsProcessor(createLogsProcessor, component.StabilityLevelDevelopment))

// CreateDefaultConfig creates the default configuration for the Processor.
func createDefaultConfig() component.ProcessorConfig {
Expand Down
6 changes: 3 additions & 3 deletions service/internal/testcomponents/example_receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ type ExampleReceiverConfig struct {
var ExampleReceiverFactory = component.NewReceiverFactory(
receiverType,
createReceiverDefaultConfig,
component.WithTracesReceiver(createTracesReceiver, component.StabilityLevelInDevelopment),
component.WithMetricsReceiver(createMetricsReceiver, component.StabilityLevelInDevelopment),
component.WithLogsReceiver(createLogsReceiver, component.StabilityLevelInDevelopment))
component.WithTracesReceiver(createTracesReceiver, component.StabilityLevelDevelopment),
component.WithMetricsReceiver(createMetricsReceiver, component.StabilityLevelDevelopment),
component.WithLogsReceiver(createLogsReceiver, component.StabilityLevelDevelopment))

func createReceiverDefaultConfig() component.ReceiverConfig {
return &ExampleReceiverConfig{
Expand Down

0 comments on commit d21c7f5

Please sign in to comment.