diff options
Diffstat (limited to 'nixos/modules/services/monitoring/prometheus/pushgateway.nix')
-rw-r--r-- | nixos/modules/services/monitoring/prometheus/pushgateway.nix | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/nixos/modules/services/monitoring/prometheus/pushgateway.nix b/nixos/modules/services/monitoring/prometheus/pushgateway.nix index 01b99376243..ac7a2300f67 100644 --- a/nixos/modules/services/monitoring/prometheus/pushgateway.nix +++ b/nixos/modules/services/monitoring/prometheus/pushgateway.nix @@ -27,7 +27,7 @@ in { type = types.package; default = pkgs.prometheus-pushgateway; defaultText = literalExpression "pkgs.prometheus-pushgateway"; - description = '' + description = lib.mdDoc '' Package that should be used for the prometheus pushgateway. ''; }; @@ -35,27 +35,27 @@ in { web.listen-address = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Address to listen on for the web interface, API and telemetry. - <literal>null</literal> will default to <literal>:9091</literal>. + `null` will default to `:9091`. ''; }; web.telemetry-path = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path under which to expose metrics. - <literal>null</literal> will default to <literal>/metrics</literal>. + `null` will default to `/metrics`. ''; }; web.external-url = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The URL under which Pushgateway is externally reachable. ''; }; @@ -63,11 +63,11 @@ in { web.route-prefix = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Prefix for the internal routes of web endpoints. Defaults to the path of - <option>services.prometheus.pushgateway.web.external-url</option>. + {option}`services.prometheus.pushgateway.web.external-url`. ''; }; @@ -75,20 +75,20 @@ in { type = types.nullOr types.str; default = null; example = "10m"; - description = '' + description = lib.mdDoc '' The minimum interval at which to write out the persistence file. - <literal>null</literal> will default to <literal>5m</literal>. + `null` will default to `5m`. ''; }; log.level = mkOption { type = types.nullOr (types.enum ["debug" "info" "warn" "error" "fatal"]); default = null; - description = '' + description = lib.mdDoc '' Only log messages with the given severity or above. - <literal>null</literal> will default to <literal>info</literal>. + `null` will default to `info`. ''; }; @@ -96,17 +96,17 @@ in { type = types.nullOr types.str; default = null; example = "logger:syslog?appname=bob&local=7"; - description = '' + description = lib.mdDoc '' Set the log target and format. - <literal>null</literal> will default to <literal>logger:stderr</literal>. + `null` will default to `logger:stderr`. ''; }; extraFlags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra commandline options when launching the Pushgateway. ''; }; @@ -114,26 +114,26 @@ in { persistMetrics = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to persist metrics to a file. When enabled metrics will be saved to a file called - <literal>metrics</literal> in the directory - <literal>/var/lib/pushgateway</literal>. The directory below - <literal>/var/lib</literal> can be set using - <option>services.prometheus.pushgateway.stateDir</option>. + `metrics` in the directory + `/var/lib/pushgateway`. The directory below + `/var/lib` can be set using + {option}`services.prometheus.pushgateway.stateDir`. ''; }; stateDir = mkOption { type = types.str; default = "pushgateway"; - description = '' - Directory below <literal>/var/lib</literal> to store metrics. + description = lib.mdDoc '' + Directory below `/var/lib` to store metrics. This directory will be created automatically using systemd's StateDirectory mechanism when - <option>services.prometheus.pushgateway.persistMetrics</option> + {option}`services.prometheus.pushgateway.persistMetrics` is enabled. ''; }; |