public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve option descriptions a bit

Browse Source
This commit is contained in:
Eelco Dolstra 2014-09-05 15:28:24 +02:00
parent bb9ee6a13f
commit b0855d59a1
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
nixos/modules/services/logging/logstash.nix
View File

@ -11,20 +11,25 @@ in
###### interface ###### interface
options = { options = {
services.logstash = { services.logstash = {
enable = mkOption { enable = mkOption {
type = types.bool;
default = false; default = false;
description = "Enable logstash"; description = "Enable logstash.";
}; };
enableWeb = mkOption { enableWeb = mkOption {
type = types.bool;
default = false; default = false;
description = "Enable logstash web interface"; description = "Enable the logstash web interface.";
}; };
inputConfig = mkOption { inputConfig = mkOption {
type = types.lines;
default = ''stdin { type => "example" }''; default = ''stdin { type => "example" }'';
description = "Logstash input configuration"; description = "Logstash input configuration.";
example = '' example = ''
# Read from journal # Read from journal
pipe { pipe {
@ -35,8 +40,9 @@ in
}; };
filterConfig = mkOption { filterConfig = mkOption {
type = types.lines;
default = ''noop {}''; default = ''noop {}'';
description = "logstash filter configuration"; description = "logstash filter configuration.";
example = '' example = ''
if [type] == "syslog" { if [type] == "syslog" {
# Keep only relevant systemd fields # Keep only relevant systemd fields
@ -52,13 +58,15 @@ in
}; };
outputConfig = mkOption { outputConfig = mkOption {
type = types.lines;
default = ''stdout { debug => true debug_format => "json"}''; default = ''stdout { debug => true debug_format => "json"}'';
description = "Logstash output configuration"; description = "Logstash output configuration.";
example = '' example = ''
redis { host => "localhost" data_type => "list" key => "logstash" codec => json } redis { host => "localhost" data_type => "list" key => "logstash" codec => json }
elasticsearch { embedded => true } elasticsearch { embedded => true }
''; '';
}; };
}; };
}; };