opentelemetry-collector/extension/extensiontest/nop_extension.go

56 lines
1.6 KiB
Go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package extensiontest // import "go.opentelemetry.io/collector/extension/extensiontest"
import (
"context"
"github.com/google/uuid"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/extension"
)
// NopType is the type of the nop extension.
var NopType = component.MustNewType("nop")
// NewNopSettings returns a new nop settings for extension.Factory Create* functions.
// Deprecated: [v0.120.0] Use NewNopSettingsWithType(NopType) instead.
func NewNopSettings() extension.Settings {
return NewNopSettingsWithType(NopType)
}
// NewNopSettings returns a new nop settings for extension.Factory Create* functions with the given type.
func NewNopSettingsWithType(ty component.Type) extension.Settings {
return extension.Settings{
ID: component.NewIDWithName(ty, uuid.NewString()),
TelemetrySettings: componenttest.NewNopTelemetrySettings(),
BuildInfo: component.NewDefaultBuildInfo(),
}
}
// NewNopFactory returns an extension.Factory that constructs nop extensions.
func NewNopFactory() extension.Factory {
return extension.NewFactory(
NopType,
func() component.Config {
return &nopConfig{}
},
func(context.Context, extension.Settings, component.Config) (extension.Extension, error) {
return nopInstance, nil
},
component.StabilityLevelStable)
}
type nopConfig struct{}
var nopInstance = &nopExtension{}
// nopExtension acts as an extension for testing purposes.
type nopExtension struct {
component.StartFunc
component.ShutdownFunc
}