opentelemetry-collector/receiver/receivertest/nop_receiver.go

96 lines
3.5 KiB
Go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package receivertest // import "go.opentelemetry.io/collector/receiver/receivertest"
import (
"context"
"github.com/google/uuid"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/consumer/consumerprofiles"
"go.opentelemetry.io/collector/internal/globalsignal"
"go.opentelemetry.io/collector/pipeline"
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver/receiverprofiles"
)
var defaultComponentType = component.MustNewType("nop")
// NewNopSettings returns a new nop settings for Create*Receiver functions.
func NewNopSettings() receiver.Settings {
return receiver.Settings{
ID: component.NewIDWithName(defaultComponentType, uuid.NewString()),
TelemetrySettings: componenttest.NewNopTelemetrySettings(),
BuildInfo: component.NewDefaultBuildInfo(),
}
}
// NewNopFactory returns a receiver.Factory that constructs nop receivers supporting all data types.
func NewNopFactory() receiver.Factory {
return receiver.NewFactory(
defaultComponentType,
func() component.Config { return &nopConfig{} },
receiver.WithTraces(createTraces, component.StabilityLevelStable),
receiver.WithMetrics(createMetrics, component.StabilityLevelStable),
receiver.WithLogs(createLogs, component.StabilityLevelStable),
receiverprofiles.WithProfiles(createProfiles, component.StabilityLevelAlpha),
)
}
// NewNopFactoryForType returns a receiver.Factory that constructs nop receivers supporting only the
// given data type.
//
// Deprecated: [v0.110.0] Use NewNopFactoryForTypeWithSignal instead
func NewNopFactoryForType(dataType component.DataType) receiver.Factory {
return NewNopFactoryForTypeWithSignal(globalsignal.MustNewSignal(dataType.String()))
}
// NewNopFactoryForTypeWithSignal returns a receiver.Factory that constructs nop receivers supporting only the
// given signal.
func NewNopFactoryForTypeWithSignal(signal pipeline.Signal) receiver.Factory {
var factoryOpt receiver.FactoryOption
switch signal {
case pipeline.SignalTraces:
factoryOpt = receiver.WithTraces(createTraces, component.StabilityLevelStable)
case pipeline.SignalMetrics:
factoryOpt = receiver.WithMetrics(createMetrics, component.StabilityLevelStable)
case pipeline.SignalLogs:
factoryOpt = receiver.WithLogs(createLogs, component.StabilityLevelStable)
default:
panic("unsupported data type for creating nop receiver factory: " + signal.String())
}
componentType := component.MustNewType(defaultComponentType.String() + "_" + signal.String())
return receiver.NewFactory(componentType, func() component.Config { return &nopConfig{} }, factoryOpt)
}
type nopConfig struct{}
func createTraces(context.Context, receiver.Settings, component.Config, consumer.Traces) (receiver.Traces, error) {
return nopInstance, nil
}
func createMetrics(context.Context, receiver.Settings, component.Config, consumer.Metrics) (receiver.Metrics, error) {
return nopInstance, nil
}
func createLogs(context.Context, receiver.Settings, component.Config, consumer.Logs) (receiver.Logs, error) {
return nopInstance, nil
}
func createProfiles(context.Context, receiver.Settings, component.Config, consumerprofiles.Profiles) (receiverprofiles.Profiles, error) {
return nopInstance, nil
}
var nopInstance = &nopReceiver{}
// nopReceiver acts as a receiver for testing purposes.
type nopReceiver struct {
component.StartFunc
component.ShutdownFunc
}