diff options
Diffstat (limited to 'nixos/modules/services/monitoring/prometheus')
72 files changed, 354 insertions, 354 deletions
diff --git a/nixos/modules/services/monitoring/prometheus/alertmanager-irc-relay.nix b/nixos/modules/services/monitoring/prometheus/alertmanager-irc-relay.nix index 9b9bafa09441b..eda4277c1bac1 100644 --- a/nixos/modules/services/monitoring/prometheus/alertmanager-irc-relay.nix +++ b/nixos/modules/services/monitoring/prometheus/alertmanager-irc-relay.nix @@ -10,14 +10,14 @@ let in { options.services.prometheus.alertmanagerIrcRelay = { - enable = mkEnableOption (mdDoc "Alertmanager IRC Relay"); + enable = mkEnableOption "Alertmanager IRC Relay"; package = mkPackageOption pkgs "alertmanager-irc-relay" { }; extraFlags = mkOption { type = types.listOf types.str; default = []; - description = mdDoc "Extra command line options to pass to alertmanager-irc-relay."; + description = "Extra command line options to pass to alertmanager-irc-relay."; }; settings = mkOption { @@ -36,7 +36,7 @@ in ]; } ''; - description = mdDoc '' + description = '' Configuration for Alertmanager IRC Relay as a Nix attribute set. For a reference, check out the [example configuration](https://github.com/google/alertmanager-irc-relay#configuring-and-running-the-bot) diff --git a/nixos/modules/services/monitoring/prometheus/alertmanager.nix b/nixos/modules/services/monitoring/prometheus/alertmanager.nix index bb426d8b7beb0..d1d8f2caaf63d 100644 --- a/nixos/modules/services/monitoring/prometheus/alertmanager.nix +++ b/nixos/modules/services/monitoring/prometheus/alertmanager.nix @@ -42,14 +42,14 @@ in { options = { services.prometheus.alertmanager = { - enable = mkEnableOption (lib.mdDoc "Prometheus Alertmanager"); + enable = mkEnableOption "Prometheus Alertmanager"; package = mkPackageOption pkgs "prometheus-alertmanager" { }; configuration = mkOption { type = types.nullOr types.attrs; default = null; - description = lib.mdDoc '' + description = '' Alertmanager configuration as nix attribute set. ''; }; @@ -57,7 +57,7 @@ in { configText = mkOption { type = types.nullOr types.lines; default = null; - description = lib.mdDoc '' + description = '' Alertmanager configuration as YAML text. If non-null, this option defines the text that is written to alertmanager.yml. If null, the contents of alertmanager.yml is generated from the structured config @@ -68,7 +68,7 @@ in { checkConfig = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Check configuration with `amtool check-config`. The call to `amtool` is subject to sandboxing by Nix. @@ -82,7 +82,7 @@ in { logFormat = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' If set use a syslog logger or JSON logging. ''; }; @@ -90,7 +90,7 @@ in { logLevel = mkOption { type = types.enum ["debug" "info" "warn" "error" "fatal"]; default = "warn"; - description = lib.mdDoc '' + description = '' Only log messages with the given severity or above. ''; }; @@ -98,7 +98,7 @@ in { webExternalUrl = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' The URL under which Alertmanager is externally reachable (for example, if Alertmanager is served via a reverse proxy). Used for generating relative and absolute links back to Alertmanager itself. If the URL has a path portion, it will be used to prefix all HTTP endoints served by Alertmanager. @@ -109,7 +109,7 @@ in { listenAddress = mkOption { type = types.str; default = ""; - description = lib.mdDoc '' + description = '' Address to listen on for the web interface and API. Empty string will listen on all interfaces. "localhost" will listen on 127.0.0.1 (but not ::1). ''; @@ -118,7 +118,7 @@ in { port = mkOption { type = types.port; default = 9093; - description = lib.mdDoc '' + description = '' Port to listen on for the web interface and API. ''; }; @@ -126,7 +126,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Open port in firewall for incoming connections. ''; }; @@ -134,7 +134,7 @@ in { clusterPeers = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Initial peers for HA cluster. ''; }; @@ -142,7 +142,7 @@ in { extraFlags = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Extra commandline options when launching the Alertmanager. ''; }; @@ -151,7 +151,7 @@ in { type = types.nullOr types.path; default = null; example = "/root/alertmanager.env"; - description = lib.mdDoc '' + description = '' File to load as environment file. Environment variables from this file will be interpolated into the config file using envsubst with this syntax: diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index b4ac8e21451af..e9d51b51f14dc 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -110,7 +110,7 @@ let mkOpt = type: description: mkOption { type = types.nullOr type; default = null; - description = lib.mdDoc description; + description = description; }; mkSdConfigModule = extraOptions: types.submodule { @@ -188,7 +188,7 @@ let options = { username = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' HTTP username ''; }; @@ -255,13 +255,13 @@ let authorization = mkOption { type = types.nullOr types.attrs; default = null; - description = lib.mdDoc '' + description = '' Sets the `Authorization` header on every scrape request with the configured credentials. ''; }; job_name = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The job name assigned to scraped metrics by default. ''; }; @@ -516,7 +516,7 @@ let subscription_id = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The subscription ID. ''; }; @@ -621,7 +621,7 @@ let mkDockerSdConfigModule = extraOptions: mkSdConfigModule ({ host = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Address of the Docker daemon. ''; }; @@ -636,7 +636,7 @@ let options = { name = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Name of the filter. The available filters are listed in the upstream documentation: Services: <https://docs.docker.com/engine/api/v1.40/#operation/ServiceList> Tasks: <https://docs.docker.com/engine/api/v1.40/#operation/TaskList> @@ -645,7 +645,7 @@ let }; values = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Value for the filter. ''; }; @@ -668,7 +668,7 @@ let promTypes.dockerswarm_sd_config = mkDockerSdConfigModule { role = mkOption { type = types.enum [ "services" "tasks" "nodes" ]; - description = lib.mdDoc '' + description = '' Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`. ''; }; @@ -678,7 +678,7 @@ let options = { names = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' A list of DNS SRV record names to be queried. ''; }; @@ -701,7 +701,7 @@ let options = { region = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The AWS Region. If blank, the region from the instance metadata is used. ''; }; @@ -742,7 +742,7 @@ let options = { name = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' See [this list](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) for the available filters. ''; @@ -751,7 +751,7 @@ let values = mkOption { type = types.listOf types.str; default = [ ]; - description = lib.mdDoc '' + description = '' Value of the filter. ''; }; @@ -765,7 +765,7 @@ let promTypes.eureka_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The URL to connect to the Eureka server. ''; }; @@ -775,7 +775,7 @@ let options = { files = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Patterns for files from which target groups are extracted. Refer to the Prometheus documentation for permitted filename patterns and formats. @@ -794,14 +794,14 @@ let # required configuration values for `gce_sd_config`. project = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The GCP Project. ''; }; zone = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The zone of the scrape targets. If you need multiple zones use multiple gce_sd_configs. ''; @@ -834,7 +834,7 @@ let promTypes.hetzner_sd_config = mkSdConfigModule { role = mkOption { type = types.enum [ "robot" "hcloud" ]; - description = lib.mdDoc '' + description = '' The Hetzner role of entities that should be discovered. One of `robot` or `hcloud`. ''; @@ -853,7 +853,7 @@ let options = { url = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' URL from which the targets are fetched. ''; }; @@ -890,7 +890,7 @@ let role = mkOption { type = types.enum [ "endpoints" "service" "pod" "node" "ingress" ]; - description = lib.mdDoc '' + description = '' The Kubernetes role of entities that should be discovered. One of endpoints, service, pod, node, or ingress. ''; @@ -921,7 +921,7 @@ let options = { role = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Selector role ''; }; @@ -955,7 +955,7 @@ let promTypes.kuma_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Address of the Kuma Control Plane's MADS xDS server. ''; }; @@ -1023,7 +1023,7 @@ let promTypes.marathon_sd_config = mkSdConfigModule { servers = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' List of URLs to be used to contact Marathon servers. You need to provide at least one server URL. ''; }; @@ -1049,14 +1049,14 @@ let options = { servers = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' The Zookeeper servers. ''; }; paths = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Paths can point to a single service, or the root of a tree of services. ''; }; @@ -1098,14 +1098,14 @@ let { role = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The OpenStack role of entities that should be discovered. ''; }; region = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The OpenStack Region. ''; }; @@ -1166,14 +1166,14 @@ let promTypes.puppetdb_sd_config = mkSdConfigModule { url = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The URL of the PuppetDB root query endpoint. ''; }; query = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Puppet Query Language (PQL) query. Only resources are supported. https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html ''; @@ -1202,7 +1202,7 @@ let options = { access_key = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Access key to use. https://console.scaleway.com/project/credentials ''; }; @@ -1219,14 +1219,14 @@ let project_id = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Project ID of the targets. ''; }; role = mkOption { type = types.enum [ "instance" "baremetal" ]; - description = lib.mdDoc '' + description = '' Role of the targets to retrieve. Must be `instance` or `baremetal`. ''; }; @@ -1276,7 +1276,7 @@ let options = { account = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The account to use for discovering new targets. ''; }; @@ -1289,14 +1289,14 @@ let dns_suffix = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The DNS suffix which should be applied to target. ''; }; endpoint = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The Triton discovery endpoint (e.g. `cmon.us-east-3b.triton.zone`). This is often the same value as dns_suffix. ''; @@ -1328,21 +1328,21 @@ let promTypes.uyuni_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The URL to connect to the Uyuni server. ''; }; username = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Credentials are used to authenticate the requests to Uyuni API. ''; }; password = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Credentials are used to authenticate the requests to Uyuni API. ''; }; @@ -1364,14 +1364,14 @@ let options = { targets = mkOption { type = types.listOf types.str; - description = lib.mdDoc '' + description = '' The targets specified by the target group. ''; }; labels = mkOption { type = types.attrsOf types.str; default = { }; - description = lib.mdDoc '' + description = '' Labels assigned to all metrics scraped from the targets. ''; }; @@ -1427,7 +1427,7 @@ let options = { url = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1 ''; @@ -1517,7 +1517,7 @@ let options = { url = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1 ''; @@ -1575,14 +1575,14 @@ in options.services.prometheus = { - enable = mkEnableOption (lib.mdDoc "Prometheus monitoring daemon"); + enable = mkEnableOption "Prometheus monitoring daemon"; package = mkPackageOption pkgs "prometheus" { }; port = mkOption { type = types.port; default = 9090; - description = lib.mdDoc '' + description = '' Port to listen on. ''; }; @@ -1590,7 +1590,7 @@ in listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = lib.mdDoc '' + description = '' Address to listen on for the web interface, API, and telemetry. ''; }; @@ -1598,7 +1598,7 @@ in stateDir = mkOption { type = types.str; default = "prometheus2"; - description = lib.mdDoc '' + description = '' Directory below `/var/lib` to store Prometheus metrics data. This directory will be created automatically using systemd's StateDirectory mechanism. ''; @@ -1607,7 +1607,7 @@ in extraFlags = mkOption { type = types.listOf types.str; default = [ ]; - description = lib.mdDoc '' + description = '' Extra commandline options when launching Prometheus. ''; }; @@ -1615,7 +1615,7 @@ in enableReload = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Reload prometheus when configuration file changes (instead of restart). The following property holds: switching to a configuration @@ -1625,12 +1625,12 @@ in ''; }; - enableAgentMode = mkEnableOption (lib.mdDoc "agent mode"); + enableAgentMode = mkEnableOption "agent mode"; configText = mkOption { type = types.nullOr types.lines; default = null; - description = lib.mdDoc '' + description = '' If non-null, this option defines the text that is written to prometheus.yml. If null, the contents of prometheus.yml is generated from the structured config options. @@ -1640,7 +1640,7 @@ in globalConfig = mkOption { type = promTypes.globalConfig; default = { }; - description = lib.mdDoc '' + description = '' Parameters that are valid in all configuration contexts. They also serve as defaults for other configuration sections ''; @@ -1649,7 +1649,7 @@ in remoteRead = mkOption { type = types.listOf promTypes.remote_read; default = [ ]; - description = lib.mdDoc '' + description = '' Parameters of the endpoints to query from. See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read) for more information. ''; @@ -1658,7 +1658,7 @@ in remoteWrite = mkOption { type = types.listOf promTypes.remote_write; default = [ ]; - description = lib.mdDoc '' + description = '' Parameters of the endpoints to send samples to. See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) for more information. ''; @@ -1667,7 +1667,7 @@ in rules = mkOption { type = types.listOf types.str; default = [ ]; - description = lib.mdDoc '' + description = '' Alerting and/or Recording rules to evaluate at runtime. ''; }; @@ -1675,7 +1675,7 @@ in ruleFiles = mkOption { type = types.listOf types.path; default = [ ]; - description = lib.mdDoc '' + description = '' Any additional rules files to include in this configuration. ''; }; @@ -1683,7 +1683,7 @@ in scrapeConfigs = mkOption { type = types.listOf promTypes.scrape_config; default = [ ]; - description = lib.mdDoc '' + description = '' A list of scrape configurations. ''; }; @@ -1702,7 +1702,7 @@ in } ] ''; default = [ ]; - description = lib.mdDoc '' + description = '' A list of alertmanagers to send alerts to. See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config) for more information. ''; @@ -1711,7 +1711,7 @@ in alertmanagerNotificationQueueCapacity = mkOption { type = types.int; default = 10000; - description = lib.mdDoc '' + description = '' The capacity of the queue for pending alert manager notifications. ''; }; @@ -1720,7 +1720,7 @@ in type = types.nullOr types.str; default = null; example = "https://example.com/"; - description = lib.mdDoc '' + description = '' The URL under which Prometheus is externally reachable (for example, if Prometheus is served via a reverse proxy). ''; @@ -1729,7 +1729,7 @@ in webConfigFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Specifies which file should be used as web.config.file and be passed on startup. See https://prometheus.io/docs/prometheus/latest/configuration/https/ for valid options. ''; @@ -1739,7 +1739,7 @@ in type = with types; either bool (enum [ "syntax-only" ]); default = true; example = "syntax-only"; - description = lib.mdDoc '' + description = '' Check configuration with `promtool check`. The call to `promtool` is subject to sandboxing by Nix. @@ -1756,7 +1756,7 @@ in type = types.nullOr types.str; default = null; example = "15d"; - description = lib.mdDoc '' + description = '' How long to retain samples in storage. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters.nix b/nixos/modules/services/monitoring/prometheus/exporters.nix index 0331a07b5109d..a9eab3e7055cc 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters.nix @@ -129,32 +129,32 @@ let ); mkExporterOpts = ({ name, port }: { - enable = mkEnableOption (lib.mdDoc "the prometheus ${name} exporter"); + enable = mkEnableOption "the prometheus ${name} exporter"; port = mkOption { type = types.port; default = port; - description = lib.mdDoc '' + description = '' Port to listen on. ''; }; listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = lib.mdDoc '' + description = '' Address to listen on. ''; }; extraFlags = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Extra commandline options to pass to the ${name} exporter. ''; }; openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Open port in firewall for incoming connections. ''; }; @@ -164,7 +164,7 @@ let example = literalExpression '' "-i eth0 -p tcp -m tcp --dport ${toString port}" ''; - description = lib.mdDoc '' + description = '' Specify a filter for iptables to use when {option}`services.prometheus.exporters.${name}.openFirewall` is true. It is used as `ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept`. @@ -176,7 +176,7 @@ let example = literalExpression '' iifname "eth0" tcp dport ${toString port} counter accept ''; - description = lib.mdDoc '' + description = '' Specify rules for nftables to add to the input chain when {option}`services.prometheus.exporters.${name}.openFirewall` is true. ''; @@ -184,14 +184,14 @@ let user = mkOption { type = types.str; default = "${name}-exporter"; - description = lib.mdDoc '' + description = '' User name under which the ${name} exporter shall be run. ''; }; group = mkOption { type = types.str; default = "${name}-exporter"; - description = lib.mdDoc '' + description = '' Group under which the ${name} exporter shall be run. ''; }; @@ -294,7 +294,7 @@ in (lib.mkRenamedOptionModule [ "unifi-poller" ] [ "unpoller" ]) ]; }; - description = lib.mdDoc "Prometheus exporter configuration"; + description = "Prometheus exporter configuration"; default = {}; example = literalExpression '' { diff --git a/nixos/modules/services/monitoring/prometheus/exporters/apcupsd.nix b/nixos/modules/services/monitoring/prometheus/exporters/apcupsd.nix index de6cda18bc374..33a28ba132b8b 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/apcupsd.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/apcupsd.nix @@ -11,7 +11,7 @@ in apcupsdAddress = mkOption { type = types.str; default = ":3551"; - description = lib.mdDoc '' + description = '' Address of the apcupsd Network Information Server (NIS). ''; }; @@ -19,7 +19,7 @@ in apcupsdNetwork = mkOption { type = types.enum ["tcp" "tcp4" "tcp6"]; default = "tcp"; - description = lib.mdDoc '' + description = '' Network of the apcupsd Network Information Server (NIS): one of "tcp", "tcp4", or "tcp6". ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/artifactory.nix b/nixos/modules/services/monitoring/prometheus/exporters/artifactory.nix index b3afdb5966861..306726f47e395 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/artifactory.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/artifactory.nix @@ -11,14 +11,14 @@ in scrapeUri = mkOption { type = types.str; default = "http://localhost:8081/artifactory"; - description = lib.mdDoc '' + description = '' URI on which to scrape JFrog Artifactory. ''; }; artiUsername = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Username for authentication against JFrog Artifactory API. ''; }; @@ -26,7 +26,7 @@ in artiPassword = mkOption { type = types.str; default = ""; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Access token for authentication against JFrog Artifactory API. One of the password or access token needs to be set. ''; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/bind.nix b/nixos/modules/services/monitoring/prometheus/exporters/bind.nix index 100446c1a4ebb..0f3a13900a274 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/bind.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/bind.nix @@ -11,28 +11,28 @@ in bindURI = mkOption { type = types.str; default = "http://localhost:8053/"; - description = lib.mdDoc '' + description = '' HTTP XML API address of an Bind server. ''; }; bindTimeout = mkOption { type = types.str; default = "10s"; - description = lib.mdDoc '' + description = '' Timeout for trying to get stats from Bind. ''; }; bindVersion = mkOption { type = types.enum [ "xml.v2" "xml.v3" "auto" ]; default = "auto"; - description = lib.mdDoc '' + description = '' BIND statistics version. Can be detected automatically. ''; }; bindGroups = mkOption { type = types.listOf (types.enum [ "server" "view" "tasks" ]); default = [ "server" "view" ]; - description = lib.mdDoc '' + description = '' List of statistics to collect. Available: [server, view, tasks] ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/bird.nix b/nixos/modules/services/monitoring/prometheus/exporters/bird.nix index fc52135e3b45e..a020cd3d54b42 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/bird.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/bird.nix @@ -11,21 +11,21 @@ in birdVersion = mkOption { type = types.enum [ 1 2 ]; default = 2; - description = lib.mdDoc '' + description = '' Specifies whether BIRD1 or BIRD2 is in use. ''; }; birdSocket = mkOption { type = types.path; default = "/run/bird/bird.ctl"; - description = lib.mdDoc '' + description = '' Path to BIRD2 (or BIRD1 v4) socket. ''; }; newMetricFormat = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Enable the new more-generic metric format. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/bitcoin.nix b/nixos/modules/services/monitoring/prometheus/exporters/bitcoin.nix index 45f00a04a86c5..b2bea158b07fc 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/bitcoin.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/bitcoin.nix @@ -11,14 +11,14 @@ in rpcUser = mkOption { type = types.str; default = "bitcoinrpc"; - description = lib.mdDoc '' + description = '' RPC user name. ''; }; rpcPasswordFile = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' File containing RPC password. ''; }; @@ -26,7 +26,7 @@ in rpcScheme = mkOption { type = types.enum [ "http" "https" ]; default = "http"; - description = lib.mdDoc '' + description = '' Whether to connect to bitcoind over http or https. ''; }; @@ -34,7 +34,7 @@ in rpcHost = mkOption { type = types.str; default = "localhost"; - description = lib.mdDoc '' + description = '' RPC host. ''; }; @@ -42,7 +42,7 @@ in rpcPort = mkOption { type = types.port; default = 8332; - description = lib.mdDoc '' + description = '' RPC port number. ''; }; @@ -50,7 +50,7 @@ in refreshSeconds = mkOption { type = types.ints.unsigned; default = 300; - description = lib.mdDoc '' + description = '' How often to ask bitcoind for metrics. ''; }; @@ -58,7 +58,7 @@ in extraEnv = mkOption { type = types.attrsOf types.str; default = {}; - description = lib.mdDoc '' + description = '' Extra environment variables for the exporter. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/blackbox.nix b/nixos/modules/services/monitoring/prometheus/exporters/blackbox.nix index e8399e1bec800..80d0cfcc5e451 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/blackbox.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/blackbox.nix @@ -35,14 +35,14 @@ in { extraOpts = { configFile = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' Path to configuration file. ''; }; enableConfigCheck = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' 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. diff --git a/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix b/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix index 6bfadc3b76320..ff1ee6a517b9c 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix @@ -11,7 +11,7 @@ in tokenPath = mkOption { type = types.nullOr types.path; apply = final: if final == null then null else toString final; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' How often to update metrics. ''; }; endpoint = mkOption { type = types.str; default = "https://agent.buildkite.com/v3"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Which specific queues to process. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/collectd.nix b/nixos/modules/services/monitoring/prometheus/exporters/collectd.nix index 3b2b123bbd078..339eb8c3f5f46 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/collectd.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/collectd.nix @@ -9,24 +9,24 @@ in port = 9103; extraOpts = { collectdBinary = { - enable = mkEnableOption (lib.mdDoc "collectd binary protocol receiver"); + enable = mkEnableOption "collectd binary protocol receiver"; authFile = mkOption { default = null; type = types.nullOr types.path; - description = lib.mdDoc "File mapping user names to pre-shared keys (passwords)."; + description = "File mapping user names to pre-shared keys (passwords)."; }; port = mkOption { type = types.port; default = 25826; - description = lib.mdDoc "Network address on which to accept collectd binary network packets."; + description = "Network address on which to accept collectd binary network packets."; }; listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = lib.mdDoc '' + description = '' Address to listen on for binary network packets. ''; }; @@ -34,7 +34,7 @@ in securityLevel = mkOption { type = types.enum ["None" "Sign" "Encrypt"]; default = "None"; - description = lib.mdDoc '' + description = '' Minimum required security level for accepted packets. ''; }; @@ -44,7 +44,7 @@ in type = types.enum [ "logfmt" "json" ]; default = "logfmt"; example = "json"; - description = lib.mdDoc '' + description = '' Set the log format. ''; }; @@ -52,7 +52,7 @@ in logLevel = mkOption { type = types.enum ["debug" "info" "warn" "error" "fatal"]; default = "info"; - description = lib.mdDoc '' + description = '' Only log messages with the given severity or above. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dmarc.nix b/nixos/modules/services/monitoring/prometheus/exporters/dmarc.nix index a4a917b473ce0..0f240cb30bb1d 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dmarc.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dmarc.nix @@ -24,28 +24,28 @@ in { host = mkOption { type = types.str; default = "localhost"; - description = lib.mdDoc '' + description = '' Hostname of IMAP server to connect to. ''; }; port = mkOption { type = types.port; default = 993; - description = lib.mdDoc '' + description = '' Port of the IMAP server to connect to. ''; }; username = mkOption { type = types.str; example = "postmaster@example.org"; - description = lib.mdDoc '' + description = '' Login username for the IMAP connection. ''; }; passwordFile = mkOption { type = types.str; example = "/run/secrets/dovecot_pw"; - description = lib.mdDoc '' + description = '' File containing the login password for the IMAP connection. ''; }; @@ -54,21 +54,21 @@ in { inbox = mkOption { type = types.str; default = "INBOX"; - description = lib.mdDoc '' + description = '' IMAP mailbox that is checked for incoming DMARC aggregate reports ''; }; done = mkOption { type = types.str; default = "Archive"; - description = lib.mdDoc '' + description = '' IMAP mailbox that successfully processed reports are moved to. ''; }; error = mkOption { type = types.str; default = "Invalid"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' How long individual report IDs will be remembered to avoid counting double delivered reports twice. ''; @@ -92,7 +92,7 @@ in { debug = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to declare enable `--debug`. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dnsmasq.nix b/nixos/modules/services/monitoring/prometheus/exporters/dnsmasq.nix index 4cfee7c54a41d..f7ff2665f3d89 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dnsmasq.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dnsmasq.nix @@ -11,7 +11,7 @@ in dnsmasqListenAddress = mkOption { type = types.str; default = "localhost:53"; - description = lib.mdDoc '' + description = '' Address on which dnsmasq listens. ''; }; @@ -19,7 +19,7 @@ in type = types.path; default = "/var/lib/misc/dnsmasq.leases"; example = "/var/lib/dnsmasq/dnsmasq.leases"; - description = lib.mdDoc '' + description = '' Path to the `dnsmasq.leases` file. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix index df6b1ef3200cb..ca02f73729161 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix @@ -11,7 +11,7 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; @@ -19,7 +19,7 @@ in type = types.path; default = "/var/run/dovecot/stats"; example = "/var/run/dovecot2/old-stats"; - description = lib.mdDoc '' + description = '' Path under which the stats socket is placed. The user/group under which the exporter runs, should be able to access the socket in order @@ -67,7 +67,7 @@ in type = types.listOf types.str; default = [ "user" ]; example = [ "user" "global" ]; - description = lib.mdDoc '' + description = '' Stats scopes to query. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/exportarr.nix b/nixos/modules/services/monitoring/prometheus/exporters/exportarr.nix index c632b02902627..45c2c697519cf 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/exportarr.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/exportarr.nix @@ -16,7 +16,7 @@ in url = lib.mkOption { type = lib.types.str; default = "http://127.0.0.1"; - description = lib.mdDoc '' + description = '' The full URL to Sonarr, Radarr, or Lidarr. ''; }; @@ -24,7 +24,7 @@ in apiKeyFile = lib.mkOption { type = lib.types.nullOr lib.types.path; default = null; - description = lib.mdDoc '' + description = '' File containing the api-key. ''; }; @@ -34,7 +34,7 @@ in environment = lib.mkOption { type = lib.types.attrsOf lib.types.str; default = { }; - description = lib.mdDoc '' + description = '' See [the configuration guide](https://github.com/onedr0p/exportarr#configuration) for available options. ''; example = { diff --git a/nixos/modules/services/monitoring/prometheus/exporters/flow.nix b/nixos/modules/services/monitoring/prometheus/exporters/flow.nix index 42292abeada2e..a9e2446d01568 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/flow.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/flow.nix @@ -10,19 +10,19 @@ in { brokers = mkOption { type = types.listOf types.str; example = literalExpression ''[ "kafka.example.org:19092" ]''; - description = lib.mdDoc "List of Kafka brokers to connect to."; + description = "List of Kafka brokers to connect to."; }; asn = mkOption { type = types.ints.positive; example = 65542; - description = lib.mdDoc "The ASN being monitored."; + description = "The ASN being monitored."; }; partitions = mkOption { type = types.listOf types.int; default = []; - description = lib.mdDoc '' + description = '' The number of the partitions to consume, none means all. ''; }; @@ -30,7 +30,7 @@ in { topic = mkOption { type = types.str; example = "pmacct.acct"; - description = lib.mdDoc "The Kafka topic to consume from."; + description = "The Kafka topic to consume from."; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/fritz.nix b/nixos/modules/services/monitoring/prometheus/exporters/fritz.nix index c3a962b576a5b..fcf7e8784f602 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/fritz.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/fritz.nix @@ -1,6 +1,6 @@ { config, lib, pkgs, utils, ... }: let - inherit (lib) mkOption types mdDoc; + inherit (lib) mkOption types; cfg = config.services.prometheus.exporters.fritz; yaml = pkgs.formats.yaml { }; configFile = yaml.generate "fritz-exporter.yaml" cfg.settings; @@ -10,7 +10,7 @@ in extraOpts = { settings = mkOption { - description = mdDoc "Configuration settings for fritz-exporter."; + description = "Configuration settings for fritz-exporter."; type = types.submodule { freeformType = yaml.type; @@ -32,7 +32,7 @@ in log_level = mkOption { type = types.enum [ "DEBUG" "INFO" "WARNING" "ERROR" "CRITICAL" ]; default = "INFO"; - description = mdDoc '' + description = '' Log level to use for the exporter. ''; }; @@ -46,33 +46,33 @@ in name = mkOption { type = types.str; default = ""; - description = mdDoc '' + description = '' Name to use for the device. ''; }; hostname = mkOption { type = types.str; default = "fritz.box"; - description = mdDoc '' + description = '' Hostname under which the target device is reachable. ''; }; username = mkOption { type = types.str; - description = mdDoc '' + description = '' Username to authenticate with the target device. ''; }; password_file = mkOption { type = types.path; - description = mdDoc '' + description = '' Path to a file which contains the password to authenticate with the target device. Needs to be readable by the user the exporter runs under. ''; }; host_info = mkOption { type = types.bool; - description = mdDoc '' + description = '' Enable extended host info for this device. *Warning*: This will heavily increase scrape time. ''; default = false; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/fritzbox.nix b/nixos/modules/services/monitoring/prometheus/exporters/fritzbox.nix index 7b881a8e2693c..fe1d1834570ac 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/fritzbox.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/fritzbox.nix @@ -11,7 +11,7 @@ in gatewayAddress = mkOption { type = types.str; default = "fritz.box"; - description = lib.mdDoc '' + description = '' The hostname or IP of the FRITZ!Box. ''; }; @@ -19,7 +19,7 @@ in gatewayPort = mkOption { type = types.int; default = 49000; - description = lib.mdDoc '' + description = '' The port of the FRITZ!Box UPnP service. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/graphite.nix b/nixos/modules/services/monitoring/prometheus/exporters/graphite.nix index 07c06afe14094..523a720425c03 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/graphite.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/graphite.nix @@ -10,7 +10,7 @@ in graphitePort = lib.mkOption { type = lib.types.port; default = 9109; - description = lib.mdDoc '' + description = '' Port to use for the graphite server. ''; }; @@ -20,7 +20,7 @@ in options = { }; }; default = { }; - description = lib.mdDoc '' + description = '' Mapping configuration for the exporter, see <https://github.com/prometheus/graphite_exporter#yaml-config> for available options. diff --git a/nixos/modules/services/monitoring/prometheus/exporters/idrac.nix b/nixos/modules/services/monitoring/prometheus/exporters/idrac.nix index 78ae4826215ce..3d1123e18a32d 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/idrac.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/idrac.nix @@ -15,7 +15,7 @@ in type = with types; nullOr path; default = null; example = "/etc/prometheus-idrac-exporter/idrac.yml"; - description = lib.mdDoc '' + description = '' 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. @@ -27,7 +27,7 @@ in }; configuration = mkOption { type = types.nullOr types.attrs; - description = lib.mdDoc '' + description = '' Configuration for iDRAC exporter, as a nix attribute set. Configuration reference: https://github.com/mrlhansen/idrac_exporter/#configuration diff --git a/nixos/modules/services/monitoring/prometheus/exporters/imap-mailstat.nix b/nixos/modules/services/monitoring/prometheus/exporters/imap-mailstat.nix index 68fc63e40fcd1..c1e2a458f97b3 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/imap-mailstat.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/imap-mailstat.nix @@ -22,7 +22,7 @@ let mkOpt = type: description: mkOption { type = types.nullOr type; default = null; - description = lib.mdDoc description; + description = description; }; accountOptions.options = { mailaddress = mkOpt types.str "Your email address (at the moment used as login name)"; @@ -39,21 +39,21 @@ in oldestUnseenDate = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable metric with timestamp of oldest unseen mail ''; }; accounts = mkOption { type = types.attrsOf (types.submodule accountOptions); default = {}; - description = lib.mdDoc '' + description = '' Accounts to monitor ''; }; configurationFile = mkOption { type = types.path; example = "/path/to/config-file"; - description = lib.mdDoc '' + description = '' File containing the configuration ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/influxdb.nix b/nixos/modules/services/monitoring/prometheus/exporters/influxdb.nix index d0d7f16bdadf3..9ac0c35bf816f 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/influxdb.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/influxdb.nix @@ -12,13 +12,13 @@ in type = types.str; default = "5m"; example = "10m"; - description = lib.mdDoc "How long a sample is valid for"; + description = "How long a sample is valid for"; }; udpBindAddress = mkOption { type = types.str; default = ":9122"; example = "192.0.2.1:9122"; - description = lib.mdDoc "Address on which to listen for udp packets"; + description = "Address on which to listen for udp packets"; }; }; serviceOpts = { diff --git a/nixos/modules/services/monitoring/prometheus/exporters/ipmi.nix b/nixos/modules/services/monitoring/prometheus/exporters/ipmi.nix index fe9734d33c7c7..a51c09d5086c0 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/ipmi.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/ipmi.nix @@ -12,7 +12,7 @@ in { configFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Path to configuration file. ''; }; @@ -20,7 +20,7 @@ in { webConfigFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Path to configuration file that can enable TLS or authentication. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/jitsi.nix b/nixos/modules/services/monitoring/prometheus/exporters/jitsi.nix index bc670ba9cc0e6..f6c2d9172f4c4 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/jitsi.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/jitsi.nix @@ -11,7 +11,7 @@ in url = mkOption { type = types.str; default = "http://localhost:8080/colibri/stats"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' How often to scrape new data ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/json.nix b/nixos/modules/services/monitoring/prometheus/exporters/json.nix index 7f78985d80cd4..1e4632f9310eb 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/json.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/json.nix @@ -10,7 +10,7 @@ in extraOpts = { configFile = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' Path to configuration file. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/junos-czerwonk.nix b/nixos/modules/services/monitoring/prometheus/exporters/junos-czerwonk.nix index 72119d17fcb71..75b8bb650478a 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/junos-czerwonk.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/junos-czerwonk.nix @@ -15,21 +15,21 @@ in environmentFile = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' File containing env-vars to be substituted into the exporter's config. ''; }; configurationFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Specify the JunOS exporter configuration file to use. ''; }; configuration = mkOption { type = types.nullOr types.attrs; default = null; - description = lib.mdDoc '' + description = '' JunOS exporter configuration as nix attribute set. Mutually exclusive with the `configurationFile` option. ''; example = { @@ -44,7 +44,7 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/kea.nix b/nixos/modules/services/monitoring/prometheus/exporters/kea.nix index ccfdd98b8db93..88dc284a8cc63 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/kea.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/kea.nix @@ -24,7 +24,7 @@ in { "http://127.0.0.1:8547" ] ''; - description = lib.mdDoc '' + description = '' Paths or URLs to the Kea control socket. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/knot.nix b/nixos/modules/services/monitoring/prometheus/exporters/knot.nix index 0352aff8b0135..79d952dfb1641 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/knot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/knot.nix @@ -11,7 +11,7 @@ in { type = types.nullOr types.str; default = null; example = literalExpression ''"''${pkgs.knot-dns.out}/lib/libknot.so"''; - description = lib.mdDoc '' + description = '' Path to the library of `knot-dns`. ''; }; @@ -19,7 +19,7 @@ in { knotSocketPath = mkOption { type = types.str; default = "/run/knot/knot.sock"; - description = lib.mdDoc '' + description = '' Socket path of {manpage}`knotd(8)`. ''; }; @@ -27,7 +27,7 @@ in { knotSocketTimeout = mkOption { type = types.ints.positive; default = 2000; - description = lib.mdDoc '' + description = '' Timeout in seconds. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/lnd.nix b/nixos/modules/services/monitoring/prometheus/exporters/lnd.nix index 66d9c02f904b7..cc8db6e1b4e43 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/lnd.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/lnd.nix @@ -11,21 +11,21 @@ in lndHost = mkOption { type = types.str; default = "localhost:10009"; - description = lib.mdDoc '' + description = '' lnd instance gRPC address:port. ''; }; lndTlsPath = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' Path to lnd TLS certificate. ''; }; lndMacaroonDir = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' Path to lnd macaroons. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/mail.nix b/nixos/modules/services/monitoring/prometheus/exporters/mail.nix index 8c88f47ab86a0..7ace5c1968fb1 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/mail.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/mail.nix @@ -22,41 +22,41 @@ let serverOptions.options = { name = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Value for label 'configname' which will be added to all metrics. ''; }; server = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Hostname of the server that should be probed. ''; }; port = mkOption { type = types.port; example = 587; - description = lib.mdDoc '' + description = '' Port to use for SMTP. ''; }; from = mkOption { type = types.str; example = "exporteruser@domain.tld"; - description = lib.mdDoc '' + description = '' Content of 'From' Header for probing mails. ''; }; to = mkOption { type = types.str; example = "exporteruser@domain.tld"; - description = lib.mdDoc '' + description = '' Content of 'To' Header for probing mails. ''; }; detectionDir = mkOption { type = types.path; example = "/var/spool/mail/exporteruser/new"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Username to use for SMTP authentication. ''; }; passphrase = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Password to use for SMTP authentication. ''; }; @@ -82,20 +82,20 @@ let monitoringInterval = mkOption { type = types.str; example = "10s"; - description = lib.mdDoc '' + description = '' Time interval between two probe attempts. ''; }; mailCheckTimeout = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Timeout until mails are considered "didn't make it". ''; }; disableFileDeletion = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Disables the exporter's function to delete probing mails. ''; }; @@ -112,7 +112,7 @@ let detectionDir = "/path/to/Maildir/new"; } ] ''; - description = lib.mdDoc '' + description = '' List of servers that should be probed. *Note:* if your mailserver has {manpage}`rspamd(8)` configured, @@ -141,28 +141,28 @@ in environmentFile = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' File containing env-vars to be substituted into the exporter's config. ''; }; configFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Specify the mailexporter configuration file to use. ''; }; configuration = mkOption { type = types.nullOr (types.submodule exporterOptions); default = null; - description = lib.mdDoc '' + description = '' Specify the mailexporter configuration file to use. ''; }; telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nix b/nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nix index a8dba75251d83..9e0a98f0ba64f 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nix @@ -11,7 +11,7 @@ in configFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Path to a mikrotik exporter configuration file. Mutually exclusive with {option}`configuration` option. ''; @@ -21,7 +21,7 @@ in configuration = mkOption { type = types.nullOr types.attrs; default = null; - description = lib.mdDoc '' + description = '' Mikrotik exporter configuration as nix attribute set. Mutually exclusive with {option}`configFile` option. diff --git a/nixos/modules/services/monitoring/prometheus/exporters/minio.nix b/nixos/modules/services/monitoring/prometheus/exporters/minio.nix index e24d4f766e30e..e1edd364c8fcb 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/minio.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/minio.nix @@ -11,7 +11,7 @@ in minioAddress = mkOption { type = types.str; example = "https://10.0.0.1:9000"; - description = lib.mdDoc '' + description = '' 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,7 +21,7 @@ in minioAccessKey = mkOption { type = types.str; example = "yourMinioAccessKey"; - description = lib.mdDoc '' + description = '' 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 @@ -31,7 +31,7 @@ in minioAccessSecret = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' 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 @@ -42,7 +42,7 @@ in minioBucketStats = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Collect statistics about the buckets and files in buckets. It requires more computation, use it carefully in case of large buckets.. ''; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/modemmanager.nix b/nixos/modules/services/monitoring/prometheus/exporters/modemmanager.nix index 0eb193c0021f2..37a2daebd9739 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/modemmanager.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/modemmanager.nix @@ -11,7 +11,7 @@ in refreshRate = mkOption { type = types.str; default = "5s"; - description = lib.mdDoc '' + description = '' 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"). diff --git a/nixos/modules/services/monitoring/prometheus/exporters/mongodb.nix b/nixos/modules/services/monitoring/prometheus/exporters/mongodb.nix index 1ed6bbf0325d8..10d533a2bbdad 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/mongodb.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/mongodb.nix @@ -12,13 +12,13 @@ in type = types.str; default = "mongodb://localhost:27017/test"; example = "mongodb://localhost:27017/test"; - description = lib.mdDoc "MongoDB URI to connect to."; + description = "MongoDB URI to connect to."; }; collStats = mkOption { type = types.listOf types.str; default = [ ]; example = [ "db1.coll1" "db2" ]; - description = lib.mdDoc '' + description = '' List of comma separared databases.collections to get $collStats ''; }; @@ -26,7 +26,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "db1.coll1" "db2" ]; - description = lib.mdDoc '' + description = '' List of comma separared databases.collections to get $indexStats ''; }; @@ -34,12 +34,12 @@ in type = types.listOf types.str; default = [ ]; example = [ "diagnosticdata" "replicasetstatus" "dbstats" "topmetrics" "currentopmetrics" "indexstats" "dbstats" "profile" ]; - description = lib.mdDoc "Enabled collectors"; + description = "Enabled collectors"; }; collectAll = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable all collectors. Same as specifying all --collector.<name> ''; }; @@ -47,7 +47,7 @@ in type = types.str; default = "/metrics"; example = "/metrics"; - description = lib.mdDoc "Metrics expose path"; + description = "Metrics expose path"; }; }; serviceOpts = { diff --git a/nixos/modules/services/monitoring/prometheus/exporters/mysqld.nix b/nixos/modules/services/monitoring/prometheus/exporters/mysqld.nix index c6da052ccdf30..5b2c2274f0539 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/mysqld.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/mysqld.nix @@ -1,14 +1,14 @@ { config, lib, pkgs, options, ... }: let cfg = config.services.prometheus.exporters.mysqld; - inherit (lib) types mkOption mdDoc mkIf mkForce cli concatStringsSep optionalString escapeShellArgs; + inherit (lib) types mkOption mkIf mkForce cli concatStringsSep optionalString escapeShellArgs; in { port = 9104; extraOpts = { telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = mdDoc '' + description = '' Path under which to expose metrics. ''; }; @@ -16,7 +16,7 @@ in { runAsLocalSuperUser = mkOption { type = types.bool; default = false; - description = mdDoc '' + description = '' Whether to run the exporter as {option}`services.mysql.user`. ''; }; @@ -24,7 +24,7 @@ in { configFile = mkOption { type = types.path; example = "/var/lib/prometheus-mysqld-exporter.cnf"; - description = mdDoc '' + description = '' Path to the services config file. See <https://github.com/prometheus/mysqld_exporter#running> for more information about diff --git a/nixos/modules/services/monitoring/prometheus/exporters/nextcloud.nix b/nixos/modules/services/monitoring/prometheus/exporters/nextcloud.nix index 82deea6864e8f..f22c5e2e5cff1 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/nextcloud.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/nextcloud.nix @@ -11,7 +11,7 @@ in url = mkOption { type = types.str; example = "https://domain.tld"; - description = lib.mdDoc '' + description = '' URL to the Nextcloud serverinfo page. Adding the path to the serverinfo API is optional, it defaults to `/ocs/v2.php/apps/serverinfo/api/v1/info`. @@ -20,7 +20,7 @@ in username = mkOption { type = types.str; default = "nextcloud-exporter"; - description = lib.mdDoc '' + description = '' Username for connecting to Nextcloud. Note that this account needs to have admin privileges in Nextcloud. Unused when using token authentication. @@ -30,7 +30,7 @@ in type = types.nullOr types.path; default = null; example = "/path/to/password-file"; - description = lib.mdDoc '' + description = '' File containing the password for connecting to Nextcloud. Make sure that this file is readable by the exporter user. ''; @@ -39,7 +39,7 @@ in type = types.nullOr types.path; default = null; example = "/path/to/token-file"; - description = lib.mdDoc '' + description = '' File containing the token for connecting to Nextcloud. Make sure that this file is readable by the exporter user. ''; @@ -47,7 +47,7 @@ in timeout = mkOption { type = types.str; default = "5s"; - description = lib.mdDoc '' + description = '' Timeout for getting server info document. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/nginx.nix b/nixos/modules/services/monitoring/prometheus/exporters/nginx.nix index 339749226aa45..d4939c7063a39 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/nginx.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/nginx.nix @@ -11,7 +11,7 @@ in scrapeUri = mkOption { type = types.str; default = "http://localhost/nginx_status"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; sslVerify = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to perform certificate verification for https. ''; }; @@ -37,7 +37,7 @@ in "label1=value1" "label2=value2" ]; - description = lib.mdDoc '' + description = '' A list of constant labels that will be used in every metric. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix b/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix index b79a034e1384e..ebb13a8c3ee3b 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix @@ -10,7 +10,7 @@ in { settings = mkOption { type = types.attrs; default = {}; - description = lib.mdDoc '' + description = '' All settings of nginxlog expressed as an Nix attrset. Check the official documentation for the corresponding YAML @@ -24,7 +24,7 @@ in { metricsEndpoint = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/node.nix b/nixos/modules/services/monitoring/prometheus/exporters/node.nix index 9b8a0d2c6bc27..8615bd04951cc 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/node.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/node.nix @@ -14,7 +14,7 @@ in type = types.listOf types.str; default = []; example = [ "systemd" ]; - description = lib.mdDoc '' + description = '' Collectors to enable. The collectors listed here are enabled in addition to the default ones. ''; }; @@ -22,7 +22,7 @@ in type = types.listOf types.str; default = []; example = [ "timex" ]; - description = lib.mdDoc '' + description = '' Collectors to disable which are enabled by default. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/nut.nix b/nixos/modules/services/monitoring/prometheus/exporters/nut.nix index a14e379079b07..e88059cea4396 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/nut.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/nut.nix @@ -11,7 +11,7 @@ in nutServer = mkOption { type = types.str; default = "127.0.0.1"; - description = lib.mdDoc '' + description = '' Hostname or address of the NUT server ''; }; @@ -19,7 +19,7 @@ in type = types.str; default = ""; example = "nut"; - description = lib.mdDoc '' + description = '' The user to log in into NUT server. If set, passwordPath should also be set. @@ -31,7 +31,7 @@ in type = types.nullOr types.path; default = null; apply = final: if final == null then null else toString final; - description = lib.mdDoc '' + description = '' A run-time path to the nutUser password file, which should be provisioned outside of Nix store. ''; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix b/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix index aee3ae5bb2d4c..9c1b39bb3a349 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix @@ -10,7 +10,7 @@ in { ldapCredentialFile = mkOption { type = types.path; example = "/run/keys/ldap_pass"; - description = lib.mdDoc '' + description = '' Environment file to contain the credentials to authenticate against `openldap`. @@ -26,21 +26,21 @@ in { default = "tcp"; example = "udp"; type = types.str; - description = lib.mdDoc '' + description = '' Which protocol to use to connect against `openldap`. ''; }; ldapAddr = mkOption { default = "localhost:389"; type = types.str; - description = lib.mdDoc '' + description = '' Address of the `openldap`-instance. ''; }; metricsPath = mkOption { default = "/metrics"; type = types.str; - description = lib.mdDoc '' + description = '' URL path where metrics should be exposed. ''; }; @@ -48,7 +48,7 @@ in { default = "30s"; type = types.str; example = "1m"; - description = lib.mdDoc '' + description = '' Scrape interval of the exporter. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/pgbouncer.nix b/nixos/modules/services/monitoring/prometheus/exporters/pgbouncer.nix index 9587403c78023..725a5679e271f 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/pgbouncer.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/pgbouncer.nix @@ -12,7 +12,7 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; @@ -21,7 +21,7 @@ in type = types.str; default = ""; example = "postgres://admin:@localhost:6432/pgbouncer?sslmode=require"; - description = lib.mdDoc '' + description = '' Connection string for accessing pgBouncer. NOTE: You MUST keep pgbouncer as database name (special internal db)!!! @@ -38,7 +38,7 @@ in type = types.nullOr types.path; default = null; example = "/run/keys/pgBouncer-connection-string"; - description = lib.mdDoc '' + description = '' File that contains pgBouncer connection string in format: postgres://admin:@localhost:6432/pgbouncer?sslmode=require @@ -54,7 +54,7 @@ in pidFile = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Path to PgBouncer pid file. If provided, the standard process metrics get exported for the PgBouncer @@ -70,7 +70,7 @@ in webSystemdSocket = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Use systemd socket activation listeners instead of port listeners (Linux only). ''; }; @@ -78,7 +78,7 @@ in logLevel = mkOption { type = types.enum ["debug" "info" "warn" "error" ]; default = "info"; - description = lib.mdDoc '' + description = '' Only log messages with the given severity or above. ''; }; @@ -86,7 +86,7 @@ in logFormat = mkOption { type = types.enum ["logfmt" "json"]; default = "logfmt"; - description = lib.mdDoc '' + description = '' Output format of log messages. One of: [logfmt, json] ''; }; @@ -94,7 +94,7 @@ in webConfigFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Path to configuration file that can enable TLS or authentication. ''; }; @@ -102,7 +102,7 @@ in extraFlags = mkOption { type = types.listOf types.str; default = [ ]; - description = lib.mdDoc '' + description = '' Extra commandline options when launching Prometheus. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/php-fpm.nix b/nixos/modules/services/monitoring/prometheus/exporters/php-fpm.nix index 4ea5f64012c08..5d8253f26c436 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/php-fpm.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/php-fpm.nix @@ -16,7 +16,7 @@ in { telemetryPath = lib.mkOption { type = lib.types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; @@ -25,7 +25,7 @@ in { type = lib.types.nullOr lib.types.path; default = null; example = "/root/prometheus-php-fpm-exporter.env"; - description = lib.mdDoc '' + description = '' Environment file as defined in {manpage}`systemd.exec(5)`. Secrets may be passed to the service without adding them to the diff --git a/nixos/modules/services/monitoring/prometheus/exporters/pihole.nix b/nixos/modules/services/monitoring/prometheus/exporters/pihole.nix index 4b7eca7493a69..926626b5e7979 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/pihole.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/pihole.nix @@ -17,7 +17,7 @@ in type = types.str; default = ""; example = "580a770cb40511eb85290242ac130003580a770cb40511eb85290242ac130003"; - description = lib.mdDoc '' + description = '' Pi-Hole API token which can be used instead of a password ''; }; @@ -25,7 +25,7 @@ in type = types.str; default = ""; example = "password"; - description = lib.mdDoc '' + description = '' The password to login into Pi-Hole. An api token can be used instead. ''; }; @@ -33,7 +33,7 @@ in type = types.str; default = "pihole"; example = "127.0.0.1"; - description = lib.mdDoc '' + description = '' Hostname or address where to find the Pi-Hole webinterface ''; }; @@ -41,7 +41,7 @@ in type = types.port; default = 80; example = 443; - description = lib.mdDoc '' + description = '' The port Pi-Hole webinterface is reachable on ''; }; @@ -49,14 +49,14 @@ in type = types.enum [ "http" "https" ]; default = "http"; example = "https"; - description = lib.mdDoc '' + description = '' The protocol which is used to connect to Pi-Hole ''; }; timeout = mkOption { type = types.str; default = "5s"; - description = lib.mdDoc '' + description = '' Controls the timeout to connect to a Pi-Hole instance ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/ping.nix b/nixos/modules/services/monitoring/prometheus/exporters/ping.nix index bda5038a0c64a..a47db4c16f427 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/ping.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/ping.nix @@ -23,7 +23,7 @@ in type = settingsFormat.type; default = {}; - description = lib.mdDoc '' + description = '' Configuration for ping_exporter, see <https://github.com/czerwonk/ping_exporter> for supported values. diff --git a/nixos/modules/services/monitoring/prometheus/exporters/postfix.nix b/nixos/modules/services/monitoring/prometheus/exporters/postfix.nix index ead8e806f85a8..188a5f9a1a14a 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/postfix.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/postfix.nix @@ -10,7 +10,7 @@ in extraOpts = { group = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Group under which the postfix exporter shall be run. It should match the group that is allowed to access the `showq` socket in the `queue/public/` directory. @@ -20,7 +20,7 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Path where Postfix places its showq socket. ''; }; @@ -45,21 +45,21 @@ in enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable reading metrics from the systemd journal instead of from a logfile ''; }; unit = mkOption { type = types.str; default = "postfix.service"; - description = lib.mdDoc '' + description = '' Name of the postfix systemd unit. ''; }; slice = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Name of the postfix systemd slice. This overrides the {option}`systemd.unit`. ''; @@ -67,7 +67,7 @@ in journalPath = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Path to the systemd journal. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/postgres.nix b/nixos/modules/services/monitoring/prometheus/exporters/postgres.nix index 514b2d0c8f2d9..7ed71ff9e10e9 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/postgres.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/postgres.nix @@ -11,7 +11,7 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' Accepts PostgreSQL URI form and key=value form arguments. ''; }; runAsLocalSuperUser = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to run the exporter as the local 'postgres' super user. ''; }; @@ -36,7 +36,7 @@ in type = types.nullOr types.path; default = null; example = "/root/prometheus-postgres-exporter.env"; - description = lib.mdDoc '' + description = '' Environment file as defined in {manpage}`systemd.exec(5)`. Secrets may be passed to the service without adding them to the diff --git a/nixos/modules/services/monitoring/prometheus/exporters/process.nix b/nixos/modules/services/monitoring/prometheus/exporters/process.nix index 86c71a88e28b0..b041a957b6387 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/process.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/process.nix @@ -18,7 +18,7 @@ in { name = "{{.Matches.Wrapped}} {{ .Matches.Args }}"; cmdline = [ "^/nix/store[^ ]*/(?P<Wrapped>[^ /]*) (?P<Args>.*)" ]; } ] ''; - description = lib.mdDoc '' + description = '' All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML diff --git a/nixos/modules/services/monitoring/prometheus/exporters/py-air-control.nix b/nixos/modules/services/monitoring/prometheus/exporters/py-air-control.nix index 60243e0ed0694..66a8423f8ff5c 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/py-air-control.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/py-air-control.nix @@ -14,14 +14,14 @@ in deviceHostname = mkOption { type = types.str; example = "192.168.1.123"; - description = lib.mdDoc '' + description = '' The hostname of the air purification device from which to scrape the metrics. ''; }; protocol = mkOption { type = types.str; default = "http"; - description = lib.mdDoc '' + description = '' The protocol to use when communicating with the air purification device. Available: [http, coap, plain_coap] ''; @@ -29,7 +29,7 @@ in stateDir = mkOption { type = types.str; default = "prometheus-py-air-control-exporter"; - description = lib.mdDoc '' + description = '' Directory below `/var/lib` to store runtime data. This directory will be created automatically using systemd's StateDirectory mechanism. ''; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/restic.nix b/nixos/modules/services/monitoring/prometheus/exporters/restic.nix index 12962af5f111f..aaf3c189a4d20 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/restic.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/restic.nix @@ -10,7 +10,7 @@ in extraOpts = { repository = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' URI pointing to the repository to monitor. ''; example = "sftp:backup@192.168.1.100:/backups/example"; @@ -18,7 +18,7 @@ in passwordFile = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' File containing the password to the repository. ''; example = "/etc/nixos/restic-password"; @@ -27,7 +27,7 @@ in environmentFile = mkOption { type = with types; nullOr path; default = null; - description = lib.mdDoc '' + description = '' File containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5) ''; @@ -36,7 +36,7 @@ in refreshInterval = mkOption { type = types.ints.unsigned; default = 60; - description = lib.mdDoc '' + description = '' Refresh interval for the metrics in seconds. Computing the metrics is an expensive task, keep this value as high as possible. ''; @@ -45,7 +45,7 @@ in rcloneOptions = mkOption { type = with types; attrsOf (oneOf [ str bool ]); default = { }; - description = lib.mdDoc '' + description = '' Options to pass to rclone to control its behavior. See <https://rclone.org/docs/#options> for available options. When specifying option names, strip the @@ -58,7 +58,7 @@ in rcloneConfig = mkOption { type = with types; attrsOf (oneOf [ str bool ]); default = { }; - description = lib.mdDoc '' + description = '' Configuration for the rclone remote being used for backup. See the remote's specific options under rclone's docs at <https://rclone.org/docs/>. When specifying @@ -79,7 +79,7 @@ in rcloneConfigFile = mkOption { type = with types; nullOr path; default = null; - description = lib.mdDoc '' + description = '' Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. diff --git a/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix b/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix index 8169d4075a9f4..ee8047fb4599d 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix @@ -69,7 +69,7 @@ in custom_label = "some_value"; } ''; - description = lib.mdDoc "Set of labels added to each metric."; + description = "Set of labels added to each metric."; }; }; serviceOpts.serviceConfig.ExecStart = '' diff --git a/nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix b/nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix index 42b659501161c..02624a0e80e76 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix @@ -12,15 +12,15 @@ in options = { name = lib.mkOption { type = str; - description = lib.mdDoc "Name to match."; + description = "Name to match."; }; "${field}" = lib.mkOption { type = int; - description = lib.mdDoc description; + description = description; }; location = lib.mkOption { type = str; - description = lib.mdDoc "Location to match."; + description = "Location to match."; }; }; }); @@ -30,7 +30,7 @@ in type = lib.types.str; default = "-C si"; example = "-C si -R 19"; - description = lib.mdDoc '' + description = '' Flags passed verbatim to rtl_433 binary. Having `-C si` (the default) is recommended since only Celsius temperatures are parsed. ''; @@ -41,7 +41,7 @@ in example = [ { name = "Acurite"; channel = 6543; location = "Kitchen"; } ]; - description = lib.mdDoc '' + description = '' List of channel matchers to export. ''; }; @@ -51,7 +51,7 @@ in example = [ { name = "Nexus"; id = 1; location = "Bedroom"; } ]; - description = lib.mdDoc '' + description = '' List of ID matchers to export. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/scaphandre.nix b/nixos/modules/services/monitoring/prometheus/exporters/scaphandre.nix index d4c929d88b9c8..fbee2850db744 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/scaphandre.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/scaphandre.nix @@ -14,7 +14,7 @@ in { telemetryPath = lib.mkOption { type = lib.types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/script.nix b/nixos/modules/services/monitoring/prometheus/exporters/script.nix index f37fa456d27c5..5fe8512f554e7 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/script.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/script.nix @@ -15,18 +15,18 @@ in name = mkOption { type = str; example = "sleep"; - description = lib.mdDoc "Name of the script."; + description = "Name of the script."; }; script = mkOption { type = str; example = "sleep 5"; - description = lib.mdDoc "Shell script to execute when metrics are requested."; + description = "Shell script to execute when metrics are requested."; }; timeout = mkOption { type = nullOr int; default = null; example = 60; - description = lib.mdDoc "Optional timeout for the script in seconds."; + description = "Optional timeout for the script in seconds."; }; }; }); @@ -37,7 +37,7 @@ in ]; } ''; - description = lib.mdDoc '' + description = '' All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML diff --git a/nixos/modules/services/monitoring/prometheus/exporters/shelly.nix b/nixos/modules/services/monitoring/prometheus/exporters/shelly.nix index 1d2329dfbae18..5b3cf10b650b0 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/shelly.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/shelly.nix @@ -10,7 +10,7 @@ in extraOpts = { metrics-file = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' Path to the JSON file with the metric definitions ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/smartctl.nix b/nixos/modules/services/monitoring/prometheus/exporters/smartctl.nix index 1040e9ecadbd5..84658c48c7239 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/smartctl.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/smartctl.nix @@ -20,7 +20,7 @@ in { example = literalExpression '' [ "/dev/sda", "/dev/nvme0n1" ]; ''; - description = lib.mdDoc '' + description = '' Paths to the disks that will be monitored. Will autodiscover all disks if none given. ''; @@ -29,7 +29,7 @@ in { type = types.str; default = "60s"; example = "2m"; - description = lib.mdDoc '' + description = '' Interval that limits how often a disk can be queried. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/smokeping.nix b/nixos/modules/services/monitoring/prometheus/exporters/smokeping.nix index 2bacc9cd7cac8..79ed5129dda4d 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/smokeping.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/smokeping.nix @@ -17,27 +17,27 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; pingInterval = mkOption { type = goDuration; default = "1s"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' List of buckets to use for the response duration histogram. ''; }; hosts = mkOption { type = with types; listOf str; - description = lib.mdDoc '' + description = '' List of endpoints to probe. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/snmp.nix b/nixos/modules/services/monitoring/prometheus/exporters/snmp.nix index 207446e39f49b..19ab31d735f86 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/snmp.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/snmp.nix @@ -31,7 +31,7 @@ in configurationPath = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Path to a snmp exporter configuration file. Mutually exclusive with 'configuration' option. ''; example = literalExpression "./snmp.yml"; @@ -40,7 +40,7 @@ in configuration = mkOption { type = types.nullOr types.attrs; default = null; - description = lib.mdDoc '' + description = '' Snmp exporter configuration as nix attribute set. Mutually exclusive with 'configurationPath' option. ''; example = { @@ -54,7 +54,7 @@ in enableConfigCheck = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' 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. @@ -64,7 +64,7 @@ in logFormat = mkOption { type = types.enum ["logfmt" "json"]; default = "logfmt"; - description = lib.mdDoc '' + description = '' Output format of log messages. ''; }; @@ -72,7 +72,7 @@ in logLevel = mkOption { type = types.enum ["debug" "info" "warn" "error"]; default = "info"; - description = lib.mdDoc '' + description = '' Only log messages with the given severity or above. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/sql.nix b/nixos/modules/services/monitoring/prometheus/exporters/sql.nix index dbfa69678a0c9..4c4d8f880364a 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/sql.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/sql.nix @@ -7,7 +7,7 @@ let jobs = mkOption { type = attrsOf (submodule jobOptions); default = { }; - description = lib.mdDoc "An attrset of metrics scraping jobs to run."; + description = "An attrset of metrics scraping jobs to run."; }; }; }; @@ -15,23 +15,23 @@ let options = with types; { interval = mkOption { type = str; - description = lib.mdDoc '' + description = '' How often to run this job, specified in [Go duration](https://golang.org/pkg/time/#ParseDuration) format. ''; }; connections = mkOption { type = listOf str; - description = lib.mdDoc "A list of connection strings of the SQL servers to scrape metrics from"; + description = "A list of connection strings of the SQL servers to scrape metrics from"; }; startupSql = mkOption { type = listOf str; default = []; - description = lib.mdDoc "A list of SQL statements to execute once after making a connection."; + description = "A list of SQL statements to execute once after making a connection."; }; queries = mkOption { type = attrsOf (submodule queryOptions); - description = lib.mdDoc "SQL queries to run."; + description = "SQL queries to run."; }; }; }; @@ -40,20 +40,20 @@ let help = mkOption { type = nullOr str; default = null; - description = lib.mdDoc "A human-readable description of this metric."; + description = "A human-readable description of this metric."; }; labels = mkOption { type = listOf str; default = [ ]; - description = lib.mdDoc "A set of columns that will be used as Prometheus labels."; + description = "A set of columns that will be used as Prometheus labels."; }; query = mkOption { type = str; - description = lib.mdDoc "The SQL query to run."; + description = "The SQL query to run."; }; values = mkOption { type = listOf str; - description = lib.mdDoc "A set of columns that will be used as values of this metric."; + description = "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 = lib.mdDoc '' + description = '' Path to configuration file. ''; }; configuration = mkOption { type = with types; nullOr (submodule cfgOptions); default = null; - description = lib.mdDoc '' + description = '' Exporter configuration as nix attribute set. Mutually exclusive with 'configFile' option. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/surfboard.nix b/nixos/modules/services/monitoring/prometheus/exporters/surfboard.nix index 337ebd4ed66fe..0e16d27b9d042 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/surfboard.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/surfboard.nix @@ -11,7 +11,7 @@ in modemAddress = mkOption { type = types.str; default = "192.168.100.1"; - description = lib.mdDoc '' + description = '' The hostname or IP of the cable modem. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/tor.nix b/nixos/modules/services/monitoring/prometheus/exporters/tor.nix index b91f69aded3d5..48406def98944 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/tor.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/tor.nix @@ -11,7 +11,7 @@ in torControlAddress = mkOption { type = types.str; default = "127.0.0.1"; - description = lib.mdDoc '' + description = '' Tor control IP address or hostname. ''; }; @@ -19,7 +19,7 @@ in torControlPort = mkOption { type = types.port; default = 9051; - description = lib.mdDoc '' + description = '' Tor control port. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/unbound.nix b/nixos/modules/services/monitoring/prometheus/exporters/unbound.nix index 2f4444a96c694..0452f630c2e2f 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/unbound.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/unbound.nix @@ -22,7 +22,7 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; @@ -59,7 +59,7 @@ in type = types.str; default = "tcp://127.0.0.1:8953"; example = "unix:///run/unbound/unbound.socket"; - description = lib.mdDoc '' + description = '' Path to the unbound control socket. Supports unix domain sockets, as well as the TCP interface. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/unifi.nix b/nixos/modules/services/monitoring/prometheus/exporters/unifi.nix index b7addcd568270..82309febf63b8 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/unifi.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/unifi.nix @@ -11,7 +11,7 @@ in unifiAddress = mkOption { type = types.str; example = "https://10.0.0.1:8443"; - description = lib.mdDoc '' + description = '' URL of the UniFi Controller API. ''; }; @@ -19,7 +19,7 @@ in unifiInsecure = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' username for authentication against UniFi Controller API. ''; }; unifiPassword = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Password for authentication against UniFi Controller API. ''; }; @@ -44,7 +44,7 @@ in type = types.str; default = "5s"; example = "2m"; - description = lib.mdDoc '' + description = '' Timeout including unit for UniFi Controller API requests. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/unpoller.nix b/nixos/modules/services/monitoring/prometheus/exporters/unpoller.nix index aff1197a8775e..0ea824fbf1140 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/unpoller.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/unpoller.nix @@ -24,9 +24,9 @@ in { inherit (options.services.unpoller.unifi) controllers; inherit (options.services.unpoller) loki; log = { - debug = mkEnableOption (lib.mdDoc "debug logging including line numbers, high resolution timestamps, per-device logs"); - quiet = mkEnableOption (lib.mdDoc "startup and error logs only"); - prometheusErrors = mkEnableOption (lib.mdDoc "emitting errors to prometheus"); + debug = mkEnableOption "debug logging including line numbers, high resolution timestamps, per-device logs"; + quiet = mkEnableOption "startup and error logs only"; + prometheusErrors = mkEnableOption "emitting errors to prometheus"; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/v2ray.nix b/nixos/modules/services/monitoring/prometheus/exporters/v2ray.nix index 7b21e5fc7cb7b..1582554c12531 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/v2ray.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/v2ray.nix @@ -11,7 +11,7 @@ in v2rayEndpoint = mkOption { type = types.str; default = "127.0.0.1:54321"; - description = lib.mdDoc '' + description = '' v2ray grpc api endpoint ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/varnish.nix b/nixos/modules/services/monitoring/prometheus/exporters/varnish.nix index 98fbba82c8e93..811792674b96c 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/varnish.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/varnish.nix @@ -11,35 +11,35 @@ in noExit = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Do not exit server on Varnish scrape errors. ''; }; withGoMetrics = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Export go runtime and http handler metrics. ''; }; verbose = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable verbose logging. ''; }; raw = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable raw stdout logging without timestamps. ''; }; varnishStatPath = mkOption { type = types.str; default = "varnishstat"; - description = lib.mdDoc '' + description = '' 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 = lib.mdDoc '' + description = '' varnishstat -n value. ''; }; healthPath = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Path under which to expose healthcheck. Disabled unless configured. ''; }; telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix b/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix index 127c8021a9f0f..27c0c191c6e34 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix @@ -11,13 +11,13 @@ in { ({ options.warnings = options.warnings; options.assertions = options.assertions; }) ]; extraOpts = { - verbose = mkEnableOption (lib.mdDoc "verbose logging mode for prometheus-wireguard-exporter"); + verbose = mkEnableOption "verbose logging mode for prometheus-wireguard-exporter"; wireguardConfig = mkOption { type = with types; nullOr (either path str); default = null; - description = lib.mdDoc '' + description = '' Path to the Wireguard Config to [add the peer's name to the stats of a peer](https://github.com/MindFlavor/prometheus_wireguard_exporter/tree/2.0.0#usage). @@ -31,7 +31,7 @@ in { singleSubnetPerField = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' By default, all allowed IPs and subnets are comma-separated in the `allowed_ips` field. With this option enabled, a single IP and subnet will be listed in fields like `allowed_ip_0`, @@ -42,7 +42,7 @@ in { withRemoteIp = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether or not the remote IP of a WireGuard peer should be exposed via prometheus. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/zfs.nix b/nixos/modules/services/monitoring/prometheus/exporters/zfs.nix index 21f6354cc4a20..ce9cd624dc278 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/zfs.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/zfs.nix @@ -12,7 +12,7 @@ in telemetryPath = mkOption { type = types.str; default = "/metrics"; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. ''; }; @@ -20,7 +20,7 @@ in pools = mkOption { type = with types; nullOr (listOf str); default = [ ]; - description = lib.mdDoc '' + description = '' Name of the pool(s) to collect, repeat for multiple pools (default: all pools). ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/pushgateway.nix b/nixos/modules/services/monitoring/prometheus/pushgateway.nix index e93924e4fba87..80e2339f59256 100644 --- a/nixos/modules/services/monitoring/prometheus/pushgateway.nix +++ b/nixos/modules/services/monitoring/prometheus/pushgateway.nix @@ -21,14 +21,14 @@ let in { options = { services.prometheus.pushgateway = { - enable = mkEnableOption (lib.mdDoc "Prometheus Pushgateway"); + enable = mkEnableOption "Prometheus Pushgateway"; package = mkPackageOption pkgs "prometheus-pushgateway" { }; web.listen-address = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Address to listen on for the web interface, API and telemetry. `null` will default to `:9091`. @@ -38,7 +38,7 @@ in { web.telemetry-path = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Path under which to expose metrics. `null` will default to `/metrics`. @@ -48,7 +48,7 @@ in { web.external-url = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' The URL under which Pushgateway is externally reachable. ''; }; @@ -56,7 +56,7 @@ in { web.route-prefix = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Prefix for the internal routes of web endpoints. Defaults to the path of @@ -68,7 +68,7 @@ in { type = types.nullOr types.str; default = null; example = "10m"; - description = lib.mdDoc '' + description = '' The minimum interval at which to write out the persistence file. `null` will default to `5m`. @@ -78,7 +78,7 @@ in { log.level = mkOption { type = types.nullOr (types.enum ["debug" "info" "warn" "error" "fatal"]); default = null; - description = lib.mdDoc '' + description = '' Only log messages with the given severity or above. `null` will default to `info`. @@ -89,7 +89,7 @@ in { type = types.nullOr types.str; default = null; example = "logger:syslog?appname=bob&local=7"; - description = lib.mdDoc '' + description = '' Set the log target and format. `null` will default to `logger:stderr`. @@ -99,7 +99,7 @@ in { extraFlags = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Extra commandline options when launching the Pushgateway. ''; }; @@ -107,7 +107,7 @@ in { persistMetrics = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to persist metrics to a file. When enabled metrics will be saved to a file called @@ -121,7 +121,7 @@ in { stateDir = mkOption { type = types.str; default = "pushgateway"; - description = lib.mdDoc '' + description = '' Directory below `/var/lib` to store metrics. This directory will be created automatically using systemd's diff --git a/nixos/modules/services/monitoring/prometheus/sachet.nix b/nixos/modules/services/monitoring/prometheus/sachet.nix index c908d599bd4ed..3deb29aeb222e 100644 --- a/nixos/modules/services/monitoring/prometheus/sachet.nix +++ b/nixos/modules/services/monitoring/prometheus/sachet.nix @@ -9,7 +9,7 @@ in { options = { services.prometheus.sachet = { - enable = mkEnableOption (lib.mdDoc "Sachet, an SMS alerting tool for the Prometheus Alertmanager"); + enable = mkEnableOption "Sachet, an SMS alerting tool for the Prometheus Alertmanager"; configuration = mkOption { type = types.nullOr types.attrs; @@ -32,7 +32,7 @@ in }]; } ''; - description = lib.mdDoc '' + description = '' Sachet's configuration as a nix attribute set. ''; }; @@ -40,7 +40,7 @@ in address = mkOption { type = types.str; default = "localhost"; - description = lib.mdDoc '' + description = '' The address Sachet will listen to. ''; }; @@ -48,7 +48,7 @@ in port = mkOption { type = types.port; default = 9876; - description = lib.mdDoc '' + description = '' The port Sachet will listen to. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix b/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix index 4545ca37d2788..f3f553cd86420 100644 --- a/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix +++ b/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix @@ -15,13 +15,13 @@ in ]; options.services.prometheus.xmpp-alerts = { - enable = mkEnableOption (lib.mdDoc "XMPP Web hook service for Alertmanager"); + enable = mkEnableOption "XMPP Web hook service for Alertmanager"; settings = mkOption { type = settingsFormat.type; default = {}; - description = lib.mdDoc '' + description = '' Configuration for prometheus xmpp-alerts, see <https://github.com/jelmer/prometheus-xmpp-alerts/blob/master/xmpp-alerts.yml.example> for supported values. |