summaryrefslogtreecommitdiff
path: root/tw/services/grafana.scm
blob: 4a98ad38900eaaf7c5fd0012bb0076c74792a722 (about) (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
(define-module (tw services grafana)
  #:use-module (gnu)
  #:use-module ((gnu packages admin) #:select (shadow))
  #:use-module ((gnu packages docker) #:select (docker-cli))
  #:use-module (gnu services)
  #:use-module (gnu services configuration)
  #:use-module (gnu services databases)
  #:use-module (gnu services shepherd)
  #:export (grafana-service-type
            grafana-configuration))

;; TODO: Mimir for long-term Prometheus metrics storage?
;; TODO: Store Grafana data in Postgres instead of SQLite?
;; TODO: Back up /var/lib/grafana, especially grafana.db

(define %grafana-user "grafana")
(define %grafana-uid 472)  ; to match container

;; TODO: reverse proxy to make it accessible at http://vin.wg/grafana?
(define-configuration/no-serialization grafana-configuration
  (container (string "docker.io/grafana/grafana-oss:9.5.2") "Container image to run.")
  (bind-address (string "0.0.0.0") "The host IP to bind to.")
  (host-port (integer 3000) "The port to bind to on the host.")
  (data-path (string "/var/lib/grafana") "The path to store data in, on the host."))

(define (grafana-accounts config)
  (list (user-account
         (name %grafana-user)
         (uid %grafana-uid)
         (group "nogroup")
         (comment "Grafana server user")
         (system? #t)
         (home-directory (grafana-configuration-data-path config))
         (shell (file-append shadow "/sbin/nologin")))))

(define (grafana-shepherd-service config)
  (list (shepherd-service
         (provision '(grafana))
         (requirement '(networking wireguard-wg0))
         (documentation "Run a Grafana instance using Docker.")
         (start #~(make-forkexec-constructor
                   ;; https://grafana.com/docs/grafana/latest/setup-grafana/installation/docker/
                   (list #$(file-append docker-cli "/bin/docker") "run" "--rm" "--network=host"
                         "--name" "grafana" "--user" '#$%grafana-user
                         "-v" '#$(format #f "~a:/var/lib/grafana" (grafana-configuration-data-path config))
                         ;; https://grafana.com/docs/grafana/latest/setup-grafana/configure-docker/
                         "-e" "GF_SERVER_PROTOCOL=http"  ; use Wireguard for encryption
                         "-e" '#$(format #f "GF_SERVER_HTTP_ADDR=~a" (grafana-configuration-bind-address config))
                         "-e" '#$(format #f "GF_SERVER_HTTP_PORT=~a" (grafana-configuration-host-port config))
                         "-e" "GF_SERVER_ENABLE_GZIP=true"  ; recommended by docs
                         "-e" "GF_ANALYTICS_REPORTING_ENABLED=false"
                         "-e" "GF_ANALYTICS_CHECK_FOR_UPDATES=false"
                         "-e" "GF_ANALYTICS_CHECK_FOR_PLUGIN_UPDATES=false"
                         "-e" "GF_SNAPSHOTS_ENABLED=false"  ; disable publishing dashboard snapshots to the internet
                         "-e" "GF_DATE_FORMATS_INTERVAL_HOUR=DD.MM. HH:mm"  ; use sensible date format
                         "-e" "GF_DATE_FORMATS_INTERVAL_DAY=DD.MM."         ; use sensible date format
                         ;; TODO: https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#smtp
                         '#$(grafana-configuration-container config))))
         (stop #~(make-kill-destructor)))))

(define grafana-service-type
  (service-type
   (name 'grafana)
   (extensions
    (list (service-extension shepherd-root-service-type grafana-shepherd-service)
          (service-extension account-service-type grafana-accounts)))
   (default-value (grafana-configuration))
   (description "Grafana server, running under Docker.")))