summary refs log tree commit diff
path: root/nixos/modules/services/monitoring/longview.nix
blob: 955b33a5c0c73ab401f90ddfa886f306a2ce61ee (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
{ config, lib, pkgs, ... }:

with lib;

let
  cfg = config.services.longview;

  pidFile = "/run/longview.pid";

  apacheConf = optionalString (cfg.apacheStatusUrl != "") ''
    location ${cfg.apacheStatusUrl}?auto
  '';
  mysqlConf = optionalString (cfg.mysqlUser != "") ''
    username ${cfg.mysqlUser}
    password ${cfg.mysqlPassword}
  '';
  nginxConf = optionalString (cfg.nginxStatusUrl != "") ''
    location ${cfg.nginxStatusUrl}
  '';

in

{
  options = {

    services.longview = {

      enable = mkOption {
        type = types.bool;
        default = false;
        description = ''
          If enabled, system metrics will be sent to Linode LongView.
        '';
      };

      apiKey = mkOption {
        type = types.str;
        example = "01234567-89AB-CDEF-0123456789ABCDEF";
        description = ''
          Longview API key. To get this, look in Longview settings which
          are found at https://manager.linode.com/longview/.
        '';
      };

      apacheStatusUrl = mkOption {
        type = types.str;
        default = "";
        example = "http://127.0.0.1/server-status";
        description = ''
          The Apache status page URL. If provided, Longview will
          gather statistics from this location. This requires Apache
          mod_status to be loaded and enabled.
        '';
      };

      nginxStatusUrl = mkOption {
        type = types.str;
        default = "";
        example = "http://127.0.0.1/nginx_status";
        description = ''
          The Nginx status page URL. Longview will gather statistics
          from this URL. This requires the Nginx stub_status module to
          be enabled and configured at the given location.
        '';
      };

      mysqlUser = mkOption {
        type = types.str;
        default = "";
        description = ''
          The user for connecting to the MySQL database. If provided,
          Longview will connect to MySQL and collect statistics about
          queries, etc.
        '';
      };

      mysqlPassword = mkOption {
        type = types.str;
        description = ''
          The password corresponding to mysqlUser.
        '';
      };
    };

  };

  config = mkIf cfg.enable {
    systemd.services.longview =
      { description = "Longview Metrics Collection";
        after = [ "network.target" ];
        wantedBy = [ "multi-user.target" ];
        serviceConfig.Type = "forking";
        serviceConfig.ExecStop = "-${pkgs.coreutils}/bin/kill -TERM $MAINPID";
        serviceConfig.ExecReload = "-${pkgs.coreutils}/bin/kill -HUP $MAINPID";
        serviceConfig.PIDFile = pidFile;
        serviceConfig.ExecStart = "${pkgs.longview}/bin/longview";
      };

    environment.etc."linode/longview.key" = {
      mode = "0400";
      text = cfg.apiKey;
    };
    environment.etc."linode/longview.d/Apache.conf" = {
      mode = "0400";
      text = apacheConf;
    };
    environment.etc."linode/longview.d/MySQL.conf" = {
      mode = "0400";
      text = mysqlConf;
    };
    environment.etc."linode/longview.d/Nginx.conf" = {
      mode = "0400";
      text = nginxConf;
    };
  };
}