forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 2
/
tcp.go
359 lines (298 loc) · 9.16 KB
/
tcp.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package tcp // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/input/tcp"
import (
"bufio"
"bytes"
"context"
"crypto/rand"
"crypto/tls"
"fmt"
"io"
"net"
"strconv"
"sync"
"time"
"github.com/jpillora/backoff"
"go.opentelemetry.io/collector/config/configtls"
"go.uber.org/zap"
"golang.org/x/text/encoding"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/decoder"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/tokenize"
)
const (
operatorType = "tcp_input"
// minMaxLogSize is the minimal size which can be used for buffering
// TCP input
minMaxLogSize = 64 * 1024
// DefaultMaxLogSize is the max buffer sized used
// if MaxLogSize is not set
DefaultMaxLogSize = 1024 * 1024
)
func init() {
operator.Register(operatorType, func() operator.Builder { return NewConfig() })
}
// NewConfig creates a new TCP input config with default values
func NewConfig() *Config {
return NewConfigWithID(operatorType)
}
// NewConfigWithID creates a new TCP input config with default values
func NewConfigWithID(operatorID string) *Config {
return &Config{
InputConfig: helper.NewInputConfig(operatorID, operatorType),
BaseConfig: BaseConfig{
OneLogPerPacket: false,
Multiline: tokenize.NewMultilineConfig(),
Encoding: "utf-8",
},
}
}
// Config is the configuration of a tcp input operator.
type Config struct {
helper.InputConfig `mapstructure:",squash"`
BaseConfig `mapstructure:",squash"`
}
// BaseConfig is the detailed configuration of a tcp input operator.
type BaseConfig struct {
MaxLogSize helper.ByteSize `mapstructure:"max_log_size,omitempty"`
ListenAddress string `mapstructure:"listen_address,omitempty"`
TLS *configtls.TLSServerSetting `mapstructure:"tls,omitempty"`
AddAttributes bool `mapstructure:"add_attributes,omitempty"`
OneLogPerPacket bool `mapstructure:"one_log_per_packet,omitempty"`
Encoding string `mapstructure:"encoding,omitempty"`
Multiline tokenize.MultilineConfig `mapstructure:"multiline,omitempty"`
PreserveLeadingWhitespaces bool `mapstructure:"preserve_leading_whitespaces,omitempty"`
PreserveTrailingWhitespaces bool `mapstructure:"preserve_trailing_whitespaces,omitempty"`
MultiLineBuilder MultiLineBuilderFunc
}
type MultiLineBuilderFunc func(enc encoding.Encoding) (bufio.SplitFunc, error)
func (c Config) defaultMultilineBuilder(enc encoding.Encoding) (bufio.SplitFunc, error) {
splitFunc, err := c.Multiline.Build(enc, true, c.PreserveLeadingWhitespaces, c.PreserveTrailingWhitespaces, int(c.MaxLogSize))
if err != nil {
return nil, err
}
return splitFunc, nil
}
// Build will build a tcp input operator.
func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error) {
inputOperator, err := c.InputConfig.Build(logger)
if err != nil {
return nil, err
}
// If MaxLogSize not set, set sane default
if c.MaxLogSize == 0 {
c.MaxLogSize = DefaultMaxLogSize
}
if c.MaxLogSize < minMaxLogSize {
return nil, fmt.Errorf("invalid value for parameter 'max_log_size', must be equal to or greater than %d bytes", minMaxLogSize)
}
if c.ListenAddress == "" {
return nil, fmt.Errorf("missing required parameter 'listen_address'")
}
// validate the input address
if _, err = net.ResolveTCPAddr("tcp", c.ListenAddress); err != nil {
return nil, fmt.Errorf("failed to resolve listen_address: %w", err)
}
enc, err := decoder.LookupEncoding(c.Encoding)
if err != nil {
return nil, err
}
if c.MultiLineBuilder == nil {
c.MultiLineBuilder = c.defaultMultilineBuilder
}
// Build multiline
splitFunc, err := c.MultiLineBuilder(enc)
if err != nil {
return nil, err
}
var resolver *helper.IPResolver
if c.AddAttributes {
resolver = helper.NewIPResolver()
}
tcpInput := &Input{
InputOperator: inputOperator,
address: c.ListenAddress,
MaxLogSize: int(c.MaxLogSize),
addAttributes: c.AddAttributes,
OneLogPerPacket: c.OneLogPerPacket,
encoding: enc,
splitFunc: splitFunc,
backoff: backoff.Backoff{
Max: 3 * time.Second,
},
resolver: resolver,
}
if c.TLS != nil {
tcpInput.tls, err = c.TLS.LoadTLSConfig()
if err != nil {
return nil, err
}
}
return tcpInput, nil
}
// Input is an operator that listens for log entries over tcp.
type Input struct {
helper.InputOperator
address string
MaxLogSize int
addAttributes bool
OneLogPerPacket bool
listener net.Listener
cancel context.CancelFunc
wg sync.WaitGroup
tls *tls.Config
backoff backoff.Backoff
encoding encoding.Encoding
splitFunc bufio.SplitFunc
resolver *helper.IPResolver
}
// Start will start listening for log entries over tcp.
func (t *Input) Start(_ operator.Persister) error {
if err := t.configureListener(); err != nil {
return fmt.Errorf("failed to listen on interface: %w", err)
}
ctx, cancel := context.WithCancel(context.Background())
t.cancel = cancel
t.goListen(ctx)
return nil
}
func (t *Input) configureListener() error {
if t.tls == nil {
listener, err := net.Listen("tcp", t.address)
if err != nil {
return fmt.Errorf("failed to configure tcp listener: %w", err)
}
t.listener = listener
return nil
}
t.tls.Time = time.Now
t.tls.Rand = rand.Reader
listener, err := tls.Listen("tcp", t.address, t.tls)
if err != nil {
return fmt.Errorf("failed to configure tls listener: %w", err)
}
t.listener = listener
return nil
}
// goListenn will listen for tcp connections.
func (t *Input) goListen(ctx context.Context) {
t.wg.Add(1)
go func() {
defer t.wg.Done()
for {
conn, err := t.listener.Accept()
if err != nil {
select {
case <-ctx.Done():
return
default:
t.Debugw("Listener accept error", zap.Error(err))
time.Sleep(t.backoff.Duration())
continue
}
}
t.backoff.Reset()
t.Debugf("Received connection: %s", conn.RemoteAddr().String())
subctx, cancel := context.WithCancel(ctx)
t.goHandleClose(subctx, conn)
t.goHandleMessages(subctx, conn, cancel)
}
}()
}
// goHandleClose will wait for the context to finish before closing a connection.
func (t *Input) goHandleClose(ctx context.Context, conn net.Conn) {
t.wg.Add(1)
go func() {
defer t.wg.Done()
<-ctx.Done()
t.Debugf("Closing connection: %s", conn.RemoteAddr().String())
if err := conn.Close(); err != nil {
t.Errorf("Failed to close connection: %s", err)
}
}()
}
// goHandleMessages will handles messages from a tcp connection.
func (t *Input) goHandleMessages(ctx context.Context, conn net.Conn, cancel context.CancelFunc) {
t.wg.Add(1)
go func() {
defer t.wg.Done()
defer cancel()
dec := decoder.New(t.encoding)
if t.OneLogPerPacket {
var buf bytes.Buffer
_, err := io.Copy(&buf, conn)
if err != nil {
t.Errorw("IO copy net connection buffer error", zap.Error(err))
}
log := truncateMaxLog(buf.Bytes(), t.MaxLogSize)
t.handleMessage(ctx, conn, dec, log)
return
}
buf := make([]byte, 0, t.MaxLogSize)
scanner := bufio.NewScanner(conn)
scanner.Buffer(buf, t.MaxLogSize)
scanner.Split(t.splitFunc)
for scanner.Scan() {
t.handleMessage(ctx, conn, dec, scanner.Bytes())
}
if err := scanner.Err(); err != nil {
t.Errorw("Scanner error", zap.Error(err))
}
}()
}
func (t *Input) handleMessage(ctx context.Context, conn net.Conn, dec *decoder.Decoder, log []byte) {
decoded, err := dec.Decode(log)
if err != nil {
t.Errorw("Failed to decode data", zap.Error(err))
return
}
entry, err := t.NewEntry(string(decoded))
if err != nil {
t.Errorw("Failed to create entry", zap.Error(err))
return
}
if t.addAttributes {
entry.AddAttribute("net.transport", "IP.TCP")
if addr, ok := conn.RemoteAddr().(*net.TCPAddr); ok {
ip := addr.IP.String()
entry.AddAttribute("net.peer.ip", ip)
entry.AddAttribute("net.peer.port", strconv.FormatInt(int64(addr.Port), 10))
entry.AddAttribute("net.peer.name", t.resolver.GetHostFromIP(ip))
}
if addr, ok := conn.LocalAddr().(*net.TCPAddr); ok {
ip := addr.IP.String()
entry.AddAttribute("net.host.ip", addr.IP.String())
entry.AddAttribute("net.host.port", strconv.FormatInt(int64(addr.Port), 10))
entry.AddAttribute("net.host.name", t.resolver.GetHostFromIP(ip))
}
}
t.Write(ctx, entry)
}
func truncateMaxLog(data []byte, maxLogSize int) (token []byte) {
if len(data) >= maxLogSize {
return data[:maxLogSize]
}
if len(data) == 0 {
return nil
}
return data
}
// Stop will stop listening for log entries over TCP.
func (t *Input) Stop() error {
if t.cancel == nil {
return nil
}
t.cancel()
if t.listener != nil {
if err := t.listener.Close(); err != nil {
t.Errorf("failed to close TCP connection: %s", err)
}
}
t.wg.Wait()
if t.resolver != nil {
t.resolver.Stop()
}
return nil
}