From b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Fri, 5 Sep 2014 15:28:24 +0200 Subject: [PATCH] Improve option descriptions a bit --- nixos/modules/services/logging/logstash.nix | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/nixos/modules/services/logging/logstash.nix b/nixos/modules/services/logging/logstash.nix index 802dd454878..df81ac142dc 100644 --- a/nixos/modules/services/logging/logstash.nix +++ b/nixos/modules/services/logging/logstash.nix @@ -11,20 +11,25 @@ in ###### interface options = { + services.logstash = { + enable = mkOption { + type = types.bool; default = false; - description = "Enable logstash"; + description = "Enable logstash."; }; enableWeb = mkOption { + type = types.bool; default = false; - description = "Enable logstash web interface"; + description = "Enable the logstash web interface."; }; inputConfig = mkOption { + type = types.lines; default = ''stdin { type => "example" }''; - description = "Logstash input configuration"; + description = "Logstash input configuration."; example = '' # Read from journal pipe { @@ -35,8 +40,9 @@ in }; filterConfig = mkOption { + type = types.lines; default = ''noop {}''; - description = "logstash filter configuration"; + description = "logstash filter configuration."; example = '' if [type] == "syslog" { # Keep only relevant systemd fields @@ -52,13 +58,15 @@ in }; outputConfig = mkOption { + type = types.lines; default = ''stdout { debug => true debug_format => "json"}''; - description = "Logstash output configuration"; + description = "Logstash output configuration."; example = '' redis { host => "localhost" data_type => "list" key => "logstash" codec => json } elasticsearch { embedded => true } ''; }; + }; };