blob: aef924ef840cce02fd1376639705f62d777a485f (
plain) (
blame)
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
217
218
219
220
|
{ config, lib, pkgs, ... }:
let
inherit (lib) maintainers;
inherit (lib.meta) getExe;
inherit (lib.modules) mkIf;
inherit (lib.options) literalExpression mkEnableOption mkOption mkPackageOption;
inherit (lib.types) bool enum nullOr port str submodule;
cfg = config.services.scrutiny;
# Define the settings format used for this program
settingsFormat = pkgs.formats.yaml { };
in
{
options = {
services.scrutiny = {
enable = mkEnableOption "Scrutiny, a web application for drive monitoring";
package = mkPackageOption pkgs "scrutiny" { };
openFirewall = mkEnableOption "opening the default ports in the firewall for Scrutiny";
influxdb.enable = mkOption {
type = bool;
default = true;
description = ''
Enables InfluxDB on the host system using the `services.influxdb2` NixOS module
with default options.
If you already have InfluxDB configured, or wish to connect to an external InfluxDB
instance, disable this option.
'';
};
settings = mkOption {
description = ''
Scrutiny settings to be rendered into the configuration file.
See https://github.com/AnalogJ/scrutiny/blob/master/example.scrutiny.yaml.
'';
default = { };
type = submodule {
freeformType = settingsFormat.type;
options.web.listen.port = mkOption {
type = port;
default = 8080;
description = "Port for web application to listen on.";
};
options.web.listen.host = mkOption {
type = str;
default = "0.0.0.0";
description = "Interface address for web application to bind to.";
};
options.web.listen.basepath = mkOption {
type = str;
default = "";
example = "/scrutiny";
description = ''
If Scrutiny will be behind a path prefixed reverse proxy, you can override this
value to serve Scrutiny on a subpath.
'';
};
options.log.level = mkOption {
type = enum [ "INFO" "DEBUG" ];
default = "INFO";
description = "Log level for Scrutiny.";
};
options.web.influxdb.scheme = mkOption {
type = str;
default = "http";
description = "URL scheme to use when connecting to InfluxDB.";
};
options.web.influxdb.host = mkOption {
type = str;
default = "0.0.0.0";
description = "IP or hostname of the InfluxDB instance.";
};
options.web.influxdb.port = mkOption {
type = port;
default = 8086;
description = "The port of the InfluxDB instance.";
};
options.web.influxdb.tls.insecure_skip_verify = mkEnableOption "skipping TLS verification when connecting to InfluxDB";
options.web.influxdb.token = mkOption {
type = nullOr str;
default = null;
description = "Authentication token for connecting to InfluxDB.";
};
options.web.influxdb.org = mkOption {
type = nullOr str;
default = null;
description = "InfluxDB organisation under which to store data.";
};
options.web.influxdb.bucket = mkOption {
type = nullOr str;
default = null;
description = "InfluxDB bucket in which to store data.";
};
};
};
collector = {
enable = mkEnableOption "the Scrutiny metrics collector";
package = mkPackageOption pkgs "scrutiny-collector" { };
schedule = mkOption {
type = str;
default = "*:0/15";
description = ''
How often to run the collector in systemd calendar format.
'';
};
settings = mkOption {
description = ''
Collector settings to be rendered into the collector configuration file.
See https://github.com/AnalogJ/scrutiny/blob/master/example.collector.yaml.
'';
default = { };
type = submodule {
freeformType = settingsFormat.type;
options.host.id = mkOption {
type = nullOr str;
default = null;
description = "Host ID for identifying/labelling groups of disks";
};
options.api.endpoint = mkOption {
type = str;
default = "http://localhost:${toString cfg.settings.web.listen.port}";
defaultText = literalExpression ''"http://localhost:''${config.services.scrutiny.settings.web.listen.port}"'';
description = "Scrutiny app API endpoint for sending metrics to.";
};
options.log.level = mkOption {
type = enum [ "INFO" "DEBUG" ];
default = "INFO";
description = "Log level for Scrutiny collector.";
};
};
};
};
};
};
config = mkIf (cfg.enable || cfg.collector.enable) {
services.influxdb2.enable = cfg.influxdb.enable;
networking.firewall = mkIf cfg.openFirewall {
allowedTCPPorts = [ cfg.settings.web.listen.port ];
};
services.smartd = mkIf cfg.collector.enable {
enable = true;
extraOptions = [
"-A /var/log/smartd/"
"--interval=600"
];
};
systemd = {
services = {
scrutiny = mkIf cfg.enable {
description = "Hard Drive S.M.A.R.T Monitoring, Historical Trends & Real World Failure Thresholds";
wantedBy = [ "multi-user.target" ];
after = [ "network.target" ];
environment = {
SCRUTINY_VERSION = "1";
SCRUTINY_WEB_DATABASE_LOCATION = "/var/lib/scrutiny/scrutiny.db";
SCRUTINY_WEB_SRC_FRONTEND_PATH = "${cfg.package}/share/scrutiny";
};
serviceConfig = {
DynamicUser = true;
ExecStart = "${getExe cfg.package} start --config ${settingsFormat.generate "scrutiny.yaml" cfg.settings}";
Restart = "always";
StateDirectory = "scrutiny";
StateDirectoryMode = "0750";
};
};
scrutiny-collector = mkIf cfg.collector.enable {
description = "Scrutiny Collector Service";
environment = {
COLLECTOR_VERSION = "1";
COLLECTOR_API_ENDPOINT = cfg.collector.settings.api.endpoint;
};
serviceConfig = {
Type = "oneshot";
ExecStart = "${getExe cfg.collector.package} run --config ${settingsFormat.generate "scrutiny-collector.yaml" cfg.collector.settings}";
};
};
};
timers = mkIf cfg.collector.enable {
scrutiny-collector = {
timerConfig = {
OnCalendar = cfg.collector.schedule;
Persistent = true;
Unit = "scrutiny-collector.service";
};
};
};
};
};
meta.maintainers = [ maintainers.jnsgruk ];
}
|