summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/smartctl/smartctl.go
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/go/plugin/go.d/modules/smartctl/smartctl.go148
1 files changed, 148 insertions, 0 deletions
diff --git a/src/go/plugin/go.d/modules/smartctl/smartctl.go b/src/go/plugin/go.d/modules/smartctl/smartctl.go
new file mode 100644
index 000000000..36f390a37
--- /dev/null
+++ b/src/go/plugin/go.d/modules/smartctl/smartctl.go
@@ -0,0 +1,148 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+package smartctl
+
+import (
+ _ "embed"
+ "errors"
+ "time"
+
+ "github.com/netdata/netdata/go/plugins/plugin/go.d/agent/module"
+ "github.com/netdata/netdata/go/plugins/plugin/go.d/pkg/matcher"
+ "github.com/netdata/netdata/go/plugins/plugin/go.d/pkg/web"
+
+ "github.com/tidwall/gjson"
+)
+
+//go:embed "config_schema.json"
+var configSchema string
+
+func init() {
+ module.Register("smartctl", module.Creator{
+ JobConfigSchema: configSchema,
+ Defaults: module.Defaults{
+ UpdateEvery: 10,
+ },
+ Create: func() module.Module { return New() },
+ Config: func() any { return &Config{} },
+ })
+}
+
+func New() *Smartctl {
+ return &Smartctl{
+ Config: Config{
+ Timeout: web.Duration(time.Second * 5),
+ ScanEvery: web.Duration(time.Minute * 15),
+ PollDevicesEvery: web.Duration(time.Minute * 5),
+ NoCheckPowerMode: "standby",
+ DeviceSelector: "*",
+ },
+ charts: &module.Charts{},
+ forceScan: true,
+ deviceSr: matcher.TRUE(),
+ seenDevices: make(map[string]bool),
+ }
+}
+
+type (
+ Config struct {
+ UpdateEvery int `yaml:"update_every,omitempty" json:"update_every"`
+ Timeout web.Duration `yaml:"timeout,omitempty" json:"timeout"`
+ ScanEvery web.Duration `yaml:"scan_every,omitempty" json:"scan_every"`
+ PollDevicesEvery web.Duration `yaml:"poll_devices_every,omitempty" json:"poll_devices_every"`
+ NoCheckPowerMode string `yaml:"no_check_power_mode,omitempty" json:"no_check_power_mode"`
+ DeviceSelector string `yaml:"device_selector,omitempty" json:"device_selector"`
+ ExtraDevices []ConfigExtraDevice `yaml:"extra_devices,omitempty" json:"extra_devices"`
+ }
+ ConfigExtraDevice struct {
+ Name string `yaml:"name" json:"name"`
+ Type string `yaml:"type" json:"type"`
+ }
+)
+
+type (
+ Smartctl struct {
+ module.Base
+ Config `yaml:",inline" data:""`
+
+ charts *module.Charts
+
+ exec smartctlCli
+
+ deviceSr matcher.Matcher
+
+ lastScanTime time.Time
+ forceScan bool
+ scannedDevices map[string]*scanDevice
+
+ lastDevicePollTime time.Time
+ forceDevicePoll bool
+
+ seenDevices map[string]bool
+ mx map[string]int64
+ }
+ smartctlCli interface {
+ scan(open bool) (*gjson.Result, error)
+ deviceInfo(deviceName, deviceType, powerMode string) (*gjson.Result, error)
+ }
+)
+
+func (s *Smartctl) Configuration() any {
+ return s.Config
+}
+
+func (s *Smartctl) Init() error {
+ if err := s.validateConfig(); err != nil {
+ s.Errorf("config validation error: %s", err)
+ return err
+ }
+
+ sr, err := s.initDeviceSelector()
+ if err != nil {
+ s.Errorf("device selector initialization: %v", err)
+ return err
+ }
+ s.deviceSr = sr
+
+ smartctlExec, err := s.initSmartctlCli()
+ if err != nil {
+ s.Errorf("smartctl exec initialization: %v", err)
+ return err
+ }
+ s.exec = smartctlExec
+
+ return nil
+}
+
+func (s *Smartctl) 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 *Smartctl) Charts() *module.Charts {
+ return s.charts
+}
+
+func (s *Smartctl) Collect() map[string]int64 {
+ mx, err := s.collect()
+ if err != nil {
+ s.Error(err)
+ }
+
+ if len(mx) == 0 {
+ return nil
+ }
+
+ return mx
+}
+
+func (s *Smartctl) Cleanup() {}