-
Notifications
You must be signed in to change notification settings - Fork 5.6k
/
socketstat.go
216 lines (190 loc) · 6.26 KB
/
socketstat.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
//go:generate ../../../tools/readme_config_includer/generator
//go:build !windows
// +build !windows
// iproute2 doesn't exist on Windows
package socketstat
import (
"bufio"
"bytes"
_ "embed"
"fmt"
"os/exec"
"regexp"
"strconv"
"strings"
"time"
"github.com/influxdata/telegraf"
"github.com/influxdata/telegraf/config"
"github.com/influxdata/telegraf/internal"
"github.com/influxdata/telegraf/plugins/inputs"
)
// DO NOT REMOVE THE NEXT TWO LINES! This is required to embed the sampleConfig data.
//go:embed sample.conf
var sampleConfig string
const measurement = "socketstat"
// Socketstat is a telegraf plugin to gather indicators from established connections, using iproute2's `ss` command.
type Socketstat struct {
SocketProto []string `toml:"protocols"`
Timeout config.Duration `toml:"timeout"`
Log telegraf.Logger `toml:"-"`
isNewConnection *regexp.Regexp
validValues *regexp.Regexp
cmdName string
lister socketLister
}
type socketLister func(cmdName string, proto string, timeout config.Duration) (*bytes.Buffer, error)
func (*Socketstat) SampleConfig() string {
return sampleConfig
}
// Gather gathers indicators from established connections
func (ss *Socketstat) Gather(acc telegraf.Accumulator) error {
// best effort : we continue through the protocols even if an error is encountered,
// but we keep track of the last error.
for _, proto := range ss.SocketProto {
out, err := ss.lister(ss.cmdName, proto, ss.Timeout)
if err != nil {
acc.AddError(err)
continue
}
ss.parseAndGather(acc, out, proto)
}
return nil
}
func socketList(cmdName string, proto string, timeout config.Duration) (*bytes.Buffer, error) {
// Run ss for the given protocol, return the output as bytes.Buffer
args := []string{"-in", "--" + proto}
cmd := exec.Command(cmdName, args...)
var out bytes.Buffer
cmd.Stdout = &out
err := internal.RunTimeout(cmd, time.Duration(timeout))
if err != nil {
return &out, fmt.Errorf("error running ss -in --%s: %v", proto, err)
}
return &out, nil
}
func (ss *Socketstat) parseAndGather(acc telegraf.Accumulator, data *bytes.Buffer, proto string) {
scanner := bufio.NewScanner(data)
tags := map[string]string{}
fields := make(map[string]interface{})
// ss output can have blank lines, and/or socket basic info lines and more advanced
// statistics lines, in turns.
// In all non-empty lines, we can have metrics, so we need to group those relevant to
// the same connection.
// To achieve this, we're using the flushData variable which indicates if we should add
// a new measurement or postpone it to a later line.
// The first line is only headers
scanner.Scan()
flushData := false
for scanner.Scan() {
line := scanner.Text()
if line == "" {
continue
}
words := strings.Fields(line)
if ss.isNewConnection.MatchString(line) {
// A line with starting whitespace means metrics about the current connection.
// We should never get 2 consecutive such lines. If we do, log a warning and in
// a best effort, extend the metrics from the 1st line with the metrics of the 2nd
// one, possibly overwriting.
for _, word := range words {
if !ss.validValues.MatchString(word) {
continue
}
// kv will have 2 fields because it matched the regexp
kv := strings.Split(word, ":")
v, err := strconv.ParseUint(kv[1], 10, 64)
if err != nil {
ss.Log.Infof("Couldn't parse metric %q: %v", word, err)
continue
}
fields[kv[0]] = v
}
if !flushData {
ss.Log.Warnf("Found orphaned metrics: %s", words)
ss.Log.Warn("Added them to the last known connection.")
}
acc.AddFields(measurement, fields, tags)
flushData = false
continue
}
// A line with no starting whitespace means we're going to parse a new connection.
// Flush what we gathered about the previous one, if any.
if flushData {
acc.AddFields(measurement, fields, tags)
}
// Delegate the real parsing to getTagsAndState, which manages various
// formats depending on the protocol.
tags, fields = getTagsAndState(proto, words, ss.Log)
// This line containted metrics, so record that.
flushData = true
}
if flushData {
acc.AddFields(measurement, fields, tags)
}
}
func getTagsAndState(proto string, words []string, log telegraf.Logger) (map[string]string, map[string]interface{}) {
tags := map[string]string{
"proto": proto,
}
fields := make(map[string]interface{})
switch proto {
case "udp", "raw":
words = append([]string{"dummy"}, words...)
case "tcp", "dccp", "sctp":
fields["state"] = words[0]
}
switch proto {
case "tcp", "udp", "raw", "dccp", "sctp":
// Local and remote addresses are fields 3 and 4
// Separate addresses and ports with the last ':'
localIndex := strings.LastIndex(words[3], ":")
remoteIndex := strings.LastIndex(words[4], ":")
tags["local_addr"] = words[3][:localIndex]
tags["local_port"] = words[3][localIndex+1:]
tags["remote_addr"] = words[4][:remoteIndex]
tags["remote_port"] = words[4][remoteIndex+1:]
case "unix", "packet":
fields["netid"] = words[0]
tags["local_addr"] = words[4]
tags["local_port"] = words[5]
tags["remote_addr"] = words[6]
tags["remote_port"] = words[7]
}
v, err := strconv.ParseUint(words[1], 10, 64)
if err != nil {
log.Warnf("Couldn't read recv_q in %q: %v", words, err)
} else {
fields["recv_q"] = v
}
v, err = strconv.ParseUint(words[2], 10, 64)
if err != nil {
log.Warnf("Couldn't read send_q in %q: %v", words, err)
} else {
fields["send_q"] = v
}
return tags, fields
}
func (ss *Socketstat) Init() error {
if len(ss.SocketProto) == 0 {
ss.SocketProto = []string{"tcp", "udp"}
}
// Initialize regexps to validate input data
validFields := "(bytes_acked|bytes_received|segs_out|segs_in|data_segs_in|data_segs_out)"
ss.validValues = regexp.MustCompile("^" + validFields + ":[0-9]+$")
ss.isNewConnection = regexp.MustCompile(`^\s+.*$`)
ss.lister = socketList
// Check that ss is installed, get its path.
// Do it last, because in test environments where `ss` might not be available,
// we still want the other Init() actions to be performed.
ssPath, err := exec.LookPath("ss")
if err != nil {
return err
}
ss.cmdName = ssPath
return nil
}
func init() {
inputs.Add("socketstat", func() telegraf.Input {
return &Socketstat{Timeout: config.Duration(time.Second)}
})
}