mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
Dmitry AnoshinandGitHub
6ed11d9842
Related to https://github.com/open-telemetry/opentelemetry-collector/issues/14208 This change allows component authors to register one optional deprecated alias per component type, enabling smooth migrations when renaming components. When an alias is used in configuration, the collector will automatically resolve it to the original component and log a deprecation warning. Changes: - Add `WithDeprecatedTypeAlias` factory option to experimental modules (xreceiver, xexporter, xprocessor, xconnector) - Generate alias expansion code in builder template that: - Populates factory maps with aliases pointing to original factories - Updates module information maps for aliased types - Validates that aliases don't conflict with existing component types - Add deprecation warnings that log when an alias is used: "Using deprecated alias <alias>; use <original> instead" Extensions are left aside for now.
192 lines
9.9 KiB
Go
192 lines
9.9 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package xconnector // import "go.opentelemetry.io/collector/connector/xconnector"
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/collector/component"
|
|
"go.opentelemetry.io/collector/connector"
|
|
"go.opentelemetry.io/collector/connector/internal"
|
|
"go.opentelemetry.io/collector/consumer"
|
|
"go.opentelemetry.io/collector/consumer/consumertest"
|
|
"go.opentelemetry.io/collector/consumer/xconsumer"
|
|
"go.opentelemetry.io/collector/internal/componentalias"
|
|
"go.opentelemetry.io/collector/pipeline"
|
|
"go.opentelemetry.io/collector/pipeline/xpipeline"
|
|
)
|
|
|
|
var (
|
|
testType = component.MustNewType("test")
|
|
testID = component.MustNewIDWithName(testType.String(), "name")
|
|
)
|
|
|
|
func TestNewFactoryNoOptions(t *testing.T) {
|
|
defaultCfg := struct{}{}
|
|
factory := NewFactory(testType, func() component.Config { return &defaultCfg })
|
|
assert.Equal(t, testType, factory.Type())
|
|
assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
|
|
|
|
_, err := factory.CreateTracesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, pipeline.SignalTraces, xpipeline.SignalProfiles))
|
|
_, err = factory.CreateMetricsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, pipeline.SignalMetrics, xpipeline.SignalProfiles))
|
|
_, err = factory.CreateLogsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, pipeline.SignalLogs, xpipeline.SignalProfiles))
|
|
|
|
_, err = factory.CreateProfilesToTraces(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, xpipeline.SignalProfiles, pipeline.SignalTraces))
|
|
_, err = factory.CreateProfilesToMetrics(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, xpipeline.SignalProfiles, pipeline.SignalMetrics))
|
|
_, err = factory.CreateProfilesToLogs(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, xpipeline.SignalProfiles, pipeline.SignalLogs))
|
|
}
|
|
|
|
func TestNewFactoryWithSameTypes(t *testing.T) {
|
|
defaultCfg := struct{}{}
|
|
factory := NewFactory(testType, func() component.Config { return &defaultCfg },
|
|
WithProfilesToProfiles(createProfilesToProfiles, component.StabilityLevelAlpha),
|
|
)
|
|
assert.Equal(t, testType, factory.Type())
|
|
assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
|
|
wrongID := component.MustNewID("wrong")
|
|
wrongIDErrStr := internal.ErrIDMismatch(wrongID, testType).Error()
|
|
|
|
assert.Equal(t, component.StabilityLevelAlpha, factory.ProfilesToProfilesStability())
|
|
_, err := factory.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = factory.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: wrongID}, &defaultCfg, consumertest.NewNop())
|
|
require.ErrorContains(t, err, wrongIDErrStr)
|
|
|
|
_, err = factory.CreateProfilesToTraces(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, xpipeline.SignalProfiles, pipeline.SignalTraces))
|
|
_, err = factory.CreateProfilesToMetrics(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, xpipeline.SignalProfiles, pipeline.SignalMetrics))
|
|
_, err = factory.CreateProfilesToLogs(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, xpipeline.SignalProfiles, pipeline.SignalLogs))
|
|
}
|
|
|
|
func TestNewFactoryWithTranslateTypes(t *testing.T) {
|
|
defaultCfg := struct{}{}
|
|
factory := NewFactory(testType, func() component.Config { return &defaultCfg },
|
|
WithTracesToProfiles(createTracesToProfiles, component.StabilityLevelBeta),
|
|
WithMetricsToProfiles(createMetricsToProfiles, component.StabilityLevelDevelopment),
|
|
WithLogsToProfiles(createLogsToProfiles, component.StabilityLevelAlpha),
|
|
|
|
WithProfilesToTraces(createProfilesToTraces, component.StabilityLevelBeta),
|
|
WithProfilesToMetrics(createProfilesToMetrics, component.StabilityLevelDevelopment),
|
|
WithProfilesToLogs(createProfilesToLogs, component.StabilityLevelAlpha),
|
|
)
|
|
assert.Equal(t, testType, factory.Type())
|
|
assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
|
|
wrongID := component.MustNewID("wrong")
|
|
wrongIDErrStr := internal.ErrIDMismatch(wrongID, testType).Error()
|
|
|
|
_, err := factory.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
assert.Equal(t, err, internal.ErrDataTypes(testID, xpipeline.SignalProfiles, xpipeline.SignalProfiles))
|
|
|
|
assert.Equal(t, component.StabilityLevelBeta, factory.TracesToProfilesStability())
|
|
_, err = factory.CreateTracesToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = factory.CreateTracesToProfiles(context.Background(), connector.Settings{ID: wrongID}, &defaultCfg, consumertest.NewNop())
|
|
require.ErrorContains(t, err, wrongIDErrStr)
|
|
|
|
assert.Equal(t, component.StabilityLevelDevelopment, factory.MetricsToProfilesStability())
|
|
_, err = factory.CreateMetricsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = factory.CreateMetricsToProfiles(context.Background(), connector.Settings{ID: wrongID}, &defaultCfg, consumertest.NewNop())
|
|
require.ErrorContains(t, err, wrongIDErrStr)
|
|
|
|
assert.Equal(t, component.StabilityLevelAlpha, factory.LogsToProfilesStability())
|
|
_, err = factory.CreateLogsToProfiles(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = factory.CreateLogsToProfiles(context.Background(), connector.Settings{ID: wrongID}, &defaultCfg, consumertest.NewNop())
|
|
require.ErrorContains(t, err, wrongIDErrStr)
|
|
|
|
assert.Equal(t, component.StabilityLevelBeta, factory.ProfilesToTracesStability())
|
|
_, err = factory.CreateProfilesToTraces(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = factory.CreateProfilesToTraces(context.Background(), connector.Settings{ID: wrongID}, &defaultCfg, consumertest.NewNop())
|
|
require.ErrorContains(t, err, wrongIDErrStr)
|
|
|
|
assert.Equal(t, component.StabilityLevelDevelopment, factory.ProfilesToMetricsStability())
|
|
_, err = factory.CreateProfilesToMetrics(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = factory.CreateProfilesToMetrics(context.Background(), connector.Settings{ID: wrongID}, &defaultCfg, consumertest.NewNop())
|
|
require.ErrorContains(t, err, wrongIDErrStr)
|
|
|
|
assert.Equal(t, component.StabilityLevelAlpha, factory.ProfilesToLogsStability())
|
|
_, err = factory.CreateProfilesToLogs(context.Background(), connector.Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = factory.CreateProfilesToLogs(context.Background(), connector.Settings{ID: wrongID}, &defaultCfg, consumertest.NewNop())
|
|
require.ErrorContains(t, err, wrongIDErrStr)
|
|
}
|
|
|
|
var nopInstance = &nopConnector{
|
|
Consumer: consumertest.NewNop(),
|
|
}
|
|
|
|
// nopConnector stores consumed traces and metrics for testing purposes.
|
|
type nopConnector struct {
|
|
component.StartFunc
|
|
component.ShutdownFunc
|
|
consumertest.Consumer
|
|
}
|
|
|
|
func createTracesToProfiles(context.Context, connector.Settings, component.Config, xconsumer.Profiles) (connector.Traces, error) {
|
|
return nopInstance, nil
|
|
}
|
|
|
|
func createMetricsToProfiles(context.Context, connector.Settings, component.Config, xconsumer.Profiles) (connector.Metrics, error) {
|
|
return nopInstance, nil
|
|
}
|
|
|
|
func createLogsToProfiles(context.Context, connector.Settings, component.Config, xconsumer.Profiles) (connector.Logs, error) {
|
|
return nopInstance, nil
|
|
}
|
|
|
|
func createProfilesToProfiles(context.Context, connector.Settings, component.Config, xconsumer.Profiles) (Profiles, error) {
|
|
return nopInstance, nil
|
|
}
|
|
|
|
func createProfilesToTraces(context.Context, connector.Settings, component.Config, consumer.Traces) (Profiles, error) {
|
|
return nopInstance, nil
|
|
}
|
|
|
|
func createProfilesToMetrics(context.Context, connector.Settings, component.Config, consumer.Metrics) (Profiles, error) {
|
|
return nopInstance, nil
|
|
}
|
|
|
|
func createProfilesToLogs(context.Context, connector.Settings, component.Config, consumer.Logs) (Profiles, error) {
|
|
return nopInstance, nil
|
|
}
|
|
|
|
func TestNewFactoryWithDeprecatedAlias(t *testing.T) {
|
|
testType := component.MustNewType("newname")
|
|
aliasType := component.MustNewType("oldname")
|
|
defaultCfg := struct{}{}
|
|
|
|
f := NewFactory(
|
|
testType,
|
|
func() component.Config { return &defaultCfg },
|
|
WithProfilesToProfiles(createProfilesToProfiles, component.StabilityLevelAlpha),
|
|
WithDeprecatedTypeAlias(aliasType),
|
|
)
|
|
|
|
assert.Equal(t, testType, f.Type())
|
|
assert.Equal(t, aliasType, f.(*factory).Factory.(componentalias.TypeAliasHolder).DeprecatedAlias())
|
|
assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig())
|
|
|
|
_, err := f.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: component.MustNewID("newname")}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = f.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: component.MustNewID("oldname")}, &defaultCfg, consumertest.NewNop())
|
|
require.NoError(t, err)
|
|
_, err = f.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: component.MustNewID("wrongname")}, &defaultCfg, consumertest.NewNop())
|
|
require.Error(t, err)
|
|
}
|