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

nixos/graphite-service: make option descriptions end with '.'

Browse Source 
Because that is how it is supposed to be.
This commit is contained in:
Bjørn Forsman 2014-06-09 11:26:22 +02:00
parent 0e400be1ec
commit 208d466c21
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
nixos/modules/services/monitoring/graphite.nix
View File

@ -47,19 +47,19 @@ in {
web = { web = {
enable = mkOption { enable = mkOption {
description = "Whether to enable graphite web frontend"; description = "Whether to enable graphite web frontend.";
default = false; default = false;
type = types.uniq types.bool; type = types.uniq types.bool;
}; };
host = mkOption { host = mkOption {
description = "Graphite web frontend listen address"; description = "Graphite web frontend listen address.";
default = "127.0.0.1"; default = "127.0.0.1";
type = types.str; type = types.str;
}; };
port = mkOption { port = mkOption {
description = "Graphite web frontend port"; description = "Graphite web frontend port.";
default = 8080; default = 8080;
type = types.int; type = types.int;
}; };
@ -67,7 +67,7 @@ in {
carbon = { carbon = {
config = mkOption { config = mkOption {
description = "Content of carbon configuration file"; description = "Content of carbon configuration file.";
default = '' default = ''
[cache] [cache]
# Listen on localhost by default for security reasons # Listen on localhost by default for security reasons
@ -83,13 +83,13 @@ in {
}; };
enableCache = mkOption { enableCache = mkOption {
description = "Whether to enable carbon cache, the graphite storage daemon"; description = "Whether to enable carbon cache, the graphite storage daemon.";
default = false; default = false;
type = types.uniq types.bool; type = types.uniq types.bool;
}; };
storageAggregation = mkOption { storageAggregation = mkOption {
description = "Defines how to aggregate data to lower-precision retentions"; description = "Defines how to aggregate data to lower-precision retentions.";
default = null; default = null;
type = types.uniq (types.nullOr types.string); type = types.uniq (types.nullOr types.string);
example = '' example = ''
@ -101,7 +101,7 @@ in {
}; };
storageSchemas = mkOption { storageSchemas = mkOption {
description = "Defines retention rates for storing metrics"; description = "Defines retention rates for storing metrics.";
default = ""; default = "";
type = types.uniq (types.nullOr types.string); type = types.uniq (types.nullOr types.string);
example = '' example = ''
@ -112,21 +112,24 @@ in {
}; };
blacklist = mkOption { blacklist = mkOption {
description = "Any metrics received which match one of the experssions will be dropped"; description = "Any metrics received which match one of the experssions will be dropped.";
default = null; default = null;
type = types.uniq (types.nullOr types.string); type = types.uniq (types.nullOr types.string);
example = "^some\.noisy\.metric\.prefix\..*"; example = "^some\.noisy\.metric\.prefix\..*";
}; };
whitelist = mkOption { whitelist = mkOption {
description = "Only metrics received which match one of the experssions will be persisted"; description = "Only metrics received which match one of the experssions will be persisted.";
default = null; default = null;
type = types.uniq (types.nullOr types.string); type = types.uniq (types.nullOr types.string);
example = ".*"; example = ".*";
}; };
rewriteRules = mkOption { rewriteRules = mkOption {
description = "Regular expression patterns that can be used to rewrite metric names in a search and replace fashion"; description = ''
Regular expression patterns that can be used to rewrite metric names
in a search and replace fashion.
'';
default = null; default = null;
type = types.uniq (types.nullOr types.string); type = types.uniq (types.nullOr types.string);
example = '' example = ''
@ -137,7 +140,7 @@ in {
}; };
enableRelay = mkOption { enableRelay = mkOption {
description = "Whether to enable carbon relay, the carbon replication and sharding service"; description = "Whether to enable carbon relay, the carbon replication and sharding service.";
default = false; default = false;
type = types.uniq types.bool; type = types.uniq types.bool;
}; };
@ -154,13 +157,13 @@ in {
}; };
enableAggregator = mkOption { enableAggregator = mkOption {
description = "Whether to enable carbon agregator, the carbon buffering service"; description = "Whether to enable carbon agregator, the carbon buffering service.";
default = false; default = false;
type = types.uniq types.bool; type = types.uniq types.bool;
}; };
aggregationRules = mkOption { aggregationRules = mkOption {
description = "Defines if and how received metrics will be agregated"; description = "Defines if and how received metrics will be agregated.";
default = null; default = null;
type = types.uniq (types.nullOr types.string); type = types.uniq (types.nullOr types.string);
example = '' example = ''