nixpkgs/nixos/modules/services/monitoring/bosun.nix
h7x4 0a37316d6c
treewide: use mkPackageOption
This commit replaces a lot of usages of `mkOption` with the package
type, to be `mkPackageOption`, in order to reduce the amount of code.
2023-11-27 01:28:36 +01:00

153 lines
3.7 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.bosun;
configFile = pkgs.writeText "bosun.conf" ''
${optionalString (cfg.opentsdbHost !=null) "tsdbHost = ${cfg.opentsdbHost}"}
${optionalString (cfg.influxHost !=null) "influxHost = ${cfg.influxHost}"}
httpListen = ${cfg.listenAddress}
stateFile = ${cfg.stateFile}
ledisDir = ${cfg.ledisDir}
checkFrequency = ${cfg.checkFrequency}
${cfg.extraConfig}
'';
in {
options = {
services.bosun = {
enable = mkEnableOption (lib.mdDoc "bosun");
package = mkPackageOption pkgs "bosun" { };
user = mkOption {
type = types.str;
default = "bosun";
description = lib.mdDoc ''
User account under which bosun runs.
'';
};
group = mkOption {
type = types.str;
default = "bosun";
description = lib.mdDoc ''
Group account under which bosun runs.
'';
};
opentsdbHost = mkOption {
type = types.nullOr types.str;
default = "localhost:4242";
description = lib.mdDoc ''
Host and port of the OpenTSDB database that stores bosun data.
To disable opentsdb you can pass null as parameter.
'';
};
influxHost = mkOption {
type = types.nullOr types.str;
default = null;
example = "localhost:8086";
description = lib.mdDoc ''
Host and port of the influxdb database.
'';
};
listenAddress = mkOption {
type = types.str;
default = ":8070";
description = lib.mdDoc ''
The host address and port that bosun's web interface will listen on.
'';
};
stateFile = mkOption {
type = types.path;
default = "/var/lib/bosun/bosun.state";
description = lib.mdDoc ''
Path to bosun's state file.
'';
};
ledisDir = mkOption {
type = types.path;
default = "/var/lib/bosun/ledis_data";
description = lib.mdDoc ''
Path to bosun's ledis data dir
'';
};
checkFrequency = mkOption {
type = types.str;
default = "5m";
description = lib.mdDoc ''
Bosun's check frequency
'';
};
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
Extra configuration options for Bosun. You should describe your
desired templates, alerts, macros, etc through this configuration
option.
A detailed description of the supported syntax can be found at-spi2-atk
https://bosun.org/configuration.html
'';
};
};
};
config = mkIf cfg.enable {
systemd.services.bosun = {
description = "bosun metrics collector (part of Bosun)";
wantedBy = [ "multi-user.target" ];
preStart = ''
mkdir -p "$(dirname "${cfg.stateFile}")";
touch "${cfg.stateFile}"
touch "${cfg.stateFile}.tmp"
mkdir -p "${cfg.ledisDir}";
if [ "$(id -u)" = 0 ]; then
chown ${cfg.user}:${cfg.group} "${cfg.stateFile}"
chown ${cfg.user}:${cfg.group} "${cfg.stateFile}.tmp"
chown ${cfg.user}:${cfg.group} "${cfg.ledisDir}"
fi
'';
serviceConfig = {
PermissionsStartOnly = true;
User = cfg.user;
Group = cfg.group;
ExecStart = ''
${cfg.package}/bin/bosun -c ${configFile}
'';
};
};
users.users.bosun = {
description = "bosun user";
group = "bosun";
uid = config.ids.uids.bosun;
};
users.groups.bosun.gid = config.ids.gids.bosun;
};
}