logrotate: update to freeform #162063
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,10 @@ with lib; | |
| let | ||
| cfg = config.services.logrotate; | ||
|
|
||
| # deprecated legacy compat settings | ||
| # these options will be removed before 22.11 in the following PR: | ||
| # https://github.com/NixOS/nixpkgs/pull/164169 | ||
| pathOpts = { name, ... }: { | ||
| options = { | ||
| enable = mkOption { | ||
| type = types.bool; | ||
|
|
@@ -86,23 +89,113 @@ let | |
| config.name = name; | ||
| }; | ||
|
|
||
| generateLine = n: v: | ||
| if builtins.elem n [ "files" "priority" "enable" "global" ] || v == null then null | ||
| else if builtins.elem n [ "extraConfig" "frequency" ] then "${v}\n" | ||
| else if builtins.elem n [ "firstaction" "lastaction" "prerotate" "postrotate" "preremove" ] | ||
| then "${n}\n ${v}\n endscript\n" | ||
| else if isInt v then "${n} ${toString v}\n" | ||
| else if v == true then "${n}\n" | ||
| else if v == false then "no${n}\n" | ||
| else "${n} ${v}\n"; | ||
| generateSection = indent: settings: concatStringsSep (fixedWidthString indent " " "") ( | ||
| filter (x: x != null) (mapAttrsToList generateLine settings) | ||
| ); | ||
|
|
||
| # generateSection includes a final newline hence weird closing brace | ||
| mkConf = settings: | ||
| if settings.global or false then generateSection 0 settings | ||
| else '' | ||
| ${concatMapStringsSep "\n" (files: ''"${files}"'') (toList settings.files)} { | ||
| ${generateSection 2 settings}} | ||
| ''; | ||
|
|
||
| # below two mapPaths are compat functions | ||
| mapPathOptToSetting = n: v: | ||
| if n == "keep" then nameValuePair "rotate" v | ||
| else if n == "path" then nameValuePair "files" v | ||
| else nameValuePair n v; | ||
|
|
||
| mapPathsToSettings = path: pathOpts: | ||
| nameValuePair path ( | ||
| filterAttrs (n: v: ! builtins.elem n [ "user" "group" "name" ] && v != "") ( | ||
| (mapAttrs' mapPathOptToSetting pathOpts) // | ||
| { | ||
| su = | ||
| if pathOpts.user != null | ||
| then "${pathOpts.user} ${pathOpts.group}" | ||
| else null; | ||
| } | ||
| ) | ||
| ); | ||
|
|
||
| settings = sortProperties (attrValues (filterAttrs (_: settings: settings.enable) ( | ||
| foldAttrs recursiveUpdate { } [ | ||
| { | ||
| header = { | ||
| enable = true; | ||
| missingok = true; | ||
| notifempty = true; | ||
| frequency = "weekly"; | ||
| rotate = 4; | ||
| }; | ||
| # compat section | ||
| extraConfig = { | ||
| enable = (cfg.extraConfig != ""); | ||
| global = true; | ||
| extraConfig = cfg.extraConfig; | ||
| priority = 101; | ||
| }; | ||
| } | ||
| (mapAttrs' mapPathsToSettings cfg.paths) | ||
| cfg.settings | ||
| { header = { global = true; priority = 100; }; } | ||
| ] | ||
| ))); | ||
| configFile = pkgs.writeTextFile { | ||
| name = "logrotate.conf"; | ||
| text = concatStringsSep "\n" ( | ||
| map mkConf settings | ||
| ); | ||
| checkPhase = optionalString cfg.checkConfig '' | ||
| # logrotate --debug also checks that users specified in config | ||
| # file exist, but we only have sandboxed users here so brown these | ||
| # out. according to man page that means su, create and createolddir. | ||
| # files required to exist also won't be present, so missingok is forced. | ||
| user=$(${pkgs.coreutils}/bin/id -un) | ||
| group=$(${pkgs.coreutils}/bin/id -gn) | ||
| sed -e "s/\bsu\s.*/su $user $group/" \ | ||
| -e "s/\b\(create\s\+[0-9]*\s*\|createolddir\s\+[0-9]*\s\+\).*/\1$user $group/" \ | ||
| -e "1imissingok" -e "s/\bnomissingok\b//" \ | ||
| $out > /tmp/logrotate.conf | ||
| # Since this makes for very verbose builds only show real error. | ||
| # There is no way to control log level, but logrotate hardcodes | ||
| # 'error:' at common log level, so we can use grep, taking care | ||
| # to keep error codes | ||
| set -o pipefail | ||
| if ! ${pkgs.logrotate}/sbin/logrotate --debug /tmp/logrotate.conf 2>&1 \ | ||
| | ( ! grep "error:" ) > /tmp/logrotate-error; then | ||
| echo "Logrotate configuration check failed." | ||
| echo "The failing configuration (after adjustments to pass tests in sandbox) was:" | ||
| printf "%s\n" "-------" | ||
| cat /tmp/logrotate.conf | ||
| printf "%s\n" "-------" | ||
| echo "The error reported by logrotate was as follow:" | ||
| printf "%s\n" "-------" | ||
| cat /tmp/logrotate-error | ||
| printf "%s\n" "-------" | ||
| echo "You can disable this check with services.logrotate.checkConfig = false," | ||
| echo "but if you think it should work please report this failure along with" | ||
| echo "the config file being tested!" | ||
| false | ||
| fi | ||
| ''; | ||
| }; | ||
|
|
||
| mailOption = | ||
| if foldr (n: a: a || n ? mail) false (attrValues cfg.settings) | ||
| then "--mail=${pkgs.mailutils}/bin/mail" | ||
|
Member
There was a problem hiding this comment. Again, sorry for the late comment, but shouldn't this be something like: if /* ... */
then "\"--mail=${pkgs.mailutils}/bin/mail -s\""
else ""i.e., shouldn't the The
Please note that I haven't actually tested sending mail, though (neither with nor without the
Member
Author
There was a problem hiding this comment. hm, this comes straight from what we had in the package, from the recent diff: So if this doesn't work then it's likely sending mails from logrotate never worked... I'll admit I never tested either myself, I'll give it a try this weekend unless someone beats me to it.
Member
Author
There was a problem hiding this comment. from logrotate changelog: You might be looking at old man page? that dates 3.13.0 (2017).... looking at the code and not testing I think we're fine, my setup is half broken so it's a pain to test and I'll leave it at code inspection...
Member
There was a problem hiding this comment. Yes, I think you are correct. |
||
| else ""; | ||
| in | ||
| { | ||
| imports = [ | ||
|
|
@@ -112,17 +205,121 @@ in | |
| options = { | ||
| services.logrotate = { | ||
| enable = mkEnableOption "the logrotate systemd service" // { | ||
| default = foldr (n: a: a || n.enable) false (attrValues cfg.settings); | ||
| defaultText = literalExpression "cfg.settings != {}"; | ||
| }; | ||
|
|
||
| settings = mkOption { | ||
| default = { }; | ||
| description = '' | ||
| logrotate freeform settings: each attribute here will define its own section, | ||
| ordered by priority, which can either define files to rotate with their settings | ||
| or settings common to all further files settings. | ||
| Refer to <link xlink:href="https://linux.die.net/man/8/logrotate"/> for details. | ||
| ''; | ||
| type = types.attrsOf (types.submodule ({ name, ... }: { | ||
| freeformType = with types; attrsOf (nullOr (oneOf [ int bool str ])); | ||
|
|
||
| options = { | ||
| enable = mkEnableOption "setting individual kill switch" // { | ||
| default = true; | ||
| }; | ||
|
|
||
| global = mkOption { | ||
| type = types.bool; | ||
| default = false; | ||
| description = '' | ||
| Whether this setting is a global option or not: set to have these | ||
| settings apply to all files settings with a higher priority. | ||
| ''; | ||
| }; | ||
| files = mkOption { | ||
| type = with types; either str (listOf str); | ||
| default = name; | ||
| defaultText = '' | ||
| The attrset name if not specified | ||
| ''; | ||
| description = '' | ||
| Single or list of files for which rules are defined. | ||
| The files are quoted with double-quotes in logrotate configuration, | ||
| so globs and spaces are supported. | ||
| Note this setting is ignored if globals is true. | ||
| ''; | ||
| }; | ||
|
|
||
| frequency = mkOption { | ||
| type = types.nullOr types.str; | ||
| default = null; | ||
| description = '' | ||
| How often to rotate the logs. Defaults to previously set global setting, | ||
| which itself defauts to weekly. | ||
| ''; | ||
| }; | ||
|
|
||
| priority = mkOption { | ||
| type = types.int; | ||
| default = 1000; | ||
| description = '' | ||
| Order of this logrotate block in relation to the others. The semantics are | ||
| the same as with `lib.mkOrder`. Smaller values are inserted first. | ||
| ''; | ||
| }; | ||
| }; | ||
|
|
||
| })); | ||
| }; | ||
|
|
||
| configFile = mkOption { | ||
| type = types.path; | ||
| default = configFile; | ||
| defaultText = '' | ||
| A configuration file automatically generated by NixOS. | ||
| ''; | ||
| description = '' | ||
| Override the configuration file used by MySQL. By default, | ||
| NixOS generates one automatically from <xref linkend="opt-services.logrotate.settings"/>. | ||
| ''; | ||
| example = literalExpression '' | ||
| pkgs.writeText "logrotate.conf" ''' | ||
| missingok | ||
| "/var/log/*.log" { | ||
| rotate 4 | ||
| weekly | ||
| } | ||
| '''; | ||
| ''; | ||
| }; | ||
|
|
||
| checkConfig = mkOption { | ||
| type = types.bool; | ||
| default = true; | ||
| description = '' | ||
| Whether the config should be checked at build time. | ||
|
|
||
| Some options are not checkable at build time because of the build sandbox: | ||
| for example, the test does not know about existing files and system users are | ||
| not known. | ||
| These limitations mean we must adjust the file for tests (missingok is forced | ||
| and users are replaced by dummy users), so tests are complemented by a | ||
| logrotate-checkconf service that is enabled by default. | ||
| This extra check can be disabled by disabling it at the systemd level with the | ||
| <option>services.systemd.services.logrotate-checkconf.enable</option> option. | ||
|
|
||
| Conversely there are still things that might make this check fail incorrectly | ||
| (e.g. a file path where we don't have access to intermediate directories): | ||
| in this case you can disable the failing check with this option. | ||
| ''; | ||
| }; | ||
|
|
||
| # deprecated legacy compat settings | ||
| paths = mkOption { | ||
| type = with types; attrsOf (submodule pathOpts); | ||
| default = { }; | ||
| description = '' | ||
| Attribute set of paths to rotate. The order each block appears in the generated configuration file | ||
| can be controlled by the <link linkend="opt-services.logrotate.paths._name_.priority">priority</link> option | ||
| using the same semantics as `lib.mkOrder`. Smaller values have a greater priority. | ||
| This setting has been deprecated in favor of <link linkend="opt-services.logrotate.settings">logrotate settings</link>. | ||
| ''; | ||
| example = literalExpression '' | ||
| { | ||
|
|
@@ -151,19 +348,37 @@ in | |
| description = '' | ||
| Extra contents to append to the logrotate configuration file. Refer to | ||
| <link xlink:href="https://linux.die.net/man/8/logrotate"/> for details. | ||
| This setting has been deprecated in favor of | ||
| <link linkend="opt-services.logrotate.settings">logrotate settings</link>. | ||
| ''; | ||
| }; | ||
| }; | ||
| }; | ||
|
|
||
| config = mkIf cfg.enable { | ||
| assertions = | ||
| mapAttrsToList | ||
| (name: pathOpts: | ||
| { | ||
| assertion = (pathOpts.user != null) == (pathOpts.group != null); | ||
| message = '' | ||
| If either of `services.logrotate.paths.${name}.user` or `services.logrotate.paths.${name}.group` are specified then *both* must be specified. | ||
| ''; | ||
| }) | ||
| cfg.paths; | ||
|
|
||
| warnings = | ||
| (mapAttrsToList | ||
| (name: pathOpts: '' | ||
| Using config.services.logrotate.paths.${name} is deprecated and will become unsupported in a future release. | ||
| Please use services.logrotate.settings instead. | ||
| '') | ||
| cfg.paths | ||
| ) ++ | ||
| (optional (cfg.extraConfig != "") '' | ||
| Using config.services.logrotate.extraConfig is deprecated and will become unsupported in a future release. | ||
| Please use services.logrotate.settings with globals=true instead. | ||
| ''); | ||
|
|
||
| systemd.services.logrotate = { | ||
| description = "Logrotate Service"; | ||
|
|
@@ -172,7 +387,16 @@ in | |
| serviceConfig = { | ||
| Restart = "no"; | ||
| User = "root"; | ||
| ExecStart = "${pkgs.logrotate}/sbin/logrotate ${mailOption} ${cfg.configFile}"; | ||
| }; | ||
| }; | ||
| systemd.services.logrotate-checkconf = { | ||
Artturin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| description = "Logrotate configuration check"; | ||
| wantedBy = [ "multi-user.target" ]; | ||
| serviceConfig = { | ||
| Type = "oneshot"; | ||
| RemainAfterExit = true; | ||
| ExecStart = "${pkgs.logrotate}/sbin/logrotate --debug ${cfg.configFile}"; | ||
| }; | ||
| }; | ||
| }; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the late comment, but this doesn't seem to be accounting for when the user sets
mail = false(so thatnomailappears in the appropriate section inlogrotate.conf).In other words, if the user sets
mail = falsein one of the sections in the settings, the--mailoption will get added even though no section in the settings actually setsmail = true.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good point, I'll update it to
a || n.mail or falsein a new PR (EDIT: when I get home, so now + ~7 hours)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in #177106