-
Notifications
You must be signed in to change notification settings - Fork 782
/
metadata.go
281 lines (248 loc) · 7.39 KB
/
metadata.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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
package condition
import (
"errors"
"fmt"
"regexp"
"strconv"
"strings"
"github.com/Jeffail/benthos/v3/internal/docs"
"github.com/Jeffail/benthos/v3/lib/log"
"github.com/Jeffail/benthos/v3/lib/metrics"
"github.com/Jeffail/benthos/v3/lib/types"
radix "github.com/armon/go-radix"
"github.com/spf13/cast"
)
//------------------------------------------------------------------------------
func init() {
Constructors[TypeMetadata] = TypeSpec{
constructor: NewMetadata,
Status: docs.StatusDeprecated,
Footnotes: `
## Alternatives
Consider using the [bloblang](/docs/components/conditions/bloblang) condition
instead as it offers a wide range of metadata processing options. For example,
the following condition:
` + "``` yaml" + `
metadata:
operator: enum
key: foo
arg:
- bar
- baz
- qux
- quux
` + "```" + `
Can instead be expressed with:
` + "``` yaml" + `
bloblang: '["bar","baz","qux","quux"].contains(meta("foo"))'
` + "```" + ``,
FieldSpecs: docs.FieldSpecs{
docs.FieldCommon("operator", "An [operator](#operators) to apply."),
docs.FieldCommon("key", "The key of the metadata field to check."),
docs.FieldCommon("arg", "An argument to check against. For some operators this field not be required."),
partFieldSpec,
},
}
}
//------------------------------------------------------------------------------
// Errors for the metadata condition.
var (
ErrInvalidMetadataOperator = errors.New("invalid metadata operator type")
)
// MetadataConfig is a configuration struct containing fields for the metadata
// condition.
type MetadataConfig struct {
Operator string `json:"operator" yaml:"operator"`
Part int `json:"part" yaml:"part"`
Key string `json:"key" yaml:"key"`
Arg interface{} `json:"arg" yaml:"arg"`
}
// NewMetadataConfig returns a MetadataConfig with default values.
func NewMetadataConfig() MetadataConfig {
return MetadataConfig{
Operator: "equals_cs",
Part: 0,
Key: "",
Arg: "",
}
}
//------------------------------------------------------------------------------
type metadataOperator func(md types.Metadata) bool
func metadataEnumOperator(key string, arg interface{}) (metadataOperator, error) {
entries, err := cast.ToStringSliceE(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as string slice: %v", err)
}
tree := radix.New()
for _, entry := range entries {
tree.Insert(entry, struct{}{})
}
return func(md types.Metadata) bool {
_, ok := tree.Get(md.Get(key))
return ok
}, nil
}
func metadataEqualsCSOperator(key string, arg interface{}) (metadataOperator, error) {
argStr, err := cast.ToStringE(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as string: %v", err)
}
return func(md types.Metadata) bool {
return md.Get(key) == argStr
}, nil
}
func metadataEqualsOperator(key string, arg interface{}) (metadataOperator, error) {
argStr, err := cast.ToStringE(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as string: %v", err)
}
return func(md types.Metadata) bool {
return strings.EqualFold(md.Get(key), argStr)
}, nil
}
func metadataExistsOperator(key string) metadataOperator {
return func(md types.Metadata) bool {
return len(md.Get(key)) > 0
}
}
func metadataGreaterThanOperator(key string, arg interface{}) (metadataOperator, error) {
v, err := cast.ToFloat64E(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as float64: %v", err)
}
return func(md types.Metadata) bool {
val, verr := strconv.ParseFloat(md.Get(key), 64)
if verr != nil {
return false
}
return val > v
}, nil
}
func metadataHasPrefixOperator(key string, arg interface{}) (metadataOperator, error) {
if prefix, ok := arg.(string); ok {
return func(md types.Metadata) bool {
return strings.HasPrefix(md.Get(key), prefix)
}, nil
}
entries, err := cast.ToStringSliceE(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as string or string slice: %v", err)
}
tree := radix.New()
for _, entry := range entries {
tree.Insert(entry, struct{}{})
}
return func(md types.Metadata) bool {
_, _, ok := tree.LongestPrefix(md.Get(key))
return ok
}, nil
}
func metadataLessThanOperator(key string, arg interface{}) (metadataOperator, error) {
v, err := cast.ToFloat64E(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as float64: %v", err)
}
return func(md types.Metadata) bool {
val, verr := strconv.ParseFloat(md.Get(key), 64)
if verr != nil {
return false
}
return val < v
}, nil
}
func metadataRegexpPartialOperator(key string, arg interface{}) (metadataOperator, error) {
argStr, err := cast.ToStringE(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as string: %v", err)
}
compiled, err := regexp.Compile(argStr)
if err != nil {
return nil, err
}
return func(md types.Metadata) bool {
return compiled.MatchString(md.Get(key))
}, nil
}
func metadataRegexpExactOperator(key string, arg interface{}) (metadataOperator, error) {
argStr, err := cast.ToStringE(arg)
if err != nil {
return nil, fmt.Errorf("failed to parse argument as string: %v", err)
}
compiled, err := regexp.Compile(argStr)
if err != nil {
return nil, err
}
return func(md types.Metadata) bool {
val := md.Get(key)
return len(compiled.FindString(val)) == len(val)
}, nil
}
func strToMetadataOperator(str, key string, arg interface{}) (metadataOperator, error) {
switch str {
case "enum":
return metadataEnumOperator(key, arg)
case "equals":
return metadataEqualsOperator(key, arg)
case "equals_cs":
return metadataEqualsCSOperator(key, arg)
case "exists":
return metadataExistsOperator(key), nil
case "greater_than":
return metadataGreaterThanOperator(key, arg)
case "has_prefix":
return metadataHasPrefixOperator(key, arg)
case "less_than":
return metadataLessThanOperator(key, arg)
case "regexp_partial":
return metadataRegexpPartialOperator(key, arg)
case "regexp_exact":
return metadataRegexpExactOperator(key, arg)
}
return nil, ErrInvalidMetadataOperator
}
//------------------------------------------------------------------------------
// Metadata is a condition that checks message text against logical operators.
type Metadata struct {
stats metrics.Type
operator metadataOperator
part int
mCount metrics.StatCounter
mTrue metrics.StatCounter
mFalse metrics.StatCounter
}
// NewMetadata returns a Metadata condition.
func NewMetadata(
conf Config, mgr types.Manager, log log.Modular, stats metrics.Type,
) (Type, error) {
op, err := strToMetadataOperator(conf.Metadata.Operator, conf.Metadata.Key, conf.Metadata.Arg)
if err != nil {
return nil, fmt.Errorf("operator '%v': %v", conf.Metadata.Operator, err)
}
return &Metadata{
stats: stats,
operator: op,
part: conf.Metadata.Part,
mCount: stats.GetCounter("count"),
mTrue: stats.GetCounter("true"),
mFalse: stats.GetCounter("false"),
}, nil
}
//------------------------------------------------------------------------------
// Check attempts to check a message part against a configured condition.
func (c *Metadata) Check(msg types.Message) bool {
c.mCount.Incr(1)
index := c.part
lParts := msg.Len()
if lParts == 0 {
c.mFalse.Incr(1)
return false
}
res := c.operator(msg.Get(index).Metadata())
if res {
c.mTrue.Incr(1)
} else {
c.mFalse.Incr(1)
}
return res
}
//------------------------------------------------------------------------------