movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 13:40:28 +03:00
Code Activity

nixos: remove all uses of lib.mdDoc

Browse source 
these changes were generated with nixq 0.0.2, by running

  nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix

two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.

Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
This commit is contained in:
stuebinm 2024-04-13 14:54:15 +02:00 • committed by Jonathan Ringer
parent 1dd996e59a
commit 6afb255d97
1701 changed files with 13694 additions and 13865 deletions
Download patch file Download diff file Expand all files Collapse all files

6
nixos/modules/services/logging/SystemdJournal2Gelf.nix
View file

@ -10,7 +10,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable SystemdJournal2Gelf.
'';
};
@ -18,7 +18,7 @@ in
graylogServer = mkOption {
type = types.str;
example = "graylog2.example.com:11201";
description = lib.mdDoc ''
description = ''
Host and port of your graylog2 input. This should be a GELF
UDP input.
'';
@ -27,7 +27,7 @@ in
extraOptions = mkOption {
type = types.separatedString " ";
default = "";
description = lib.mdDoc ''
description = ''
Any extra flags to pass to SystemdJournal2Gelf. Note that
these are basically `journalctl` flags.
'';

26
nixos/modules/services/logging/awstats.nix
View file

@ -11,21 +11,21 @@ let
type = types.enum [ "mail" "web" ];
default = "web";
example = "mail";
description = lib.mdDoc ''
description = ''
The type of log being collected.
'';
};
domain = mkOption {
type = types.str;
default = name;
description = lib.mdDoc "The domain name to collect stats for.";
description = "The domain name to collect stats for.";
example = "example.com";
};
logFile = mkOption {
type = types.str;
example = "/var/log/nginx/access.log";
description = lib.mdDoc ''
description = ''
The log file to be scanned.
For mail, set this to
@ -38,7 +38,7 @@ let
logFormat = mkOption {
type = types.str;
default = "1";
description = lib.mdDoc ''
description = ''
The log format being used.
For mail, set this to
@ -52,7 +52,7 @@ let
type = types.listOf types.str;
default = [];
example = [ "www.example.org" ];
description = lib.mdDoc ''
description = ''
List of aliases the site has.
'';
};
@ -65,22 +65,22 @@ let
"ValidHTTPCodes" = "404";
}
'';
description = lib.mdDoc "Extra configuration to be appended to awstats.\${name}.conf.";
description = "Extra configuration to be appended to awstats.\${name}.conf.";
};
webService = {
enable = mkEnableOption (lib.mdDoc "awstats web service");
enable = mkEnableOption "awstats web service";
hostname = mkOption {
type = types.str;
default = config.domain;
description = lib.mdDoc "The hostname the web service appears under.";
description = "The hostname the web service appears under.";
};
urlPrefix = mkOption {
type = types.str;
default = "/awstats";
description = lib.mdDoc "The URL prefix under which the awstats pages appear.";
description = "The URL prefix under which the awstats pages appear.";
};
};
};
@ -95,12 +95,12 @@ in
];
options.services.awstats = {
enable = mkEnableOption (lib.mdDoc "awstats, a real-time logfile analyzer");
enable = mkEnableOption "awstats, a real-time logfile analyzer";
dataDir = mkOption {
type = types.path;
default = "/var/lib/awstats";
description = lib.mdDoc "The directory where awstats data will be stored.";
description = "The directory where awstats data will be stored.";
};
configs = mkOption {
@ -114,14 +114,14 @@ in
};
}
'';
description = lib.mdDoc "Attribute set of domains to collect stats for.";
description = "Attribute set of domains to collect stats for.";
};
updateAt = mkOption {
type = types.nullOr types.str;
default = null;
example = "hourly";
description = lib.mdDoc ''
description = ''
Specification of the time at which awstats will get updated.
(in the format described by {manpage}`systemd.time(7)`)
'';

18
nixos/modules/services/logging/filebeat.nix
View file

@ -19,14 +19,14 @@ in
services.filebeat = {
enable = mkEnableOption (lib.mdDoc "filebeat");
enable = mkEnableOption "filebeat";
package = mkPackageOption pkgs "filebeat" {
example = "filebeat7";
};
inputs = mkOption {
description = lib.mdDoc ''
description = ''
Inputs specify how Filebeat locates and processes input data.
This is like `services.filebeat.settings.filebeat.inputs`,
@ -48,7 +48,7 @@ in
type = mkOption {
type = types.str;
default = name;
description = lib.mdDoc ''
description = ''
The input type.
Look for the value after `type:` on
@ -72,7 +72,7 @@ in
};
modules = mkOption {
description = lib.mdDoc ''
description = ''
Filebeat modules provide a quick way to get started
processing common log formats. They contain default
configurations, Elasticsearch ingest pipeline definitions,
@ -98,7 +98,7 @@ in
module = mkOption {
type = types.str;
default = name;
description = lib.mdDoc ''
description = ''
The name of the module.
Look for the value after `module:` on
@ -134,7 +134,7 @@ in
type = with types; listOf str;
default = [ "127.0.0.1:9200" ];
example = [ "myEShost:9200" ];
description = lib.mdDoc ''
description = ''
The list of Elasticsearch nodes to connect to.
The events are distributed to these nodes in round
@ -154,7 +154,7 @@ in
type = types.listOf json.type;
default = [];
internal = true;
description = lib.mdDoc ''
description = ''
Inputs specify how Filebeat locates and processes
input data. Use [](#opt-services.filebeat.inputs) instead.
@ -165,7 +165,7 @@ in
type = types.listOf json.type;
default = [];
internal = true;
description = lib.mdDoc ''
description = ''
Filebeat modules provide a quick way to get started
processing common log formats. They contain default
configurations, Elasticsearch ingest pipeline
@ -194,7 +194,7 @@ in
};
'';
description = lib.mdDoc ''
description = ''
Configuration for filebeat. See
<https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-reference-yml.html>
for supported values.

6
nixos/modules/services/logging/fluentd.nix
View file

@ -12,12 +12,12 @@ in {
options = {
services.fluentd = {
enable = mkEnableOption (lib.mdDoc "fluentd, a data/log collector");
enable = mkEnableOption "fluentd, a data/log collector";
config = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Fluentd config.";
description = "Fluentd config.";
};
package = mkPackageOption pkgs "fluentd" { };
@ -25,7 +25,7 @@ in {
plugins = mkOption {
type = types.listOf types.path;
default = [];
description = lib.mdDoc ''
description = ''
A list of plugin paths to pass into fluentd. It will make plugins defined in ruby files
there available in your config.
'';

26
nixos/modules/services/logging/graylog.nix
View file

@ -33,36 +33,36 @@ in
services.graylog = {
enable = mkEnableOption (lib.mdDoc "Graylog, a log management solution");
enable = mkEnableOption "Graylog, a log management solution";
package = mkOption {
type = types.package;
default = if versionOlder config.system.stateVersion "23.05" then pkgs.graylog-3_3 else pkgs.graylog-5_1;
defaultText = literalExpression (if versionOlder config.system.stateVersion "23.05" then "pkgs.graylog-3_3" else "pkgs.graylog-5_1");
description = lib.mdDoc "Graylog package to use.";
description = "Graylog package to use.";
};
user = mkOption {
type = types.str;
default = "graylog";
description = lib.mdDoc "User account under which graylog runs";
description = "User account under which graylog runs";
};
isMaster = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Whether this is the master instance of your Graylog cluster";
description = "Whether this is the master instance of your Graylog cluster";
};
nodeIdFile = mkOption {
type = types.str;
default = "/var/lib/graylog/server/node-id";
description = lib.mdDoc "Path of the file containing the graylog node-id";
description = "Path of the file containing the graylog node-id";
};
passwordSecret = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
You MUST set a secret to secure/pepper the stored user passwords here. Use at least 64 characters.
Generate one by using for example: pwgen -N 1 -s 96
'';
@ -71,13 +71,13 @@ in
rootUsername = mkOption {
type = types.str;
default = "admin";
description = lib.mdDoc "Name of the default administrator user";
description = "Name of the default administrator user";
};
rootPasswordSha2 = mkOption {
type = types.str;
example = "e3c652f0ba0b4801205814f8b6bc49672c4c74e25b497770bb89b22cdeb4e952";
description = lib.mdDoc ''
description = ''
You MUST specify a hash password for the root user (which you only need to initially set up the
system and in case you lose connectivity to your authentication backend)
This password cannot be changed using the API or via the web interface. If you need to change it,
@ -90,29 +90,29 @@ in
elasticsearchHosts = mkOption {
type = types.listOf types.str;
example = literalExpression ''[ "http://node1:9200" "http://user:password@node2:19200" ]'';
description = lib.mdDoc "List of valid URIs of the http ports of your elastic nodes. If one or more of your elasticsearch hosts require authentication, include the credentials in each node URI that requires authentication";
description = "List of valid URIs of the http ports of your elastic nodes. If one or more of your elasticsearch hosts require authentication, include the credentials in each node URI that requires authentication";
};
messageJournalDir = mkOption {
type = types.str;
default = "/var/lib/graylog/data/journal";
description = lib.mdDoc "The directory which will be used to store the message journal. The directory must be exclusively used by Graylog and must not contain any other files than the ones created by Graylog itself";
description = "The directory which will be used to store the message journal. The directory must be exclusively used by Graylog and must not contain any other files than the ones created by Graylog itself";
};
mongodbUri = mkOption {
type = types.str;
default = "mongodb://localhost/graylog";
description = lib.mdDoc "MongoDB connection string. See http://docs.mongodb.org/manual/reference/connection-string/ for details";
description = "MongoDB connection string. See http://docs.mongodb.org/manual/reference/connection-string/ for details";
};
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Any other configuration options you might want to add";
description = "Any other configuration options you might want to add";
};
plugins = mkOption {
description = lib.mdDoc "Extra graylog plugins";
description = "Extra graylog plugins";
default = [ ];
type = types.listOf types.package;
};

10
nixos/modules/services/logging/heartbeat.nix
View file

@ -18,7 +18,7 @@ in
services.heartbeat = {
enable = mkEnableOption (lib.mdDoc "heartbeat, uptime monitoring");
enable = mkEnableOption "heartbeat, uptime monitoring";
package = mkPackageOption pkgs "heartbeat" {
example = "heartbeat7";
@ -27,19 +27,19 @@ in
name = mkOption {
type = types.str;
default = "heartbeat";
description = lib.mdDoc "Name of the beat";
description = "Name of the beat";
};
tags = mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc "Tags to place on the shipped log messages";
description = "Tags to place on the shipped log messages";
};
stateDir = mkOption {
type = types.str;
default = "/var/lib/heartbeat";
description = lib.mdDoc "The state directory. heartbeat's own logs and other data are stored here.";
description = "The state directory. heartbeat's own logs and other data are stored here.";
};
extraConfig = mkOption {
@ -50,7 +50,7 @@ in
urls: ["http://localhost:9200"]
schedule: '@every 10s'
'';
description = lib.mdDoc "Any other configuration options you want to add";
description = "Any other configuration options you want to add";
};
};

10
nixos/modules/services/logging/journalbeat.nix
View file

@ -18,26 +18,26 @@ in
services.journalbeat = {
enable = mkEnableOption (lib.mdDoc "journalbeat");
enable = mkEnableOption "journalbeat";
package = mkPackageOption pkgs "journalbeat" { };
name = mkOption {
type = types.str;
default = "journalbeat";
description = lib.mdDoc "Name of the beat";
description = "Name of the beat";
};
tags = mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc "Tags to place on the shipped log messages";
description = "Tags to place on the shipped log messages";
};
stateDir = mkOption {
type = types.str;
default = "journalbeat";
description = lib.mdDoc ''
description = ''
Directory below `/var/lib/` to store journalbeat's
own logs and other data. This directory will be created automatically
using systemd's StateDirectory mechanism.
@ -47,7 +47,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Any other configuration options you want to add";
description = "Any other configuration options you want to add";
};
};

12
nixos/modules/services/logging/journaldriver.nix
View file

@ -17,7 +17,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable journaldriver to forward journald logs to
Stackdriver Logging.
'';
@ -26,7 +26,7 @@ in {
logLevel = mkOption {
type = types.str;
default = "info";
description = lib.mdDoc ''
description = ''
Log level at which journaldriver logs its own output.
'';
};
@ -34,7 +34,7 @@ in {
logName = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Configures the name of the target log in Stackdriver Logging.
This option can be set to, for example, the hostname of a
machine to improve the user experience in the logging
@ -45,7 +45,7 @@ in {
googleCloudProject = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Configures the name of the Google Cloud project to which to
forward journald logs.
@ -57,7 +57,7 @@ in {
logStream = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Configures the name of the Stackdriver Logging log stream into
which to write journald entries.
@ -69,7 +69,7 @@ in {
applicationCredentials = mkOption {
type = with types; nullOr path;
default = null;
description = lib.mdDoc ''
description = ''
Path to the service account private key (in JSON-format) used
to forward log entries to Stackdriver Logging on non-GCP
instances.

22
nixos/modules/services/logging/journalwatch.nix
View file

@ -51,7 +51,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
If enabled, periodically check the journal with journalwatch and report the results by mail.
'';
};
@ -59,7 +59,7 @@ in {
priority = mkOption {
type = types.int;
default = 6;
description = lib.mdDoc ''
description = ''
Lowest priority of message to be considered.
A value between 7 ("debug"), and 0 ("emerg"). Defaults to 6 ("info").
If you don't care about anything with "info" priority, you can reduce
@ -75,7 +75,7 @@ in {
type = types.str;
default = "journalwatch@${config.networking.hostName}";
defaultText = literalExpression ''"journalwatch@''${config.networking.hostName}"'';
description = lib.mdDoc ''
description = ''
Mail address to send journalwatch reports from.
'';
};
@ -83,7 +83,7 @@ in {
mailTo = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc ''
description = ''
Mail address to send journalwatch reports to.
'';
};
@ -91,7 +91,7 @@ in {
mailBinary = mkOption {
type = types.path;
default = "/run/wrappers/bin/sendmail";
description = lib.mdDoc ''
description = ''
Sendmail-compatible binary to be used to send the messages.
'';
};
@ -99,7 +99,7 @@ in {
extraConfig = mkOption {
type = types.str;
default = "";
description = lib.mdDoc ''
description = ''
Extra lines to be added verbatim to the journalwatch/config configuration file.
You can add any commandline argument to the config, without the '--'.
See `journalwatch --help` for all arguments and their description.
@ -112,7 +112,7 @@ in {
match = mkOption {
type = types.str;
example = "SYSLOG_IDENTIFIER = systemd";
description = lib.mdDoc ''
description = ''
Syntax: `field = value`
Specifies the log entry `field` this block should apply to.
If the `field` of a message matches this `value`,
@ -129,7 +129,7 @@ in {
(Stopped|Stopping|Starting|Started) .*
(Reached target|Stopped target) .*
'';
description = lib.mdDoc ''
description = ''
The filters to apply on all messages which satisfy {option}`match`.
Any of those messages that match any specified filter will be removed from journalwatch's output.
Each filter is an extended Python regular expression.
@ -175,7 +175,7 @@ in {
];
description = lib.mdDoc ''
description = ''
filterBlocks can be defined to blacklist journal messages which are not errors.
Each block matches on a log entry field, and the filters in that block then are matched
against all messages with a matching log entry field.
@ -191,7 +191,7 @@ in {
interval = mkOption {
type = types.str;
default = "hourly";
description = lib.mdDoc ''
description = ''
How often to run journalwatch.
The format is described in systemd.time(7).
@ -200,7 +200,7 @@ in {
accuracy = mkOption {
type = types.str;
default = "10min";
description = lib.mdDoc ''
description = ''
The time window around the interval in which the journalwatch run will be scheduled.
The format is described in systemd.time(7).

32
nixos/modules/services/logging/logcheck.nix
View file

@ -56,7 +56,7 @@ let
levelOption = mkOption {
default = "server";
type = types.enum [ "workstation" "server" "paranoid" ];
description = lib.mdDoc ''
description = ''
Set the logcheck level.
'';
};
@ -68,7 +68,7 @@ let
regex = mkOption {
default = "";
type = types.str;
description = lib.mdDoc ''
description = ''
Regex specifying which log lines to ignore.
'';
};
@ -80,7 +80,7 @@ let
user = mkOption {
default = "root";
type = types.str;
description = lib.mdDoc ''
description = ''
User that runs the cronjob.
'';
};
@ -88,7 +88,7 @@ let
cmdline = mkOption {
default = "";
type = types.str;
description = lib.mdDoc ''
description = ''
Command line for the cron job. Will be turned into a regex for the logcheck ignore rule.
'';
};
@ -97,7 +97,7 @@ let
default = null;
type = types.nullOr (types.str);
example = "02 06 * * *";
description = lib.mdDoc ''
description = ''
"min hr dom mon dow" crontab time args, to auto-create a cronjob too.
Leave at null to not do this and just add a logcheck ignore rule.
'';
@ -109,12 +109,12 @@ in
{
options = {
services.logcheck = {
enable = mkEnableOption (lib.mdDoc "logcheck cron job, to mail anomalies in the system logfiles to the administrator");
enable = mkEnableOption "logcheck cron job, to mail anomalies in the system logfiles to the administrator";
user = mkOption {
default = "logcheck";
type = types.str;
description = lib.mdDoc ''
description = ''
Username for the logcheck user.
'';
};
@ -123,7 +123,7 @@ in
default = "*";
example = "6";
type = types.str;
description = lib.mdDoc ''
description = ''
Time of day to run logcheck. A logcheck will be scheduled at xx:02 each day.
Leave default (*) to run every hour. Of course when nothing special was logged,
logcheck will be silent.
@ -134,7 +134,7 @@ in
default = "root";
example = "you@domain.com";
type = types.str;
description = lib.mdDoc ''
description = ''
Email address to send reports to.
'';
};
@ -142,7 +142,7 @@ in
level = mkOption {
default = "server";
type = types.str;
description = lib.mdDoc ''
description = ''
Set the logcheck level. Either "workstation", "server", or "paranoid".
'';
};
@ -150,7 +150,7 @@ in
config = mkOption {
default = "FQDN=1";
type = types.lines;
description = lib.mdDoc ''
description = ''
Config options that you would like in logcheck.conf.
'';
};
@ -159,7 +159,7 @@ in
default = [ "/var/log/messages" ];
type = types.listOf types.path;
example = [ "/var/log/messages" "/var/log/mail" ];
description = lib.mdDoc ''
description = ''
Which log files to check.
'';
};
@ -168,14 +168,14 @@ in
default = [];
example = [ "/etc/logcheck" ];
type = types.listOf types.path;
description = lib.mdDoc ''
description = ''
Directories with extra rules.
'';
};
ignore = mkOption {
default = {};
description = lib.mdDoc ''
description = ''
This option defines extra ignore rules.
'';
type = with types; attrsOf (submodule ignoreOptions);
@ -183,7 +183,7 @@ in
ignoreCron = mkOption {
default = {};
description = lib.mdDoc ''
description = ''
This option defines extra ignore rules for cronjobs.
'';
type = with types; attrsOf (submodule ignoreCronOptions);
@ -193,7 +193,7 @@ in
default = [];
type = types.listOf types.str;
example = [ "postdrop" "mongodb" ];
description = lib.mdDoc ''
description = ''
Extra groups for the logcheck user, for example to be able to use sendmail,
or to access certain log files.
'';

18
nixos/modules/services/logging/logrotate.nix
View file

@ -95,14 +95,14 @@ in
options = {
services.logrotate = {
enable = mkEnableOption (lib.mdDoc "the logrotate systemd service") // {
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 = lib.mdDoc ''
description = ''
logrotate freeform settings: each attribute here will define its own section,
ordered by {option}`services.logrotate.settings.<name>.priority`,
which can either define files to rotate with their settings
@ -142,14 +142,14 @@ in
freeformType = with types; attrsOf (nullOr (oneOf [ int bool str ]));
options = {
enable = mkEnableOption (lib.mdDoc "setting individual kill switch") // {
enable = mkEnableOption "setting individual kill switch" // {
default = true;
};
global = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether this setting is a global option or not: set to have these
settings apply to all files settings with a higher priority.
'';
@ -160,7 +160,7 @@ in
defaultText = ''
The attrset name if not specified
'';
description = lib.mdDoc ''
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.
@ -171,7 +171,7 @@ in
frequency = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc ''
description = ''
How often to rotate the logs. Defaults to previously set global setting,
which itself defaults to weekly.
'';
@ -180,7 +180,7 @@ in
priority = mkOption {
type = types.int;
default = 1000;
description = lib.mdDoc ''
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.
'';
@ -196,7 +196,7 @@ in
defaultText = ''
A configuration file automatically generated by NixOS.
'';
description = lib.mdDoc ''
description = ''
Override the configuration file used by logrotate. By default,
NixOS generates one automatically from [](#opt-services.logrotate.settings).
'';
@ -214,7 +214,7 @@ in
checkConfig = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether the config should be checked at build time.
Some options are not checkable at build time because of the build sandbox:

24
nixos/modules/services/logging/logstash.nix
View file

@ -51,7 +51,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Enable logstash.";
description = "Enable logstash.";
};
package = mkPackageOption pkgs "logstash" { };
@ -60,13 +60,13 @@ in
type = types.listOf types.path;
default = [ ];
example = literalExpression "[ pkgs.logstash-contrib ]";
description = lib.mdDoc "The paths to find other logstash plugins in.";
description = "The paths to find other logstash plugins in.";
};
dataDir = mkOption {
type = types.str;
default = "/var/lib/logstash";
description = lib.mdDoc ''
description = ''
A path to directory writable by logstash that it uses to store data.
Plugins will also have access to this path.
'';
@ -75,31 +75,31 @@ in
logLevel = mkOption {
type = types.enum [ "debug" "info" "warn" "error" "fatal" ];
default = "warn";
description = lib.mdDoc "Logging verbosity level.";
description = "Logging verbosity level.";
};
filterWorkers = mkOption {
type = types.int;
default = 1;
description = lib.mdDoc "The quantity of filter workers to run.";
description = "The quantity of filter workers to run.";
};
listenAddress = mkOption {
type = types.str;
default = "127.0.0.1";
description = lib.mdDoc "Address on which to start webserver.";
description = "Address on which to start webserver.";
};
port = mkOption {
type = types.str;
default = "9292";
description = lib.mdDoc "Port on which to start webserver.";
description = "Port on which to start webserver.";
};
inputConfig = mkOption {
type = types.lines;
default = "generator { }";
description = lib.mdDoc "Logstash input configuration.";
description = "Logstash input configuration.";
example = literalExpression ''
'''
# Read from journal
@ -114,7 +114,7 @@ in
filterConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "logstash filter configuration.";
description = "logstash filter configuration.";
example = ''
if [type] == "syslog" {
# Keep only relevant systemd fields
@ -132,7 +132,7 @@ in
outputConfig = mkOption {
type = types.lines;
default = "stdout { codec => rubydebug }";
description = lib.mdDoc "Logstash output configuration.";
description = "Logstash output configuration.";
example = ''
redis { host => ["localhost"] data_type => "list" key => "logstash" codec => json }
elasticsearch { }
@ -142,7 +142,7 @@ in
extraSettings = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Extra Logstash settings in YAML format.";
description = "Extra Logstash settings in YAML format.";
example = ''
pipeline:
batch:
@ -154,7 +154,7 @@ in
extraJvmOptions = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc "Extra JVM options, one per line (jvm.options format).";
description = "Extra JVM options, one per line (jvm.options format).";
example = ''
-Xms2g
-Xmx2g

6
nixos/modules/services/logging/promtail.nix
View file

@ -12,12 +12,12 @@ let
positionsFile = cfg.configuration.positions.filename;
in {
options.services.promtail = with types; {
enable = mkEnableOption (lib.mdDoc "the Promtail ingresser");
enable = mkEnableOption "the Promtail ingresser";
configuration = mkOption {
type = (pkgs.formats.json {}).type;
description = lib.mdDoc ''
description = ''
Specify the configuration for Promtail in Nix.
'';
};
@ -26,7 +26,7 @@ in {
type = listOf str;
default = [];
example = [ "--server.http-listen-port=3101" ];
description = lib.mdDoc ''
description = ''
Specify a list of additional command line flags,
which get escaped and are then passed to Loki.
'';

8
nixos/modules/services/logging/rsyslogd.nix
View file

@ -39,7 +39,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable syslogd. Note that systemd also logs
syslog messages, so you normally don't need to run syslogd.
'';
@ -48,7 +48,7 @@ in
defaultConfig = mkOption {
type = types.lines;
default = defaultConf;
description = lib.mdDoc ''
description = ''
The default {file}`syslog.conf` file configures a
fairly standard setup of log files, which can be extended by
means of {var}`extraConfig`.
@ -59,7 +59,7 @@ in
type = types.lines;
default = "";
example = "news.* -/var/log/news";
description = lib.mdDoc ''
description = ''
Additional text appended to {file}`syslog.conf`,
i.e. the contents of {var}`defaultConfig`.
'';
@ -69,7 +69,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "-m 0" ];
description = lib.mdDoc ''
description = ''
Additional parameters passed to {command}`rsyslogd`.
'';
};

8
nixos/modules/services/logging/syslog-ng.nix
View file

@ -36,7 +36,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable the syslog-ng daemon.
'';
};
@ -44,7 +44,7 @@ in {
extraModulePaths = mkOption {
type = types.listOf types.str;
default = [];
description = lib.mdDoc ''
description = ''
A list of paths that should be included in syslog-ng's
`--module-path` option. They should usually
end in `/lib/syslog-ng`
@ -53,7 +53,7 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = lib.mdDoc ''
description = ''
Configuration added to the end of `syslog-ng.conf`.
'';
};
@ -63,7 +63,7 @@ in {
@version: 4.4
@include "scl.conf"
'';
description = lib.mdDoc ''
description = ''
The very first lines of the configuration file. Should usually contain
the syslog-ng version header.
'';

12
nixos/modules/services/logging/syslogd.nix
View file

@ -39,7 +39,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to enable syslogd. Note that systemd also logs
syslog messages, so you normally don't need to run syslogd.
'';
@ -48,7 +48,7 @@ in
tty = mkOption {
type = types.str;
default = "tty10";
description = lib.mdDoc ''
description = ''
The tty device on which syslogd will print important log
messages. Leave this option blank to disable tty logging.
'';
@ -57,7 +57,7 @@ in
defaultConfig = mkOption {
type = types.lines;
default = defaultConf;
description = lib.mdDoc ''
description = ''
The default {file}`syslog.conf` file configures a
fairly standard setup of log files, which can be extended by
means of {var}`extraConfig`.
@ -67,7 +67,7 @@ in
enableNetworkInput = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Accept logging through UDP. Option -r of syslogd(8).
'';
};
@ -76,7 +76,7 @@ in
type = types.lines;
default = "";
example = "news.* -/var/log/news";
description = lib.mdDoc ''
description = ''
Additional text appended to {file}`syslog.conf`,
i.e. the contents of {var}`defaultConfig`.
'';
@ -86,7 +86,7 @@ in
type = types.listOf types.str;
default = [ ];
example = [ "-m 0" ];
description = lib.mdDoc ''
description = ''
Additional parameters passed to {command}`syslogd`.
'';
};

6
nixos/modules/services/logging/ulogd.nix
View file

@ -8,7 +8,7 @@ let
in {
options = {
services.ulogd = {
enable = mkEnableOption (lib.mdDoc "ulogd, a userspace logging daemon for netfilter/iptables related logging");
enable = mkEnableOption "ulogd, a userspace logging daemon for netfilter/iptables related logging";
settings = mkOption {
example = {
@ -31,14 +31,14 @@ in {
};
type = settingsFormat.type;
default = { };
description = lib.mdDoc
description =
"Configuration for ulogd. See {file}`/share/doc/ulogd/` in `pkgs.ulogd.doc`.";
};
logLevel = mkOption {
type = types.enum [ 1 3 5 7 8 ];
default = 5;
description = lib.mdDoc
description =
"Log level (1 = debug, 3 = info, 5 = notice, 7 = error, 8 = fatal)";
};
};

6
nixos/modules/services/logging/vector.nix
View file

@ -6,14 +6,14 @@ let cfg = config.services.vector;
in
{
options.services.vector = {
enable = mkEnableOption (lib.mdDoc "Vector, a high-performance observability data pipeline");
enable = mkEnableOption "Vector, a high-performance observability data pipeline";
package = mkPackageOption pkgs "vector" { };
journaldAccess = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Enable Vector to access journald.
'';
};
@ -21,7 +21,7 @@ in
settings = mkOption {
type = (pkgs.formats.json { }).type;
default = { };
description = lib.mdDoc ''
description = ''
Specify the configuration for Vector in Nix.
'';
};