125 lines
3.8 KiB
Nix
125 lines
3.8 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
ecfg = config.services.earlyoom;
|
|
in
|
|
{
|
|
options = {
|
|
services.earlyoom = {
|
|
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Enable early out of memory killing.
|
|
'';
|
|
};
|
|
|
|
freeMemThreshold = mkOption {
|
|
type = types.int;
|
|
default = 10;
|
|
description = ''
|
|
Minimum of availabe memory (in percent).
|
|
If the free memory falls below this threshold and the analog is true for
|
|
<option>services.earlyoom.freeSwapThreshold</option>
|
|
the killing begins.
|
|
'';
|
|
};
|
|
|
|
freeSwapThreshold = mkOption {
|
|
type = types.int;
|
|
default = 10;
|
|
description = ''
|
|
Minimum of availabe swap space (in percent).
|
|
If the available swap space falls below this threshold and the analog
|
|
is true for <option>services.earlyoom.freeMemThreshold</option>
|
|
the killing begins.
|
|
'';
|
|
};
|
|
|
|
useKernelOOMKiller= mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Use kernel OOM killer instead of own user-space implementation.
|
|
'';
|
|
};
|
|
|
|
ignoreOOMScoreAdjust = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Ignore oom_score_adjust values of processes.
|
|
User-space implementation only.
|
|
'';
|
|
};
|
|
|
|
enableDebugInfo = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Enable debugging messages.
|
|
'';
|
|
};
|
|
|
|
notificationsCommand = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
description = ''
|
|
This option is deprecated and ignored by earlyoom since 1.6.
|
|
Use <option>services.earlyoom.enableNotifications</option> instead.
|
|
'';
|
|
};
|
|
|
|
enableNotifications = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Send notifications about killed processes via the system d-bus.
|
|
To actually see the notifications in your GUI session, you need to have
|
|
<literal>systembus-notify</literal> running as your user.
|
|
|
|
See <link xlink:href="https://github.com/rfjakob/earlyoom#notifications">README</link> for details.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf ecfg.enable {
|
|
assertions = [
|
|
{ assertion = ecfg.freeMemThreshold > 0 && ecfg.freeMemThreshold <= 100;
|
|
message = "Needs to be a positive percentage"; }
|
|
{ assertion = ecfg.freeSwapThreshold > 0 && ecfg.freeSwapThreshold <= 100;
|
|
message = "Needs to be a positive percentage"; }
|
|
{ assertion = !ecfg.useKernelOOMKiller || !ecfg.ignoreOOMScoreAdjust;
|
|
message = "Both options in conjunction do not make sense"; }
|
|
];
|
|
|
|
warnings = optional (ecfg.notificationsCommand != null)
|
|
"`services.earlyoom.notificationsCommand` is deprecated and ignored by earlyoom since 1.6.";
|
|
|
|
systemd.services.earlyoom = {
|
|
description = "Early OOM Daemon for Linux";
|
|
wantedBy = [ "multi-user.target" ];
|
|
path = optional ecfg.enableNotifications pkgs.dbus;
|
|
serviceConfig = {
|
|
StandardOutput = "null";
|
|
StandardError = "journal";
|
|
ExecStart = ''
|
|
${pkgs.earlyoom}/bin/earlyoom \
|
|
-m ${toString ecfg.freeMemThreshold} \
|
|
-s ${toString ecfg.freeSwapThreshold} \
|
|
${optionalString ecfg.useKernelOOMKiller "-k"} \
|
|
${optionalString ecfg.ignoreOOMScoreAdjust "-i"} \
|
|
${optionalString ecfg.enableDebugInfo "-d"} \
|
|
${optionalString ecfg.enableNotifications "-n"}
|
|
'';
|
|
};
|
|
};
|
|
|
|
environment.systemPackages = optional ecfg.enableNotifications pkgs.systembus-notify;
|
|
};
|
|
}
|