| 1 | // SPDX-License-Identifier: GPL-3.0-or-later |
| 2 | |
| 3 | package openvpn |
| 4 | |
| 5 | import ( |
| 6 | "context" |
| 7 | _ "embed" |
| 8 | "time" |
| 9 | |
| 10 | "github.com/netdata/netdata/go/plugins/pkg/confopt" |
| 11 | "github.com/netdata/netdata/go/plugins/pkg/matcher" |
| 12 | "github.com/netdata/netdata/go/plugins/plugin/framework/collectorapi" |
| 13 | "github.com/netdata/netdata/go/plugins/plugin/go.d/collector/openvpn/client" |
| 14 | "github.com/netdata/netdata/go/plugins/plugin/go.d/pkg/socket" |
| 15 | ) |
| 16 | |
| 17 | //go:embed "config_schema.json" |
| 18 | var configSchema string |
| 19 | |
| 20 | func init() { |
| 21 | collectorapi.Register("openvpn", collectorapi.Creator{ |
| 22 | JobConfigSchema: configSchema, |
| 23 | Create: func() collectorapi.CollectorV1 { return New() }, |
| 24 | Config: func() any { return &Config{} }, |
| 25 | }) |
| 26 | } |
| 27 | |
| 28 | func New() *Collector { |
| 29 | return &Collector{ |
| 30 | Config: Config{ |
| 31 | Address: "127.0.0.1:7505", |
| 32 | Timeout: confopt.Duration(time.Second), |
| 33 | }, |
| 34 | |
| 35 | charts: charts.Copy(), |
| 36 | collectedUsers: make(map[string]bool), |
| 37 | } |
| 38 | } |
| 39 | |
| 40 | type Config struct { |
| 41 | Vnode string `yaml:"vnode,omitempty" json:"vnode"` |
| 42 | UpdateEvery int `yaml:"update_every,omitempty" json:"update_every"` |
| 43 | AutoDetectionRetry int `yaml:"autodetection_retry,omitempty" json:"autodetection_retry"` |
| 44 | Address string `yaml:"address" json:"address"` |
| 45 | Timeout confopt.Duration `yaml:"timeout,omitempty" json:"timeout"` |
| 46 | PerUserStats matcher.SimpleExpr `yaml:"per_user_stats,omitempty" json:"per_user_stats"` |
| 47 | } |
| 48 | |
| 49 | type ( |
| 50 | Collector struct { |
| 51 | collectorapi.Base |
| 52 | Config `yaml:",inline" json:""` |
| 53 | |
| 54 | charts *Charts |
| 55 | |
| 56 | client openVPNClient |
| 57 | |
| 58 | collectedUsers map[string]bool |
| 59 | perUserMatcher matcher.Matcher |
| 60 | } |
| 61 | openVPNClient interface { |
| 62 | socket.Client |
| 63 | Version() (*client.Version, error) |
| 64 | LoadStats() (*client.LoadStats, error) |
| 65 | Users() (client.Users, error) |
| 66 | } |
| 67 | ) |
| 68 | |
| 69 | func (c *Collector) Configuration() any { |
| 70 | return c.Config |
| 71 | } |
| 72 | |
| 73 | func (c *Collector) Init(context.Context) error { |
| 74 | if err := c.validateConfig(); err != nil { |
| 75 | return err |
| 76 | } |
| 77 | |
| 78 | m, err := c.initPerUserMatcher() |
| 79 | if err != nil { |
| 80 | return err |
| 81 | } |
| 82 | c.perUserMatcher = m |
| 83 | |
| 84 | c.client = c.initClient() |
| 85 | |
| 86 | c.Infof("using address: %s, timeout: %s", c.Address, c.Timeout) |
| 87 | |
| 88 | return nil |
| 89 | } |
| 90 | |
| 91 | func (c *Collector) Check(ctx context.Context) error { |
| 92 | if err := c.client.Connect(); err != nil { |
| 93 | return err |
| 94 | } |
| 95 | defer func() { _ = c.client.Disconnect() }() |
| 96 | |
| 97 | ver, err := c.client.Version() |
| 98 | if err != nil { |
| 99 | c.Cleanup(ctx) |
| 100 | return err |
| 101 | } |
| 102 | |
| 103 | c.Infof("connected to OpenVPN v%d.%d.%d, Management v%d", ver.Major, ver.Minor, ver.Patch, ver.Management) |
| 104 | |
| 105 | return nil |
| 106 | } |
| 107 | |
| 108 | func (c *Collector) Charts() *Charts { return c.charts } |
| 109 | |
| 110 | func (c *Collector) Collect(context.Context) map[string]int64 { |
| 111 | mx, err := c.collect() |
| 112 | if err != nil { |
| 113 | c.Error(err) |
| 114 | } |
| 115 | |
| 116 | if len(mx) == 0 { |
| 117 | return nil |
| 118 | } |
| 119 | return mx |
| 120 | } |
| 121 | |
| 122 | func (c *Collector) Cleanup(context.Context) { |
| 123 | if c.client == nil { |
| 124 | return |
| 125 | } |
| 126 | _ = c.client.Disconnect() |
| 127 | } |