Skip to content

Commit

Permalink
Merge pull request #2215 from wfhu/patch-1
Browse files Browse the repository at this point in the history
Update config-carbon.rst
  • Loading branch information
gwaldo committed Jan 31, 2018
2 parents 0f11d54 + 97de802 commit 56c2ec0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/config-carbon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ This file defines how to aggregate data to lower-precision retentions. The form
Important notes before continuing:

* This file is optional. If it is not present, defaults will be used.
* The sections are applied in order from the top (first) and bottom (last), similar to ``storage-schemas.conf``.
* The first pattern that matches the metric name is used, similar to ``storage-schemas.conf``.
* There is no ``retentions`` line. Instead, there are ``xFilesFactor`` and/or ``aggregationMethod`` lines.
* ``xFilesFactor`` should be a floating point number between 0 and 1, and specifies what fraction of the previous retention level's slots must have non-null values in order to aggregate to a non-null value. The default is 0.5.
* ``aggregationMethod`` specifies the function used to aggregate values for the next retention level. Legal methods are ``average``, ``sum``, ``min``, ``max``, and ``last``. The default is ``average``.
Expand Down

0 comments on commit 56c2ec0

Please sign in to comment.