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
|
// SPDX-License-Identifier: GPL-3.0-or-later
package snmp
import (
_ "embed"
"errors"
"fmt"
"strings"
"github.com/netdata/netdata/go/go.d.plugin/agent/module"
"github.com/gosnmp/gosnmp"
)
//go:embed "config_schema.json"
var configSchema string
func init() {
module.Register("snmp", module.Creator{
JobConfigSchema: configSchema,
Defaults: module.Defaults{
UpdateEvery: defaultUpdateEvery,
},
Create: func() module.Module { return New() },
})
}
const (
defaultUpdateEvery = 10
defaultHostname = "127.0.0.1"
defaultCommunity = "public"
defaultVersion = gosnmp.Version2c
defaultPort = 161
defaultRetries = 1
defaultTimeout = defaultUpdateEvery
defaultMaxOIDs = 60
)
func New() *SNMP {
return &SNMP{
Config: Config{
Hostname: defaultHostname,
Community: defaultCommunity,
Options: Options{
Port: defaultPort,
Retries: defaultRetries,
Timeout: defaultUpdateEvery,
Version: defaultVersion.String(),
MaxOIDs: defaultMaxOIDs,
},
User: User{
Name: "",
SecurityLevel: "authPriv",
AuthProto: "sha512",
AuthKey: "",
PrivProto: "aes192c",
PrivKey: "",
},
},
}
}
type (
Config struct {
UpdateEvery int `yaml:"update_every" json:"update_every"`
Hostname string `yaml:"hostname" json:"hostname"`
Community string `yaml:"community" json:"community"`
User User `yaml:"user" json:"user"`
Options Options `yaml:"options" json:"options"`
ChartsInput []ChartConfig `yaml:"charts" json:"charts"`
}
User struct {
Name string `yaml:"name" json:"name"`
SecurityLevel string `yaml:"level" json:"level"`
AuthProto string `yaml:"auth_proto" json:"auth_proto"`
AuthKey string `yaml:"auth_key" json:"auth_key"`
PrivProto string `yaml:"priv_proto" json:"priv_proto"`
PrivKey string `yaml:"priv_key" json:"priv_key"`
}
Options struct {
Port int `yaml:"port" json:"port"`
Retries int `yaml:"retries" json:"retries"`
Timeout int `yaml:"timeout" json:"timeout"`
Version string `yaml:"version" json:"version"`
MaxOIDs int `yaml:"max_request_size" json:"max_request_size"`
}
ChartConfig struct {
ID string `yaml:"id" json:"id"`
Title string `yaml:"title" json:"title"`
Units string `yaml:"units" json:"units"`
Family string `yaml:"family" json:"family"`
Type string `yaml:"type" json:"type"`
Priority int `yaml:"priority" json:"priority"`
IndexRange []int `yaml:"multiply_range" json:"multiply_range"`
Dimensions []DimensionConfig `yaml:"dimensions" json:"dimensions"`
}
DimensionConfig struct {
OID string `yaml:"oid" json:"oid"`
Name string `yaml:"name" json:"name"`
Algorithm string `yaml:"algorithm" json:"algorithm"`
Multiplier int `yaml:"multiplier" json:"multiplier"`
Divisor int `yaml:"divisor" json:"divisor"`
}
)
type SNMP struct {
module.Base
Config `yaml:",inline" json:""`
charts *module.Charts
snmpClient gosnmp.Handler
oids []string
}
func (s *SNMP) Configuration() any {
return s.Config
}
func (s *SNMP) Init() error {
err := s.validateConfig()
if err != nil {
s.Errorf("config validation: %v", err)
return err
}
snmpClient, err := s.initSNMPClient()
if err != nil {
s.Errorf("SNMP client initialization: %v", err)
return err
}
s.Info(snmpClientConnInfo(snmpClient))
err = snmpClient.Connect()
if err != nil {
s.Errorf("SNMP client connect: %v", err)
return err
}
s.snmpClient = snmpClient
charts, err := newCharts(s.ChartsInput)
if err != nil {
s.Errorf("Population of charts failed: %v", err)
return err
}
s.charts = charts
s.oids = s.initOIDs()
return nil
}
func (s *SNMP) Check() error {
mx, err := s.collect()
if err != nil {
s.Error(err)
return err
}
if len(mx) == 0 {
return errors.New("no metrics collected")
}
return nil
}
func (s *SNMP) Charts() *module.Charts {
return s.charts
}
func (s *SNMP) Collect() map[string]int64 {
mx, err := s.collect()
if err != nil {
s.Error(err)
}
if len(mx) == 0 {
return nil
}
return mx
}
func (s *SNMP) Cleanup() {
if s.snmpClient != nil {
_ = s.snmpClient.Close()
}
}
func snmpClientConnInfo(c gosnmp.Handler) string {
var info strings.Builder
info.WriteString(fmt.Sprintf("hostname=%s,port=%d,snmp_version=%s", c.Target(), c.Port(), c.Version()))
switch c.Version() {
case gosnmp.Version1, gosnmp.Version2c:
info.WriteString(fmt.Sprintf(",community=%s", c.Community()))
case gosnmp.Version3:
info.WriteString(fmt.Sprintf(",security_level=%d,%s", c.MsgFlags(), c.SecurityParameters().Description()))
}
return info.String()
}
|
