movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-14 06:00:33 +03:00
Code Activity

nixos/*: automatically convert option docs

Browse source
This commit is contained in:
pennae 2022-08-05 19:39:00 +02:00
parent 423545fe48
commit 087472b1e5
162 changed files with 1552 additions and 1552 deletions
Download patch file Download diff file Expand all files Collapse all files

14
nixos/modules/services/monitoring/prometheus/exporters.nix
View file

@ -84,28 +84,28 @@ let
port = mkOption {
type = types.port;
default = port;
description = ''
description = lib.mdDoc ''
Port to listen on.
'';
};
listenAddress = mkOption {
type = types.str;
default = "0.0.0.0";
description = ''
description = lib.mdDoc ''
Address to listen on.
'';
};
extraFlags = mkOption {
type = types.listOf types.str;
default = [];
description = ''
description = lib.mdDoc ''
Extra commandline options to pass to the ${name} exporter.
'';
};
openFirewall = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Open port in firewall for incoming connections.
'';
};
@ -124,14 +124,14 @@ let
user = mkOption {
type = types.str;
default = "${name}-exporter";
description = ''
description = lib.mdDoc ''
User name under which the ${name} exporter shall be run.
'';
};
group = mkOption {
type = types.str;
default = "${name}-exporter";
description = ''
description = lib.mdDoc ''
Group under which the ${name} exporter shall be run.
'';
};
@ -227,7 +227,7 @@ in
type = types.submodule {
options = (mkSubModules);
};
description = "Prometheus exporter configuration";
description = lib.mdDoc "Prometheus exporter configuration";
default = {};
example = literalExpression ''
{

4
nixos/modules/services/monitoring/prometheus/exporters/apcupsd.nix
View file

@ -11,7 +11,7 @@ in
apcupsdAddress = mkOption {
type = types.str;
default = ":3551";
description = ''
description = lib.mdDoc ''
Address of the apcupsd Network Information Server (NIS).
'';
};
@ -19,7 +19,7 @@ in
apcupsdNetwork = mkOption {
type = types.enum ["tcp" "tcp4" "tcp6"];
default = "tcp";
description = ''
description = lib.mdDoc ''
Network of the apcupsd Network Information Server (NIS): one of "tcp", "tcp4", or "tcp6".
'';
};

8
nixos/modules/services/monitoring/prometheus/exporters/artifactory.nix
View file

@ -11,14 +11,14 @@ in
scrapeUri = mkOption {
type = types.str;
default = "http://localhost:8081/artifactory";
description = ''
description = lib.mdDoc ''
URI on which to scrape JFrog Artifactory.
'';
};
artiUsername = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Username for authentication against JFrog Artifactory API.
'';
};
@ -26,7 +26,7 @@ in
artiPassword = mkOption {
type = types.str;
default = "";
description = ''
description = lib.mdDoc ''
Password for authentication against JFrog Artifactory API.
One of the password or access token needs to be set.
'';
@ -35,7 +35,7 @@ in
artiAccessToken = mkOption {
type = types.str;
default = "";
description = ''
description = lib.mdDoc ''
Access token for authentication against JFrog Artifactory API.
One of the password or access token needs to be set.
'';

8
nixos/modules/services/monitoring/prometheus/exporters/bind.nix
View file

@ -11,28 +11,28 @@ in
bindURI = mkOption {
type = types.str;
default = "http://localhost:8053/";
description = ''
description = lib.mdDoc ''
HTTP XML API address of an Bind server.
'';
};
bindTimeout = mkOption {
type = types.str;
default = "10s";
description = ''
description = lib.mdDoc ''
Timeout for trying to get stats from Bind.
'';
};
bindVersion = mkOption {
type = types.enum [ "xml.v2" "xml.v3" "auto" ];
default = "auto";
description = ''
description = lib.mdDoc ''
BIND statistics version. Can be detected automatically.
'';
};
bindGroups = mkOption {
type = types.listOf (types.enum [ "server" "view" "tasks" ]);
default = [ "server" "view" ];
description = ''
description = lib.mdDoc ''
List of statistics to collect. Available: [server, view, tasks]
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/bird.nix
View file

@ -11,21 +11,21 @@ in
birdVersion = mkOption {
type = types.enum [ 1 2 ];
default = 2;
description = ''
description = lib.mdDoc ''
Specifies whether BIRD1 or BIRD2 is in use.
'';
};
birdSocket = mkOption {
type = types.path;
default = "/run/bird/bird.ctl";
description = ''
description = lib.mdDoc ''
Path to BIRD2 (or BIRD1 v4) socket.
'';
};
newMetricFormat = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Enable the new more-generic metric format.
'';
};

14
nixos/modules/services/monitoring/prometheus/exporters/bitcoin.nix
View file

@ -11,14 +11,14 @@ in
rpcUser = mkOption {
type = types.str;
default = "bitcoinrpc";
description = ''
description = lib.mdDoc ''
RPC user name.
'';
};
rpcPasswordFile = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
File containing RPC password.
'';
};
@ -26,7 +26,7 @@ in
rpcScheme = mkOption {
type = types.enum [ "http" "https" ];
default = "http";
description = ''
description = lib.mdDoc ''
Whether to connect to bitcoind over http or https.
'';
};
@ -34,7 +34,7 @@ in
rpcHost = mkOption {
type = types.str;
default = "localhost";
description = ''
description = lib.mdDoc ''
RPC host.
'';
};
@ -42,7 +42,7 @@ in
rpcPort = mkOption {
type = types.port;
default = 8332;
description = ''
description = lib.mdDoc ''
RPC port number.
'';
};
@ -50,7 +50,7 @@ in
refreshSeconds = mkOption {
type = types.ints.unsigned;
default = 300;
description = ''
description = lib.mdDoc ''
How often to ask bitcoind for metrics.
'';
};
@ -58,7 +58,7 @@ in
extraEnv = mkOption {
type = types.attrsOf types.str;
default = {};
description = ''
description = lib.mdDoc ''
Extra environment variables for the exporter.
'';
};

4
nixos/modules/services/monitoring/prometheus/exporters/blackbox.nix
View file

@ -35,14 +35,14 @@ in {
extraOpts = {
configFile = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path to configuration file.
'';
};
enableConfigCheck = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to run a correctness check for the configuration file. This depends
on the configuration file residing in the nix-store. Paths passed as string will
be copied to the store.

8
nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix
View file

@ -11,7 +11,7 @@ in
tokenPath = mkOption {
type = types.nullOr types.path;
apply = final: if final == null then null else toString final;
description = ''
description = lib.mdDoc ''
The token from your Buildkite "Agents" page.
A run-time path to the token file, which is supposed to be provisioned
@ -22,14 +22,14 @@ in
type = types.str;
default = "30s";
example = "1min";
description = ''
description = lib.mdDoc ''
How often to update metrics.
'';
};
endpoint = mkOption {
type = types.str;
default = "https://agent.buildkite.com/v3";
description = ''
description = lib.mdDoc ''
The Buildkite Agent API endpoint.
'';
};
@ -37,7 +37,7 @@ in
type = with types; nullOr (listOf str);
default = null;
example = literalExpression ''[ "my-queue1" "my-queue2" ]'';
description = ''
description = lib.mdDoc ''
Which specific queues to process.
'';
};

12
nixos/modules/services/monitoring/prometheus/exporters/collectd.nix
View file

@ -14,19 +14,19 @@ in
authFile = mkOption {
default = null;
type = types.nullOr types.path;
description = "File mapping user names to pre-shared keys (passwords).";
description = lib.mdDoc "File mapping user names to pre-shared keys (passwords).";
};
port = mkOption {
type = types.int;
default = 25826;
description = "Network address on which to accept collectd binary network packets.";
description = lib.mdDoc "Network address on which to accept collectd binary network packets.";
};
listenAddress = mkOption {
type = types.str;
default = "0.0.0.0";
description = ''
description = lib.mdDoc ''
Address to listen on for binary network packets.
'';
};
@ -34,7 +34,7 @@ in
securityLevel = mkOption {
type = types.enum ["None" "Sign" "Encrypt"];
default = "None";
description = ''
description = lib.mdDoc ''
Minimum required security level for accepted packets.
'';
};
@ -44,7 +44,7 @@ in
type = types.enum [ "logfmt" "json" ];
default = "logfmt";
example = "json";
description = ''
description = lib.mdDoc ''
Set the log format.
'';
};
@ -52,7 +52,7 @@ in
logLevel = mkOption {
type = types.enum ["debug" "info" "warn" "error" "fatal"];
default = "info";
description = ''
description = lib.mdDoc ''
Only log messages with the given severity or above.
'';
};

22
nixos/modules/services/monitoring/prometheus/exporters/dmarc.nix
View file

@ -24,28 +24,28 @@ in {
host = mkOption {
type = types.str;
default = "localhost";
description = ''
description = lib.mdDoc ''
Hostname of IMAP server to connect to.
'';
};
port = mkOption {
type = types.port;
default = 993;
description = ''
description = lib.mdDoc ''
Port of the IMAP server to connect to.
'';
};
username = mkOption {
type = types.str;
example = "postmaster@example.org";
description = ''
description = lib.mdDoc ''
Login username for the IMAP connection.
'';
};
passwordFile = mkOption {
type = types.str;
example = "/run/secrets/dovecot_pw";
description = ''
description = lib.mdDoc ''
File containing the login password for the IMAP connection.
'';
};
@ -54,21 +54,21 @@ in {
inbox = mkOption {
type = types.str;
default = "INBOX";
description = ''
description = lib.mdDoc ''
IMAP mailbox that is checked for incoming DMARC aggregate reports
'';
};
done = mkOption {
type = types.str;
default = "Archive";
description = ''
description = lib.mdDoc ''
IMAP mailbox that successfully processed reports are moved to.
'';
};
error = mkOption {
type = types.str;
default = "Invalid";
description = ''
description = lib.mdDoc ''
IMAP mailbox that emails are moved to that could not be processed.
'';
};
@ -76,7 +76,7 @@ in {
pollIntervalSeconds = mkOption {
type = types.ints.unsigned;
default = 60;
description = ''
description = lib.mdDoc ''
How often to poll the IMAP server in seconds.
'';
};
@ -84,7 +84,7 @@ in {
type = types.ints.unsigned;
default = 604800;
defaultText = "7 days (in seconds)";
description = ''
description = lib.mdDoc ''
How long individual report IDs will be remembered to avoid
counting double delivered reports twice.
'';
@ -92,8 +92,8 @@ in {
debug = mkOption {
type = types.bool;
default = false;
description = ''
Whether to declare enable <literal>--debug</literal>.
description = lib.mdDoc ''
Whether to declare enable `--debug`.
'';
};
};

6
nixos/modules/services/monitoring/prometheus/exporters/dnsmasq.nix
View file

@ -11,7 +11,7 @@ in
dnsmasqListenAddress = mkOption {
type = types.str;
default = "localhost:53";
description = ''
description = lib.mdDoc ''
Address on which dnsmasq listens.
'';
};
@ -19,8 +19,8 @@ in
type = types.path;
default = "/var/lib/misc/dnsmasq.leases";
example = "/var/lib/dnsmasq/dnsmasq.leases";
description = ''
Path to the <literal>dnsmasq.leases</literal> file.
description = lib.mdDoc ''
Path to the `dnsmasq.leases` file.
'';
};
};

4
nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix
View file

@ -11,7 +11,7 @@ in
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};
@ -67,7 +67,7 @@ in
type = types.listOf types.str;
default = [ "user" ];
example = [ "user" "global" ];
description = ''
description = lib.mdDoc ''
Stats scopes to query.
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/fastly.nix
View file

@ -12,9 +12,9 @@ in
configFile = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Path to a fastly-exporter configuration file.
Example one can be generated with <literal>fastly-exporter --config-file-example</literal>.
Example one can be generated with `fastly-exporter --config-file-example`.
'';
example = "./fastly-exporter-config.txt";
};
@ -22,7 +22,7 @@ in
tokenPath = mkOption {
type = types.nullOr types.path;
apply = final: if final == null then null else toString final;
description = ''
description = lib.mdDoc ''
A run-time path to the token file, which is supposed to be provisioned
outside of Nix store.
'';

8
nixos/modules/services/monitoring/prometheus/exporters/flow.nix
View file

@ -10,19 +10,19 @@ in {
brokers = mkOption {
type = types.listOf types.str;
example = literalExpression ''[ "kafka.example.org:19092" ]'';
description = "List of Kafka brokers to connect to.";
description = lib.mdDoc "List of Kafka brokers to connect to.";
};
asn = mkOption {
type = types.ints.positive;
example = 65542;
description = "The ASN being monitored.";
description = lib.mdDoc "The ASN being monitored.";
};
partitions = mkOption {
type = types.listOf types.int;
default = [];
description = ''
description = lib.mdDoc ''
The number of the partitions to consume, none means all.
'';
};
@ -30,7 +30,7 @@ in {
topic = mkOption {
type = types.str;
example = "pmacct.acct";
description = "The Kafka topic to consume from.";
description = lib.mdDoc "The Kafka topic to consume from.";
};
};

4
nixos/modules/services/monitoring/prometheus/exporters/fritzbox.nix
View file

@ -11,7 +11,7 @@ in
gatewayAddress = mkOption {
type = types.str;
default = "fritz.box";
description = ''
description = lib.mdDoc ''
The hostname or IP of the FRITZ!Box.
'';
};
@ -19,7 +19,7 @@ in
gatewayPort = mkOption {
type = types.int;
default = 49000;
description = ''
description = lib.mdDoc ''
The port of the FRITZ!Box UPnP service.
'';
};

4
nixos/modules/services/monitoring/prometheus/exporters/influxdb.nix
View file

@ -12,13 +12,13 @@ in
type = types.str;
default = "5m";
example = "10m";
description = "How long a sample is valid for";
description = lib.mdDoc "How long a sample is valid for";
};
udpBindAddress = mkOption {
type = types.str;
default = ":9122";
example = "192.0.2.1:9122";
description = "Address on which to listen for udp packets";
description = lib.mdDoc "Address on which to listen for udp packets";
};
};
serviceOpts = {

4
nixos/modules/services/monitoring/prometheus/exporters/jitsi.nix
View file

@ -11,7 +11,7 @@ in
url = mkOption {
type = types.str;
default = "http://localhost:8080/colibri/stats";
description = ''
description = lib.mdDoc ''
Jitsi Videobridge metrics URL to monitor.
This is usually /colibri/stats on port 8080 of the jitsi videobridge host.
'';
@ -20,7 +20,7 @@ in
type = types.str;
default = "30s";
example = "1min";
description = ''
description = lib.mdDoc ''
How often to scrape new data
'';
};

2
nixos/modules/services/monitoring/prometheus/exporters/json.nix
View file

@ -10,7 +10,7 @@ in
extraOpts = {
configFile = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path to configuration file.
'';
};

2
nixos/modules/services/monitoring/prometheus/exporters/kea.nix
View file

@ -19,7 +19,7 @@ in {
"/run/kea/kea-dhcp6.socket"
]
'';
description = ''
description = lib.mdDoc ''
Paths to kea control sockets
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/knot.nix
View file

@ -19,15 +19,15 @@ in {
knotSocketPath = mkOption {
type = types.str;
default = "/run/knot/knot.sock";
description = ''
Socket path of <citerefentry><refentrytitle>knotd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
description = lib.mdDoc ''
Socket path of {manpage}`knotd(8)`.
'';
};
knotSocketTimeout = mkOption {
type = types.int;
default = 2000;
description = ''
description = lib.mdDoc ''
Timeout in seconds.
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/lnd.nix
View file

@ -11,21 +11,21 @@ in
lndHost = mkOption {
type = types.str;
default = "localhost:10009";
description = ''
description = lib.mdDoc ''
lnd instance gRPC address:port.
'';
};
lndTlsPath = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path to lnd TLS certificate.
'';
};
lndMacaroonDir = mkOption {
type = types.path;
description = ''
description = lib.mdDoc ''
Path to lnd macaroons.
'';
};

30
nixos/modules/services/monitoring/prometheus/exporters/mail.nix
View file

@ -22,41 +22,41 @@ let
serverOptions.options = {
name = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Value for label 'configname' which will be added to all metrics.
'';
};
server = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Hostname of the server that should be probed.
'';
};
port = mkOption {
type = types.int;
example = 587;
description = ''
description = lib.mdDoc ''
Port to use for SMTP.
'';
};
from = mkOption {
type = types.str;
example = "exporteruser@domain.tld";
description = ''
description = lib.mdDoc ''
Content of 'From' Header for probing mails.
'';
};
to = mkOption {
type = types.str;
example = "exporteruser@domain.tld";
description = ''
description = lib.mdDoc ''
Content of 'To' Header for probing mails.
'';
};
detectionDir = mkOption {
type = types.path;
example = "/var/spool/mail/exporteruser/new";
description = ''
description = lib.mdDoc ''
Directory in which new mails for the exporter user are placed.
Note that this needs to exist when the exporter starts.
'';
@ -65,14 +65,14 @@ let
type = types.nullOr types.str;
default = null;
example = "exporteruser@domain.tld";
description = ''
description = lib.mdDoc ''
Username to use for SMTP authentication.
'';
};
passphrase = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Password to use for SMTP authentication.
'';
};
@ -82,20 +82,20 @@ let
monitoringInterval = mkOption {
type = types.str;
example = "10s";
description = ''
description = lib.mdDoc ''
Time interval between two probe attempts.
'';
};
mailCheckTimeout = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Timeout until mails are considered "didn't make it".
'';
};
disableFileDeletion = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Disables the exporter's function to delete probing mails.
'';
};
@ -141,28 +141,28 @@ in
environmentFile = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
File containing env-vars to be substituted into the exporter's config.
'';
};
configFile = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Specify the mailexporter configuration file to use.
'';
};
configuration = mkOption {
type = types.nullOr (types.submodule exporterOptions);
default = null;
description = ''
description = lib.mdDoc ''
Specify the mailexporter configuration file to use.
'';
};
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};

10
nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nix
View file

@ -11,9 +11,9 @@ in
configFile = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Path to a mikrotik exporter configuration file. Mutually exclusive with
<option>configuration</option> option.
{option}`configuration` option.
'';
example = literalExpression "./mikrotik.yml";
};
@ -21,11 +21,11 @@ in
configuration = mkOption {
type = types.nullOr types.attrs;
default = null;
description = ''
description = lib.mdDoc ''
Mikrotik exporter configuration as nix attribute set. Mutually exclusive with
<option>configFile</option> option.
{option}`configFile` option.
See <link xlink:href="https://github.com/nshttpd/mikrotik-exporter/blob/master/README.md"/>
See <https://github.com/nshttpd/mikrotik-exporter/blob/master/README.md>
for the description of the configuration file format.
'';
example = literalExpression ''

12
nixos/modules/services/monitoring/prometheus/exporters/minio.nix
View file

@ -11,7 +11,7 @@ in
minioAddress = mkOption {
type = types.str;
example = "https://10.0.0.1:9000";
description = ''
description = lib.mdDoc ''
The URL of the minio server.
Use HTTPS if Minio accepts secure connections only.
By default this connects to the local minio server if enabled.
@ -21,28 +21,28 @@ in
minioAccessKey = mkOption {
type = types.str;
example = "yourMinioAccessKey";
description = ''
description = lib.mdDoc ''
The value of the Minio access key.
It is required in order to connect to the server.
By default this uses the one from the local minio server if enabled
and <literal>config.services.minio.accessKey</literal>.
and `config.services.minio.accessKey`.
'';
};
minioAccessSecret = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
The value of the Minio access secret.
It is required in order to connect to the server.
By default this uses the one from the local minio server if enabled
and <literal>config.services.minio.secretKey</literal>.
and `config.services.minio.secretKey`.
'';
};
minioBucketStats = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Collect statistics about the buckets and files in buckets.
It requires more computation, use it carefully in case of large buckets..
'';

2
nixos/modules/services/monitoring/prometheus/exporters/modemmanager.nix
View file

@ -11,7 +11,7 @@ in
refreshRate = mkOption {
type = types.str;
default = "5s";
description = ''
description = lib.mdDoc ''
How frequently ModemManager will refresh the extended signal quality
information for each modem. The duration should be specified in seconds
("5s"), minutes ("1m"), or hours ("1h").

10
nixos/modules/services/monitoring/prometheus/exporters/nextcloud.nix
View file

@ -11,16 +11,16 @@ in
url = mkOption {
type = types.str;
example = "https://domain.tld";
description = ''
description = lib.mdDoc ''
URL to the Nextcloud serverinfo page.
Adding the path to the serverinfo API is optional, it defaults
to <literal>/ocs/v2.php/apps/serverinfo/api/v1/info</literal>.
to `/ocs/v2.php/apps/serverinfo/api/v1/info`.
'';
};
username = mkOption {
type = types.str;
default = "nextcloud-exporter";
description = ''
description = lib.mdDoc ''
Username for connecting to Nextcloud.
Note that this account needs to have admin privileges in Nextcloud.
'';
@ -28,7 +28,7 @@ in
passwordFile = mkOption {
type = types.path;
example = "/path/to/password-file";
description = ''
description = lib.mdDoc ''
File containing the password for connecting to Nextcloud.
Make sure that this file is readable by the exporter user.
'';
@ -36,7 +36,7 @@ in
timeout = mkOption {
type = types.str;
default = "5s";
description = ''
description = lib.mdDoc ''
Timeout for getting server info document.
'';
};

8
nixos/modules/services/monitoring/prometheus/exporters/nginx.nix
View file

@ -11,7 +11,7 @@ in
scrapeUri = mkOption {
type = types.str;
default = "http://localhost/nginx_status";
description = ''
description = lib.mdDoc ''
Address to access the nginx status page.
Can be enabled with services.nginx.statusPage = true.
'';
@ -19,14 +19,14 @@ in
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};
sslVerify = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to perform certificate verification for https.
'';
};
@ -37,7 +37,7 @@ in
"label1=value1"
"label2=value2"
];
description = ''
description = lib.mdDoc ''
A list of constant labels that will be used in every metric.
'';
};

2
nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix
View file

@ -24,7 +24,7 @@ in {
metricsEndpoint = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};

4
nixos/modules/services/monitoring/prometheus/exporters/node.nix
View file

@ -12,7 +12,7 @@ in
type = types.listOf types.str;
default = [];
example = [ "systemd" ];
description = ''
description = lib.mdDoc ''
Collectors to enable. The collectors listed here are enabled in addition to the default ones.
'';
};
@ -20,7 +20,7 @@ in
type = types.listOf types.str;
default = [];
example = [ "timex" ];
description = ''
description = lib.mdDoc ''
Collectors to disable which are enabled by default.
'';
};

4
nixos/modules/services/monitoring/prometheus/exporters/openldap.nix
View file

@ -40,7 +40,7 @@ in {
metricsPath = mkOption {
default = "/metrics";
type = types.str;
description = ''
description = lib.mdDoc ''
URL path where metrics should be exposed.
'';
};
@ -48,7 +48,7 @@ in {
default = "30s";
type = types.str;
example = "1m";
description = ''
description = lib.mdDoc ''
Scrape interval of the exporter.
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/openvpn.nix
View file

@ -9,15 +9,15 @@ in {
extraOpts = {
statusPaths = mkOption {
type = types.listOf types.str;
description = ''
description = lib.mdDoc ''
Paths to OpenVPN status files. Please configure the OpenVPN option
<literal>status</literal> accordingly.
`status` accordingly.
'';
};
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};

12
nixos/modules/services/monitoring/prometheus/exporters/pihole.nix
View file

@ -12,7 +12,7 @@ in
type = types.str;
default = "";
example = "580a770cb40511eb85290242ac130003580a770cb40511eb85290242ac130003";
description = ''
description = lib.mdDoc ''
pi-hole API token which can be used instead of a password
'';
};
@ -20,7 +20,7 @@ in
type = types.str;
default = "10s";
example = "30s";
description = ''
description = lib.mdDoc ''
How often to scrape new data
'';
};
@ -28,7 +28,7 @@ in
type = types.str;
default = "";
example = "password";
description = ''
description = lib.mdDoc ''
The password to login into pihole. An api token can be used instead.
'';
};
@ -36,7 +36,7 @@ in
type = types.str;
default = "pihole";
example = "127.0.0.1";
description = ''
description = lib.mdDoc ''
Hostname or address where to find the pihole webinterface
'';
};
@ -44,7 +44,7 @@ in
type = types.port;
default = 80;
example = 443;
description = ''
description = lib.mdDoc ''
The port pihole webinterface is reachable on
'';
};
@ -52,7 +52,7 @@ in
type = types.enum [ "http" "https" ];
default = "http";
example = "https";
description = ''
description = lib.mdDoc ''
The protocol which is used to connect to pihole
'';
};

22
nixos/modules/services/monitoring/prometheus/exporters/postfix.nix
View file

@ -10,17 +10,17 @@ in
extraOpts = {
group = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Group under which the postfix exporter shall be run.
It should match the group that is allowed to access the
<literal>showq</literal> socket in the <literal>queue/public/</literal> directory.
Defaults to <literal>services.postfix.setgidGroup</literal> when postfix is enabled.
`showq` socket in the `queue/public/` directory.
Defaults to `services.postfix.setgidGroup` when postfix is enabled.
'';
};
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};
@ -28,7 +28,7 @@ in
type = types.path;
default = "/var/log/postfix_exporter_input.log";
example = "/var/log/mail.log";
description = ''
description = lib.mdDoc ''
Path where Postfix writes log entries.
This file will be truncated by this exporter!
'';
@ -37,7 +37,7 @@ in
type = types.path;
default = "/var/lib/postfix/queue/public/showq";
example = "/var/spool/postfix/public/showq";
description = ''
description = lib.mdDoc ''
Path where Postfix places its showq socket.
'';
};
@ -45,29 +45,29 @@ in
enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable reading metrics from the systemd journal instead of from a logfile
'';
};
unit = mkOption {
type = types.str;
default = "postfix.service";
description = ''
description = lib.mdDoc ''
Name of the postfix systemd unit.
'';
};
slice = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Name of the postfix systemd slice.
This overrides the <option>systemd.unit</option>.
This overrides the {option}`systemd.unit`.
'';
};
journalPath = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Path to the systemd journal.
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/postgres.nix
View file

@ -11,7 +11,7 @@ in
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};
@ -19,14 +19,14 @@ in
type = types.str;
default = "user=postgres database=postgres host=/run/postgresql sslmode=disable";
example = "postgresql://username:password@localhost:5432/postgres?sslmode=disable";
description = ''
description = lib.mdDoc ''
Accepts PostgreSQL URI form and key=value form arguments.
'';
};
runAsLocalSuperUser = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to run the exporter as the local 'postgres' super user.
'';
};

4
nixos/modules/services/monitoring/prometheus/exporters/process.nix
View file

@ -18,11 +18,11 @@ in
{ name = "{{.Matches.Wrapped}} {{ .Matches.Args }}"; cmdline = [ "^/nix/store[^ ]*/(?P<Wrapped>[^ /]*) (?P<Args>.*)" ]; }
]
'';
description = ''
description = lib.mdDoc ''
All settings expressed as an Nix attrset.
Check the official documentation for the corresponding YAML
settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter"/>
settings that can all be used here: <https://github.com/ncabatoff/process-exporter>
'';
};
};

18
nixos/modules/services/monitoring/prometheus/exporters/pve.nix
View file

@ -20,7 +20,7 @@ in
default = pkgs.prometheus-pve-exporter;
defaultText = literalExpression "pkgs.prometheus-pve-exporter";
example = literalExpression "pkgs.prometheus-pve-exporter";
description = ''
description = lib.mdDoc ''
The package to use for prometheus-pve-exporter
'';
};
@ -29,7 +29,7 @@ in
type = with types; nullOr path;
default = null;
example = "/etc/prometheus-pve-exporter/pve.env";
description = ''
description = lib.mdDoc ''
Path to the service's environment file. This path can either be a computed path in /nix/store or a path in the local filesystem.
The environment file should NOT be stored in /nix/store as it contains passwords and/or keys in plain text.
@ -42,7 +42,7 @@ in
type = with types; nullOr path;
default = null;
example = "/etc/prometheus-pve-exporter/pve.yml";
description = ''
description = lib.mdDoc ''
Path to the service's config file. This path can either be a computed path in /nix/store or a path in the local filesystem.
The config file should NOT be stored in /nix/store as it will contain passwords and/or keys in plain text.
@ -57,42 +57,42 @@ in
status = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Collect Node/VM/CT status
'';
};
version = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Collect PVE version info
'';
};
node = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Collect PVE node info
'';
};
cluster = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Collect PVE cluster info
'';
};
resources = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Collect PVE resources info
'';
};
config = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Collect PVE onboot status
'';
};

8
nixos/modules/services/monitoring/prometheus/exporters/py-air-control.nix
View file

@ -14,14 +14,14 @@ in
deviceHostname = mkOption {
type = types.str;
example = "192.168.1.123";
description = ''
description = lib.mdDoc ''
The hostname of the air purification device from which to scrape the metrics.
'';
};
protocol = mkOption {
type = types.str;
default = "http";
description = ''
description = lib.mdDoc ''
The protocol to use when communicating with the air purification device.
Available: [http, coap, plain_coap]
'';
@ -29,8 +29,8 @@ in
stateDir = mkOption {
type = types.str;
default = "prometheus-py-air-control-exporter";
description = ''
Directory below <literal>/var/lib</literal> to store runtime data.
description = lib.mdDoc ''
Directory below `/var/lib` to store runtime data.
This directory will be created automatically using systemd's StateDirectory mechanism.
'';
};

2
nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix
View file

@ -69,7 +69,7 @@ in
custom_label = "some_value";
}
'';
description = "Set of labels added to each metric.";
description = lib.mdDoc "Set of labels added to each metric.";
};
};
serviceOpts.serviceConfig.ExecStart = ''

12
nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix
View file

@ -12,7 +12,7 @@ in
options = {
name = lib.mkOption {
type = str;
description = "Name to match.";
description = lib.mdDoc "Name to match.";
};
"${field}" = lib.mkOption {
type = int;
@ -20,7 +20,7 @@ in
};
location = lib.mkOption {
type = str;
description = "Location to match.";
description = lib.mdDoc "Location to match.";
};
};
});
@ -30,9 +30,9 @@ in
type = lib.types.str;
default = "-C si";
example = "-C si -R 19";
description = ''
description = lib.mdDoc ''
Flags passed verbatim to rtl_433 binary.
Having <literal>-C si</literal> (the default) is recommended since only Celsius temperatures are parsed.
Having `-C si` (the default) is recommended since only Celsius temperatures are parsed.
'';
};
channels = lib.mkOption {
@ -41,7 +41,7 @@ in
example = [
{ name = "Acurite"; channel = 6543; location = "Kitchen"; }
];
description = ''
description = lib.mdDoc ''
List of channel matchers to export.
'';
};
@ -51,7 +51,7 @@ in
example = [
{ name = "Nexus"; id = 1; location = "Bedroom"; }
];
description = ''
description = lib.mdDoc ''
List of ID matchers to export.
'';
};

10
nixos/modules/services/monitoring/prometheus/exporters/script.nix
View file

@ -15,18 +15,18 @@ in
name = mkOption {
type = str;
example = "sleep";
description = "Name of the script.";
description = lib.mdDoc "Name of the script.";
};
script = mkOption {
type = str;
example = "sleep 5";
description = "Shell script to execute when metrics are requested.";
description = lib.mdDoc "Shell script to execute when metrics are requested.";
};
timeout = mkOption {
type = nullOr int;
default = null;
example = 60;
description = "Optional timeout for the script in seconds.";
description = lib.mdDoc "Optional timeout for the script in seconds.";
};
};
});
@ -37,11 +37,11 @@ in
];
}
'';
description = ''
description = lib.mdDoc ''
All settings expressed as an Nix attrset.
Check the official documentation for the corresponding YAML
settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration"/>
settings that can all be used here: <https://github.com/adhocteam/script_exporter#sample-configuration>
'';
};
};

4
nixos/modules/services/monitoring/prometheus/exporters/smartctl.nix
View file

@ -24,7 +24,7 @@ in {
example = literalExpression ''
[ "/dev/sda", "/dev/nvme0n1" ];
'';
description = ''
description = lib.mdDoc ''
Paths to the disks that will be monitored. Will autodiscover
all disks if none given.
'';
@ -33,7 +33,7 @@ in {
type = types.str;
default = "60s";
example = "2m";
description = ''
description = lib.mdDoc ''
Interval that limits how often a disk can be queried.
'';
};

8
nixos/modules/services/monitoring/prometheus/exporters/smokeping.nix
View file

@ -17,27 +17,27 @@ in
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};
pingInterval = mkOption {
type = goDuration;
default = "1s";
description = ''
description = lib.mdDoc ''
Interval between pings.
'';
};
buckets = mkOption {
type = types.commas;
default = "5e-05,0.0001,0.0002,0.0004,0.0008,0.0016,0.0032,0.0064,0.0128,0.0256,0.0512,0.1024,0.2048,0.4096,0.8192,1.6384,3.2768,6.5536,13.1072,26.2144";
description = ''
description = lib.mdDoc ''
List of buckets to use for the response duration histogram.
'';
};
hosts = mkOption {
type = with types; listOf str;
description = ''
description = lib.mdDoc ''
List of endpoints to probe.
'';
};

8
nixos/modules/services/monitoring/prometheus/exporters/snmp.nix
View file

@ -11,7 +11,7 @@ in
configurationPath = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
description = lib.mdDoc ''
Path to a snmp exporter configuration file. Mutually exclusive with 'configuration' option.
'';
example = literalExpression "./snmp.yml";
@ -20,7 +20,7 @@ in
configuration = mkOption {
type = types.nullOr types.attrs;
default = null;
description = ''
description = lib.mdDoc ''
Snmp exporter configuration as nix attribute set. Mutually exclusive with 'configurationPath' option.
'';
example = {
@ -36,7 +36,7 @@ in
logFormat = mkOption {
type = types.enum ["logfmt" "json"];
default = "logfmt";
description = ''
description = lib.mdDoc ''
Output format of log messages.
'';
};
@ -44,7 +44,7 @@ in
logLevel = mkOption {
type = types.enum ["debug" "info" "warn" "error"];
default = "info";
description = ''
description = lib.mdDoc ''
Only log messages with the given severity or above.
'';
};

24
nixos/modules/services/monitoring/prometheus/exporters/sql.nix
View file

@ -7,7 +7,7 @@ let
jobs = mkOption {
type = attrsOf (submodule jobOptions);
default = { };
description = "An attrset of metrics scraping jobs to run.";
description = lib.mdDoc "An attrset of metrics scraping jobs to run.";
};
};
};
@ -15,23 +15,23 @@ let
options = with types; {
interval = mkOption {
type = str;
description = ''
description = lib.mdDoc ''
How often to run this job, specified in
<link xlink:href="https://golang.org/pkg/time/#ParseDuration">Go duration</link> format.
[Go duration](https://golang.org/pkg/time/#ParseDuration) format.
'';
};
connections = mkOption {
type = listOf str;
description = "A list of connection strings of the SQL servers to scrape metrics from";
description = lib.mdDoc "A list of connection strings of the SQL servers to scrape metrics from";
};
startupSql = mkOption {
type = listOf str;
default = [];
description = "A list of SQL statements to execute once after making a connection.";
description = lib.mdDoc "A list of SQL statements to execute once after making a connection.";
};
queries = mkOption {
type = attrsOf (submodule queryOptions);
description = "SQL queries to run.";
description = lib.mdDoc "SQL queries to run.";
};
};
};
@ -40,20 +40,20 @@ let
help = mkOption {
type = nullOr str;
default = null;
description = "A human-readable description of this metric.";
description = lib.mdDoc "A human-readable description of this metric.";
};
labels = mkOption {
type = listOf str;
default = [ ];
description = "A set of columns that will be used as Prometheus labels.";
description = lib.mdDoc "A set of columns that will be used as Prometheus labels.";
};
query = mkOption {
type = str;
description = "The SQL query to run.";
description = lib.mdDoc "The SQL query to run.";
};
values = mkOption {
type = listOf str;
description = "A set of columns that will be used as values of this metric.";
description = lib.mdDoc "A set of columns that will be used as values of this metric.";
};
};
};
@ -77,14 +77,14 @@ in
configFile = mkOption {
type = with types; nullOr path;
default = null;
description = ''
description = lib.mdDoc ''
Path to configuration file.
'';
};
configuration = mkOption {
type = with types; nullOr (submodule cfgOptions);
default = null;
description = ''
description = lib.mdDoc ''
Exporter configuration as nix attribute set. Mutually exclusive with 'configFile' option.
'';
};

2
nixos/modules/services/monitoring/prometheus/exporters/surfboard.nix
View file

@ -11,7 +11,7 @@ in
modemAddress = mkOption {
type = types.str;
default = "192.168.100.1";
description = ''
description = lib.mdDoc ''
The hostname or IP of the cable modem.
'';
};

4
nixos/modules/services/monitoring/prometheus/exporters/tor.nix
View file

@ -11,7 +11,7 @@ in
torControlAddress = mkOption {
type = types.str;
default = "127.0.0.1";
description = ''
description = lib.mdDoc ''
Tor control IP address or hostname.
'';
};
@ -19,7 +19,7 @@ in
torControlPort = mkOption {
type = types.int;
default = 9051;
description = ''
description = lib.mdDoc ''
Tor control port.
'';
};

6
nixos/modules/services/monitoring/prometheus/exporters/unbound.nix
View file

@ -12,7 +12,7 @@ in
# TODO: add shm when upstream implemented it
type = types.enum [ "tcp" "uds" ];
default = "uds";
description = ''
description = lib.mdDoc ''
Which methods the exporter uses to get the information from unbound.
'';
};
@ -20,7 +20,7 @@ in
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};
@ -29,7 +29,7 @@ in
type = types.nullOr types.str;
default = null;
example = "/run/unbound/unbound.socket";
description = ''
description = lib.mdDoc ''
Path to the unbound socket for uds mode or the control interface port for tcp mode.
Example:

10
nixos/modules/services/monitoring/prometheus/exporters/unifi.nix
View file

@ -11,7 +11,7 @@ in
unifiAddress = mkOption {
type = types.str;
example = "https://10.0.0.1:8443";
description = ''
description = lib.mdDoc ''
URL of the UniFi Controller API.
'';
};
@ -19,7 +19,7 @@ in
unifiInsecure = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
If enabled skip the verification of the TLS certificate of the UniFi Controller API.
Use with caution.
'';
@ -28,14 +28,14 @@ in
unifiUsername = mkOption {
type = types.str;
example = "ReadOnlyUser";
description = ''
description = lib.mdDoc ''
username for authentication against UniFi Controller API.
'';
};
unifiPassword = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Password for authentication against UniFi Controller API.
'';
};
@ -44,7 +44,7 @@ in
type = types.str;
default = "5s";
example = "2m";
description = ''
description = lib.mdDoc ''
Timeout including unit for UniFi Controller API requests.
'';
};

16
nixos/modules/services/monitoring/prometheus/exporters/varnish.nix
View file

@ -11,35 +11,35 @@ in
noExit = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Do not exit server on Varnish scrape errors.
'';
};
withGoMetrics = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Export go runtime and http handler metrics.
'';
};
verbose = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Enable verbose logging.
'';
};
raw = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Enable raw stdout logging without timestamps.
'';
};
varnishStatPath = mkOption {
type = types.str;
default = "varnishstat";
description = ''
description = lib.mdDoc ''
Path to varnishstat.
'';
};
@ -47,21 +47,21 @@ in
type = types.nullOr types.str;
default = config.services.varnish.stateDir;
defaultText = lib.literalExpression "config.services.varnish.stateDir";
description = ''
description = lib.mdDoc ''
varnishstat -n value.
'';
};
healthPath = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
Path under which to expose healthcheck. Disabled unless configured.
'';
};
telemetryPath = mkOption {
type = types.str;
default = "/metrics";
description = ''
description = lib.mdDoc ''
Path under which to expose metrics.
'';
};

20
nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix
View file

@ -17,13 +17,13 @@ in {
type = with types; nullOr (either path str);
default = null;
description = ''
description = lib.mdDoc ''
Path to the Wireguard Config to
<link xlink:href="https://github.com/MindFlavor/prometheus_wireguard_exporter/tree/2.0.0#usage">add the peer's name to the stats of a peer</link>.
[add the peer's name to the stats of a peer](https://github.com/MindFlavor/prometheus_wireguard_exporter/tree/2.0.0#usage).
Please note that <literal>networking.wg-quick</literal> is required for this feature
as <literal>networking.wireguard</literal> uses
<citerefentry><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>
Please note that `networking.wg-quick` is required for this feature
as `networking.wireguard` uses
{manpage}`wg(8)`
to set the peers up.
'';
};
@ -31,18 +31,18 @@ in {
singleSubnetPerField = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
By default, all allowed IPs and subnets are comma-separated in the
<literal>allowed_ips</literal> field. With this option enabled,
a single IP and subnet will be listed in fields like <literal>allowed_ip_0</literal>,
<literal>allowed_ip_1</literal> and so on.
`allowed_ips` field. With this option enabled,
a single IP and subnet will be listed in fields like `allowed_ip_0`,
`allowed_ip_1` and so on.
'';
};
withRemoteIp = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether or not the remote IP of a WireGuard peer should be exposed via prometheus.
'';
};