|
| 1 | +// Copyright The OpenTelemetry Authors |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package builders // import "go.opentelemetry.io/collector/service/internal/builders" |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "errors" |
| 9 | + "fmt" |
| 10 | + |
| 11 | + "go.uber.org/zap" |
| 12 | + |
| 13 | + "go.opentelemetry.io/collector/component" |
| 14 | + "go.opentelemetry.io/collector/consumer" |
| 15 | + "go.opentelemetry.io/collector/receiver" |
| 16 | + "go.opentelemetry.io/collector/receiver/receivertest" |
| 17 | +) |
| 18 | + |
| 19 | +var ( |
| 20 | + errNilNextConsumer = errors.New("nil next Consumer") |
| 21 | + nopType = component.MustNewType("nop") |
| 22 | +) |
| 23 | + |
| 24 | +// Receiver is an interface that allows using implementations of the builder |
| 25 | +// from different packages. |
| 26 | +type Receiver interface { |
| 27 | + CreateTraces(context.Context, receiver.Settings, consumer.Traces) (receiver.Traces, error) |
| 28 | + CreateMetrics(context.Context, receiver.Settings, consumer.Metrics) (receiver.Metrics, error) |
| 29 | + CreateLogs(context.Context, receiver.Settings, consumer.Logs) (receiver.Logs, error) |
| 30 | + Factory(component.Type) component.Factory |
| 31 | +} |
| 32 | + |
| 33 | +// ReceiverBuilder receiver is a helper struct that given a set of Configs and |
| 34 | +// Factories helps with creating receivers. |
| 35 | +type ReceiverBuilder struct { |
| 36 | + cfgs map[component.ID]component.Config |
| 37 | + factories map[component.Type]receiver.Factory |
| 38 | +} |
| 39 | + |
| 40 | +// NewReceiver creates a new ReceiverBuilder to help with creating |
| 41 | +// components form a set of configs and factories. |
| 42 | +func NewReceiver(cfgs map[component.ID]component.Config, factories map[component.Type]receiver.Factory) *ReceiverBuilder { |
| 43 | + return &ReceiverBuilder{cfgs: cfgs, factories: factories} |
| 44 | +} |
| 45 | + |
| 46 | +// CreateTraces creates a Traces receiver based on the settings and config. |
| 47 | +func (b *ReceiverBuilder) CreateTraces(ctx context.Context, set receiver.Settings, next consumer.Traces) (receiver.Traces, error) { |
| 48 | + if next == nil { |
| 49 | + return nil, errNilNextConsumer |
| 50 | + } |
| 51 | + cfg, existsCfg := b.cfgs[set.ID] |
| 52 | + if !existsCfg { |
| 53 | + return nil, fmt.Errorf("receiver %q is not configured", set.ID) |
| 54 | + } |
| 55 | + |
| 56 | + f, existsFactory := b.factories[set.ID.Type()] |
| 57 | + if !existsFactory { |
| 58 | + return nil, fmt.Errorf("receiver factory not available for: %q", set.ID) |
| 59 | + } |
| 60 | + |
| 61 | + logStabilityLevel(set.Logger, f.TracesReceiverStability()) |
| 62 | + return f.CreateTracesReceiver(ctx, set, cfg, next) |
| 63 | +} |
| 64 | + |
| 65 | +// CreateMetrics creates a Metrics receiver based on the settings and config. |
| 66 | +func (b *ReceiverBuilder) CreateMetrics(ctx context.Context, set receiver.Settings, next consumer.Metrics) (receiver.Metrics, error) { |
| 67 | + if next == nil { |
| 68 | + return nil, errNilNextConsumer |
| 69 | + } |
| 70 | + cfg, existsCfg := b.cfgs[set.ID] |
| 71 | + if !existsCfg { |
| 72 | + return nil, fmt.Errorf("receiver %q is not configured", set.ID) |
| 73 | + } |
| 74 | + |
| 75 | + f, existsFactory := b.factories[set.ID.Type()] |
| 76 | + if !existsFactory { |
| 77 | + return nil, fmt.Errorf("receiver factory not available for: %q", set.ID) |
| 78 | + } |
| 79 | + |
| 80 | + logStabilityLevel(set.Logger, f.MetricsReceiverStability()) |
| 81 | + return f.CreateMetricsReceiver(ctx, set, cfg, next) |
| 82 | +} |
| 83 | + |
| 84 | +// CreateLogs creates a Logs receiver based on the settings and config. |
| 85 | +func (b *ReceiverBuilder) CreateLogs(ctx context.Context, set receiver.Settings, next consumer.Logs) (receiver.Logs, error) { |
| 86 | + if next == nil { |
| 87 | + return nil, errNilNextConsumer |
| 88 | + } |
| 89 | + cfg, existsCfg := b.cfgs[set.ID] |
| 90 | + if !existsCfg { |
| 91 | + return nil, fmt.Errorf("receiver %q is not configured", set.ID) |
| 92 | + } |
| 93 | + |
| 94 | + f, existsFactory := b.factories[set.ID.Type()] |
| 95 | + if !existsFactory { |
| 96 | + return nil, fmt.Errorf("receiver factory not available for: %q", set.ID) |
| 97 | + } |
| 98 | + |
| 99 | + logStabilityLevel(set.Logger, f.LogsReceiverStability()) |
| 100 | + return f.CreateLogsReceiver(ctx, set, cfg, next) |
| 101 | +} |
| 102 | + |
| 103 | +func (b *ReceiverBuilder) Factory(componentType component.Type) component.Factory { |
| 104 | + return b.factories[componentType] |
| 105 | +} |
| 106 | + |
| 107 | +// logStabilityLevel logs the stability level of a component. The log level is set to info for |
| 108 | +// undefined, unmaintained, deprecated and development. The log level is set to debug |
| 109 | +// for alpha, beta and stable. |
| 110 | +func logStabilityLevel(logger *zap.Logger, sl component.StabilityLevel) { |
| 111 | + if sl >= component.StabilityLevelAlpha { |
| 112 | + logger.Debug(sl.LogMessage()) |
| 113 | + } else { |
| 114 | + logger.Info(sl.LogMessage()) |
| 115 | + } |
| 116 | +} |
| 117 | + |
| 118 | +// NewNopReceiverConfigsAndFactories returns a configuration and factories that allows building a new nop receiver. |
| 119 | +func NewNopReceiverConfigsAndFactories() (map[component.ID]component.Config, map[component.Type]receiver.Factory) { |
| 120 | + nopFactory := receivertest.NewNopFactory() |
| 121 | + configs := map[component.ID]component.Config{ |
| 122 | + component.NewID(nopType): nopFactory.CreateDefaultConfig(), |
| 123 | + } |
| 124 | + factories := map[component.Type]receiver.Factory{ |
| 125 | + nopType: nopFactory, |
| 126 | + } |
| 127 | + |
| 128 | + return configs, factories |
| 129 | +} |
0 commit comments