summary refs log tree commit diff
path: root/nixos/modules/services/logging/logstash.nix
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2014-09-05 15:28:24 +0200
committerEelco Dolstra <eelco.dolstra@logicblox.com>2014-09-05 15:28:24 +0200
commitb0855d59a10d9b77e1e92fc15b9cab3bcd3557ae (patch)
tree081bbd089ed3e4181fd73416b68fd47a2da36d9f /nixos/modules/services/logging/logstash.nix
parentbb9ee6a13f1623c3107d264891a52a76e4a2853a (diff)
downloadnixlib-b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae.tar
nixlib-b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae.tar.gz
nixlib-b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae.tar.bz2
nixlib-b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae.tar.lz
nixlib-b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae.tar.xz
nixlib-b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae.tar.zst
nixlib-b0855d59a10d9b77e1e92fc15b9cab3bcd3557ae.zip
Improve option descriptions a bit
Diffstat (limited to 'nixos/modules/services/logging/logstash.nix')
-rw-r--r--nixos/modules/services/logging/logstash.nix18
1 files changed, 13 insertions, 5 deletions
diff --git a/nixos/modules/services/logging/logstash.nix b/nixos/modules/services/logging/logstash.nix
index 802dd454878b..df81ac142dc3 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 }
         '';
       };
+
     };
   };