summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/smartctl/smartctl.go
blob: 777336d95bb38f790c223c2657d998b7a3263c60 (plain)
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
// 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() (*gjson.Result, error)
		scanOpen() (*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() {}