Files
2026-02-05 09:40:43 +10:00

118 lines
3.0 KiB
Nix

{
lib,
pkgs,
config,
utils,
...
}:
let
cfg = config.services.pyroscope;
settingsFormat = pkgs.formats.yaml { };
in
{
meta.maintainers = [ lib.maintainers.kashw2 ];
options.services.pyroscope = {
enable = lib.mkEnableOption "Pyroscope";
package = lib.mkPackageOption pkgs "pyroscope" { };
openFirewall = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Whether or not to open the firewall for this service";
};
settings = lib.mkOption {
type = lib.types.submodule {
freeformType = settingsFormat.type;
options = {
server = {
http_listen_address = lib.mkOption {
type = lib.types.str;
default = "127.0.0.1";
description = "The server listen address";
};
http_listen_port = lib.mkOption {
type = lib.types.port;
default = 4040;
description = "The port that Pyroscope should run on";
};
};
};
};
default = { };
description = ''
Specify the configuration for Pyroscope in Nix.
See <https://grafana.com/docs/pyroscope/latest/configure-server/reference-configuration-parameters/> for available options.
'';
};
configFile = lib.mkOption {
type = lib.types.nullOr lib.types.path;
default = null;
description = "Specify a path to a configuration file that Pyroscope should use.";
};
extraFlags = lib.mkOption {
type = lib.types.listOf lib.types.str;
default = [ ];
description = "Additional arguments to pass to pyroscope";
};
};
config = lib.mkIf cfg.enable {
# Pyroscope and it's CLI
environment.systemPackages = [ cfg.package ];
assertions = [
{
assertion = ((cfg.settings == { }) != (cfg.configFile == null));
message = ''
Please specify a configuration for Pyroscope with either
'services.pyroscope.settings' or
'services.pyroscope.configFile'.
'';
}
];
systemd.services.pyroscope = {
description = "Grafana Pyroscope Service Daemon";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
serviceConfig =
let
conf =
if cfg.configFile == null then
settingsFormat.generate "config.yaml" cfg.settings
else
cfg.configFile;
in
{
ExecStart = utils.escapeSystemdExecArgs (
[
"${lib.getExe cfg.package}"
"--config.file=${conf}"
]
++ cfg.extraFlags
);
DynamicUser = true;
ProtectSystem = "full";
DevicePolicy = "closed";
WorkingDirectory = "/var/lib/pyroscope";
StateDirectory = "pyroscope";
Restart = "on-failure";
};
};
networking.firewall.allowedTCPPorts = lib.mkIf cfg.openFirewall [
cfg.settings.server.http_listen_port
];
};
}