-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
socket_listener.go
447 lines (378 loc) · 10.8 KB
/
socket_listener.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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
package socket_listener
import (
"bufio"
"crypto/tls"
"fmt"
"io"
"net"
"os"
"strconv"
"strings"
"sync"
"time"
"github.com/influxdata/telegraf"
"github.com/influxdata/telegraf/internal"
tlsint "github.com/influxdata/telegraf/plugins/common/tls"
"github.com/influxdata/telegraf/plugins/inputs"
"github.com/influxdata/telegraf/plugins/parsers"
)
type setReadBufferer interface {
SetReadBuffer(bytes int) error
}
type streamSocketListener struct {
net.Listener
*SocketListener
sockType string
connections map[string]net.Conn
connectionsMtx sync.Mutex
}
func (ssl *streamSocketListener) listen() {
ssl.connections = map[string]net.Conn{}
wg := sync.WaitGroup{}
for {
c, err := ssl.Accept()
if err != nil {
if !strings.HasSuffix(err.Error(), ": use of closed network connection") {
ssl.Log.Error(err.Error())
}
break
}
if ssl.ReadBufferSize.Size > 0 {
if srb, ok := c.(setReadBufferer); ok {
srb.SetReadBuffer(int(ssl.ReadBufferSize.Size))
} else {
ssl.Log.Warnf("Unable to set read buffer on a %s socket", ssl.sockType)
}
}
ssl.connectionsMtx.Lock()
if ssl.MaxConnections > 0 && len(ssl.connections) >= ssl.MaxConnections {
ssl.connectionsMtx.Unlock()
c.Close()
continue
}
ssl.connections[c.RemoteAddr().String()] = c
ssl.connectionsMtx.Unlock()
if err := ssl.setKeepAlive(c); err != nil {
ssl.Log.Errorf("Unable to configure keep alive %q: %s", ssl.ServiceAddress, err.Error())
}
wg.Add(1)
go func() {
defer wg.Done()
ssl.read(c)
}()
}
ssl.connectionsMtx.Lock()
for _, c := range ssl.connections {
c.Close()
}
ssl.connectionsMtx.Unlock()
wg.Wait()
}
func (ssl *streamSocketListener) setKeepAlive(c net.Conn) error {
if ssl.KeepAlivePeriod == nil {
return nil
}
tcpc, ok := c.(*net.TCPConn)
if !ok {
return fmt.Errorf("cannot set keep alive on a %s socket", strings.SplitN(ssl.ServiceAddress, "://", 2)[0])
}
if ssl.KeepAlivePeriod.Duration == 0 {
return tcpc.SetKeepAlive(false)
}
if err := tcpc.SetKeepAlive(true); err != nil {
return err
}
return tcpc.SetKeepAlivePeriod(ssl.KeepAlivePeriod.Duration)
}
func (ssl *streamSocketListener) removeConnection(c net.Conn) {
ssl.connectionsMtx.Lock()
delete(ssl.connections, c.RemoteAddr().String())
ssl.connectionsMtx.Unlock()
}
func (ssl *streamSocketListener) read(c net.Conn) {
defer ssl.removeConnection(c)
defer c.Close()
decoder, err := internal.NewStreamContentDecoder(ssl.ContentEncoding, c)
if err != nil {
ssl.Log.Error("Read error: %v", err)
}
scnr := bufio.NewScanner(decoder)
for {
if ssl.ReadTimeout != nil && ssl.ReadTimeout.Duration > 0 {
c.SetReadDeadline(time.Now().Add(ssl.ReadTimeout.Duration))
}
if !scnr.Scan() {
break
}
body := scnr.Bytes()
metrics, err := ssl.Parse(body)
if err != nil {
ssl.Log.Errorf("Unable to parse incoming line: %s", err.Error())
// TODO rate limit
continue
}
for _, m := range metrics {
ssl.AddMetric(m)
}
}
if err := scnr.Err(); err != nil {
if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
ssl.Log.Debugf("Timeout in plugin: %s", err.Error())
} else if netErr != nil && !strings.HasSuffix(err.Error(), ": use of closed network connection") {
ssl.Log.Error(err.Error())
}
}
}
type packetSocketListener struct {
net.PacketConn
*SocketListener
decoder internal.ContentDecoder
}
func (psl *packetSocketListener) listen() {
buf := make([]byte, 64*1024) // 64kb - maximum size of IP packet
for {
n, _, err := psl.ReadFrom(buf)
if err != nil {
if !strings.HasSuffix(err.Error(), ": use of closed network connection") {
psl.Log.Error(err.Error())
}
break
}
body, err := psl.decoder.Decode(buf[:n])
if err != nil {
psl.Log.Errorf("Unable to decode incoming packet: %s", err.Error())
}
metrics, err := psl.Parse(body)
if err != nil {
psl.Log.Errorf("Unable to parse incoming packet: %s", err.Error())
// TODO rate limit
continue
}
for _, m := range metrics {
psl.AddMetric(m)
}
}
}
type SocketListener struct {
ServiceAddress string `toml:"service_address"`
MaxConnections int `toml:"max_connections"`
ReadBufferSize internal.Size `toml:"read_buffer_size"`
ReadTimeout *internal.Duration `toml:"read_timeout"`
KeepAlivePeriod *internal.Duration `toml:"keep_alive_period"`
SocketMode string `toml:"socket_mode"`
ContentEncoding string `toml:"content_encoding"`
tlsint.ServerConfig
wg sync.WaitGroup
Log telegraf.Logger
parsers.Parser
telegraf.Accumulator
io.Closer
}
func (sl *SocketListener) Description() string {
return "Generic socket listener capable of handling multiple socket types."
}
func (sl *SocketListener) SampleConfig() string {
return `
## URL to listen on
# service_address = "tcp://:8094"
# service_address = "tcp://127.0.0.1:http"
# service_address = "tcp4://:8094"
# service_address = "tcp6://:8094"
# service_address = "tcp6://[2001:db8::1]:8094"
# service_address = "udp://:8094"
# service_address = "udp4://:8094"
# service_address = "udp6://:8094"
# service_address = "unix:///tmp/telegraf.sock"
# service_address = "unixgram:///tmp/telegraf.sock"
## Change the file mode bits on unix sockets. These permissions may not be
## respected by some platforms, to safely restrict write permissions it is best
## to place the socket into a directory that has previously been created
## with the desired permissions.
## ex: socket_mode = "777"
# socket_mode = ""
## Maximum number of concurrent connections.
## Only applies to stream sockets (e.g. TCP).
## 0 (default) is unlimited.
# max_connections = 1024
## Read timeout.
## Only applies to stream sockets (e.g. TCP).
## 0 (default) is unlimited.
# read_timeout = "30s"
## Optional TLS configuration.
## Only applies to stream sockets (e.g. TCP).
# tls_cert = "/etc/telegraf/cert.pem"
# tls_key = "/etc/telegraf/key.pem"
## Enables client authentication if set.
# tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"]
## Maximum socket buffer size (in bytes when no unit specified).
## For stream sockets, once the buffer fills up, the sender will start backing up.
## For datagram sockets, once the buffer fills up, metrics will start dropping.
## Defaults to the OS default.
# read_buffer_size = "64KiB"
## Period between keep alive probes.
## Only applies to TCP sockets.
## 0 disables keep alive probes.
## Defaults to the OS configuration.
# keep_alive_period = "5m"
## Data format to consume.
## Each data format has its own unique set of configuration options, read
## more about them here:
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
# data_format = "influx"
## Content encoding for message payloads, can be set to "gzip" to or
## "identity" to apply no encoding.
# content_encoding = "identity"
`
}
func (sl *SocketListener) Gather(_ telegraf.Accumulator) error {
return nil
}
func (sl *SocketListener) SetParser(parser parsers.Parser) {
sl.Parser = parser
}
func (sl *SocketListener) Start(acc telegraf.Accumulator) error {
sl.Accumulator = acc
spl := strings.SplitN(sl.ServiceAddress, "://", 2)
if len(spl) != 2 {
return fmt.Errorf("invalid service address: %s", sl.ServiceAddress)
}
protocol := spl[0]
addr := spl[1]
if protocol == "unix" || protocol == "unixpacket" || protocol == "unixgram" {
// no good way of testing for "file does not exist".
// Instead just ignore error and blow up when we try to listen, which will
// indicate "address already in use" if file existed and we couldn't remove.
os.Remove(addr)
}
switch protocol {
case "tcp", "tcp4", "tcp6", "unix", "unixpacket":
tlsCfg, err := sl.ServerConfig.TLSConfig()
if err != nil {
return err
}
var l net.Listener
if tlsCfg == nil {
l, err = net.Listen(protocol, addr)
} else {
l, err = tls.Listen(protocol, addr, tlsCfg)
}
if err != nil {
return err
}
sl.Log.Infof("Listening on %s://%s", protocol, l.Addr())
// Set permissions on socket
if (spl[0] == "unix" || spl[0] == "unixpacket") && sl.SocketMode != "" {
// Convert from octal in string to int
i, err := strconv.ParseUint(sl.SocketMode, 8, 32)
if err != nil {
return err
}
os.Chmod(spl[1], os.FileMode(uint32(i)))
}
ssl := &streamSocketListener{
Listener: l,
SocketListener: sl,
sockType: spl[0],
}
sl.Closer = ssl
sl.wg = sync.WaitGroup{}
sl.wg.Add(1)
go func() {
defer sl.wg.Done()
ssl.listen()
}()
case "udp", "udp4", "udp6", "ip", "ip4", "ip6", "unixgram":
decoder, err := internal.NewContentDecoder(sl.ContentEncoding)
if err != nil {
return err
}
pc, err := udpListen(protocol, addr)
if err != nil {
return err
}
// Set permissions on socket
if spl[0] == "unixgram" && sl.SocketMode != "" {
// Convert from octal in string to int
i, err := strconv.ParseUint(sl.SocketMode, 8, 32)
if err != nil {
return err
}
os.Chmod(spl[1], os.FileMode(uint32(i)))
}
if sl.ReadBufferSize.Size > 0 {
if srb, ok := pc.(setReadBufferer); ok {
srb.SetReadBuffer(int(sl.ReadBufferSize.Size))
} else {
sl.Log.Warnf("Unable to set read buffer on a %s socket", protocol)
}
}
sl.Log.Infof("Listening on %s://%s", protocol, pc.LocalAddr())
psl := &packetSocketListener{
PacketConn: pc,
SocketListener: sl,
decoder: decoder,
}
sl.Closer = psl
sl.wg = sync.WaitGroup{}
sl.wg.Add(1)
go func() {
defer sl.wg.Done()
psl.listen()
}()
default:
return fmt.Errorf("unknown protocol '%s' in '%s'", protocol, sl.ServiceAddress)
}
if protocol == "unix" || protocol == "unixpacket" || protocol == "unixgram" {
sl.Closer = unixCloser{path: spl[1], closer: sl.Closer}
}
return nil
}
func udpListen(network string, address string) (net.PacketConn, error) {
switch network {
case "udp", "udp4", "udp6":
var addr *net.UDPAddr
var err error
var ifi *net.Interface
if spl := strings.SplitN(address, "%", 2); len(spl) == 2 {
address = spl[0]
ifi, err = net.InterfaceByName(spl[1])
if err != nil {
return nil, err
}
}
addr, err = net.ResolveUDPAddr(network, address)
if err != nil {
return nil, err
}
if addr.IP.IsMulticast() {
return net.ListenMulticastUDP(network, ifi, addr)
}
return net.ListenUDP(network, addr)
}
return net.ListenPacket(network, address)
}
func (sl *SocketListener) Stop() {
if sl.Closer != nil {
sl.Close()
sl.Closer = nil
}
sl.wg.Wait()
}
func newSocketListener() *SocketListener {
parser, _ := parsers.NewInfluxParser()
return &SocketListener{
Parser: parser,
}
}
type unixCloser struct {
path string
closer io.Closer
}
func (uc unixCloser) Close() error {
err := uc.closer.Close()
os.Remove(uc.path) // ignore error
return err
}
func init() {
inputs.Add("socket_listener", func() telegraf.Input { return newSocketListener() })
}