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
| | ;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2018 Sou Bunnbu <iyzsong@member.fsf.org>
;;; Copyright © 2018 Gábor Boskovits <boskovits@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu services monitoring)
#:use-module (gnu services)
#:use-module (gnu services shepherd)
#:use-module (gnu packages admin)
#:use-module (gnu packages monitoring)
#:use-module (gnu system shadow)
#:use-module (guix gexp)
#:use-module (guix records)
#:use-module (ice-9 match)
#:use-module (srfi srfi-1)
#:export (darkstat-configuration
prometheus-node-exporter-configuration
darkstat-service-type
prometheus-node-exporter-service-type
file-system-monitoring-configuration
file-system-monitoring-entry
file-system-monitoring-service-type))
\f
;;;
;;; darkstat
;;;
(define-record-type* <darkstat-configuration>
darkstat-configuration make-darkstat-configuration darkstat-configuration?
(package darkstat-configuration-package
(default darkstat))
(interface darkstat-configuration-interface)
(port darkstat-configuration-port
(default "667"))
(bind-address darkstat-configuration-bind-address
(default "127.0.0.1"))
(base darkstat-configuration-base
(default "/")))
(define %darkstat-accounts
(list (user-account
(name "darkstat")
(group "darkstat")
(system? #t)
(comment "darkstat daemon user")
(home-directory "/var/lib/darkstat")
(shell (file-append shadow "/sbin/nologin")))
(user-group
(name "darkstat")
(system? #t))))
(define darkstat-shepherd-service
(match-lambda
(($ <darkstat-configuration>
package interface port bind-address base)
(shepherd-service
(documentation "Network statistics gatherer.")
(provision '(darkstat))
(requirement '(networking))
(start #~(make-forkexec-constructor
(list #$(file-append package "/sbin/darkstat")
"-i" #$interface
"-p" #$port
"-b" #$bind-address
"--base" #$base
"--syslog" "--no-daemon"
"--chroot" "/var/lib/darkstat"
"--user" "darkstat"
"--import" "darkstat.db"
"--export" "darkstat.db")))
(stop #~(make-kill-destructor))))))
(define darkstat-service-type
(service-type
(name 'darkstat)
(description
"Run @command{darkstat} to serve network traffic statictics reports over
HTTP.")
(extensions
(list (service-extension account-service-type
(const %darkstat-accounts))
(service-extension shepherd-root-service-type
(compose list darkstat-shepherd-service))))))
(define-record-type* <prometheus-node-exporter-configuration>
prometheus-node-exporter-configuration
make-prometheus-node-exporter-configuration
prometheus-node-exporter-configuration?
(package prometheus-node-exporter-configuration-package
(default go-github-com-prometheus-node-exporter))
(web-listen-address prometheus-node-exporter-web-listen-address
(default ":9100")))
(define prometheus-node-exporter-shepherd-service
(match-lambda
(( $ <prometheus-node-exporter-configuration>
package web-listen-address)
(shepherd-service
(documentation "Prometheus node exporter.")
(provision '(prometheus-node-exporter))
(requirement '(networking))
(start #~(make-forkexec-constructor
(list #$(file-append package "/bin/node_exporter")
"--web.listen-address" #$web-listen-address)))
(stop #~(make-kill-destructor))))))
(define prometheus-node-exporter-service-type
(service-type
(name 'prometheus-node-exporter)
(description
"Run @command{node_exporter} to serve hardware and OS metrics to
prometheus.")
(extensions
(list (service-extension
shepherd-root-service-type
(compose list prometheus-node-exporter-shepherd-service))))))
\f
;;;
;;; File System Monitoring
;;;
(define-record-type* <file-system-monitoring-entry>
file-system-monitoring-entry make-file-system-monitoring-entry
file-system-monitoring-entry?
(file-name file-system-monitoring-entry-file-name)
(handler file-system-monitoring-entry-handler))
(define-record-type* <file-system-monitoring-configuration>
file-system-monitoring-configuration
make-file-system-monitoring-configuration
file-system-monitoring-configuration?
(package file-system-monitoring-configuration-package
(default fswatch))
(monitored-files file-system-monitoring-configuration-monitored-files
(default '()))) ; list of <file-system-monitoring-entry>.
(define file-system-monitoring-shepherd-services
(match-lambda
(($ <file-system-monitoring-configuration> package monitored-files)
(list (shepherd-service
(provision '(file-system-monitoring))
(documentation "File System Monitor")
(requirement '(file-systems))
(start #~(let ((handlers
(list #$@(map file-system-monitoring-entry-handler
monitored-files))))
(lambda ()
(sleep 1)
(for-each (lambda (handler)
(handler))
handlers)
(fork+exec-command
`(#$(file-append package "/bin/fswatch")
"--one-event"
"-l" "1" ; latency: 1 s
; "-d"
"--"
#$@(if monitored-files
(map file-system-monitoring-entry-file-name
monitored-files)
'("/does_not_exist")))))))
(stop #~(make-kill-destructor))
(respawn? #t))))))
(define file-system-monitoring-service-type
(service-type (name 'monitor-file-system)
(extensions
(list (service-extension shepherd-root-service-type
file-system-monitoring-shepherd-services)))
(compose concatenate)
(extend (lambda (config monitored-entries)
(let ((monitored-files
(map file-system-monitoring-entry-file-name
monitored-entries))
(handlers
(map file-system-monitoring-entry-handler
monitored-entries)))
(match config
(($ <file-system-monitoring-configuration>
package initial-monitored-files)
(file-system-monitoring-configuration
(package package)
(monitored-files (append initial-monitored-files
monitored-files))))))))
(description
"Call all @dfn{handler}s once something happens with one of
the files monitored, and on overflow. Can have false positives. Will also
call all @dfn{handlers} on startup.")))
|