/
processor.go
116 lines (99 loc) · 4.01 KB
/
processor.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package component
import (
"context"
"go.uber.org/zap"
"go.opentelemetry.io/collector/config/configmodels"
"go.opentelemetry.io/collector/consumer"
)
// Processor defines the common functions that must be implemented by TraceProcessor
// and MetricsProcessor.
type Processor interface {
Component
// GetCapabilities must return the capabilities of the processor.
GetCapabilities() ProcessorCapabilities
}
// TraceProcessor is a processor that can consume traces.
type TraceProcessor interface {
Processor
consumer.TraceConsumer
}
// MetricsProcessor is a processor that can consume metrics.
type MetricsProcessor interface {
Processor
consumer.MetricsConsumer
}
// LogsProcessor is a processor that can consume logs.
type LogsProcessor interface {
Processor
consumer.LogsConsumer
}
// ProcessorCapabilities describes the capabilities of a Processor.
type ProcessorCapabilities struct {
// MutatesConsumedData is set to true if Consume* function of the
// processor modifies the input TraceData or MetricsData argument.
// Processors which modify the input data MUST set this flag to true. If the processor
// does not modify the data it MUST set this flag to false. If the processor creates
// a copy of the data before modifying then this flag can be safely set to false.
MutatesConsumedData bool
}
// ProcessorCreateParams is passed to Create* functions in ProcessorFactory.
type ProcessorCreateParams struct {
// Logger that the factory can use during creation and can pass to the created
// component to be used later as well.
Logger *zap.Logger
// ApplicationStartInfo can be used by components for informational purposes
ApplicationStartInfo ApplicationStartInfo
}
// ProcessorFactory is factory interface for processors. This is the
// new factory type that can create new style processors.
type ProcessorFactory interface {
Factory
// CreateDefaultConfig creates the default configuration for the Processor.
// This method can be called multiple times depending on the pipeline
// configuration and should not cause side-effects that prevent the creation
// of multiple instances of the Processor.
// The object returned by this method needs to pass the checks implemented by
// 'configcheck.ValidateConfig'. It is recommended to have such check in the
// tests of any implementation of the Factory interface.
CreateDefaultConfig() configmodels.Processor
// CreateTraceProcessor creates a trace processor based on this config.
// If the processor type does not support tracing or if the config is not valid
// error will be returned instead.
CreateTraceProcessor(
ctx context.Context,
params ProcessorCreateParams,
cfg configmodels.Processor,
nextConsumer consumer.TraceConsumer,
) (TraceProcessor, error)
// CreateMetricsProcessor creates a metrics processor based on this config.
// If the processor type does not support metrics or if the config is not valid
// error will be returned instead.
CreateMetricsProcessor(
ctx context.Context,
params ProcessorCreateParams,
cfg configmodels.Processor,
nextConsumer consumer.MetricsConsumer,
) (MetricsProcessor, error)
// CreateLogsProcessor creates a processor based on the config.
// If the processor type does not support logs or if the config is not valid
// error will be returned instead.
CreateLogsProcessor(
ctx context.Context,
params ProcessorCreateParams,
cfg configmodels.Processor,
nextConsumer consumer.LogsConsumer,
) (LogsProcessor, error)
}