summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorGábor Boskovits <boskovits@gmail.com>2018-06-18 12:43:42 +0200
committerGábor Boskovits <boskovits@gmail.com>2018-07-09 10:39:06 +0200
commita33652ee336ae9a5d2ab5fd54bf2397caec42a0e (patch)
treeb0a788f9ed97c1169225e75409c5f608b4289e10 /doc
parent80b66eb9494fd6a7df1794e4ce7acd5f7d319c8b (diff)
downloadguix-a33652ee336ae9a5d2ab5fd54bf2397caec42a0e.tar.gz
services: Add prometheus-node-exporter-service-type.
* gnu/services/monitoring.scm (prometheus-node-exporter-service-type):
New variable.
(<prometheus-node-exporter-configuration>): New record type.
(prometheus-node-exporter-shepherd-service): New procedure.
* gnu/doc/guix.texi (Monitoring Services): Document it.
* gnu/tests/monitoring.scm: New file.
* gnu/local.mk (GNU_SYSTEM_MODULES): Add test module.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi36
1 files changed, 35 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index a458c7c8dd..3f0eedd0d9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -48,7 +48,8 @@ Copyright @copyright{} 2017 nee@*
 Copyright @copyright{} 2018 Rutger Helling@*
 Copyright @copyright{} 2018 Oleg Pykhalov@*
 Copyright @copyright{} 2018 Mike Gerwitz@*
-Copyright @copyright{} 2018 Pierre-Antoine Rouby
+Copyright @copyright{} 2018 Pierre-Antoine Rouby@*
+Copyright @copyright{} 2018 Gábor Boskovits@*
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -15649,6 +15650,39 @@ Specify the path of the base URL.  This can be useful if
 @end table
 @end deftp
 
+@subsubheading Prometheus Node Exporter Service
+
+@cindex prometheus-node-exporter
+The Prometheus ``node exporter'' makes hardware and operating system statistics
+provided by the Linux kernel available for the Prometheus monitoring system. 
+This service should be deployed on all physical nodes and virtual machines,
+where monitoring these statistics is desirable. 
+
+@defvr {Scheme variable} prometheus-node-exporter-service-type
+This is the service type for the
+@uref{https://github.com/prometheus/node_exporter/, prometheus-node-exporter}
+service, its value must be a @code{prometheus-node-exporter-configuration}
+record as in this example:
+
+@example
+(service prometheus-node-exporter-service-type
+         (prometheus-node-exporter-configuration
+           (web-listen-address ":9100")))
+@end example
+@end defvar
+
+@deftp {Data Type} prometheus-node-exporter-configuration
+Data type representing the configuration of @command{node_exporter}.
+
+@table @asis
+@item @code{package} (default: @code{go-github-com-prometheus-node-exporter})
+The prometheus-node-exporter package to use.
+
+@item @code{web-listen-address} (default: @code{":9100"})
+Bind the web interface to the specified address.
+
+@end table
+@end deftp
 
 @node Kerberos Services
 @subsubsection Kerberos Services