Skip to content

Commit 24c862d

Browse files
committed
changing references from WHITELIST_FILE to METRIC_FILTERS_FILE
1 parent e5ad342 commit 24c862d

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

docs/config-carbon.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A given rule is made up of 3 lines:
4141
* A regex, specified after "pattern="
4242
* A retention rate line, specified after "retentions="
4343

44-
The retentions line can specify multiple retentions. Each retention of ``frequency:history`` is separated by a comma.
44+
The retentions line can specify multiple retentions. Each retention of ``frequency:history`` is separated by a comma.
4545

4646
Frequencies and histories are specified using the following suffixes:
4747

@@ -60,7 +60,7 @@ Here's a simple, single retention example:
6060
pattern = garbageCollections$
6161
retentions = 10s:14d
6262
63-
The name ``[garbage_collection]`` is mainly for documentation purposes, and will show up in ``creates.log`` when metrics matching this section are created.
63+
The name ``[garbage_collection]`` is mainly for documentation purposes, and will show up in ``creates.log`` when metrics matching this section are created.
6464

6565
The regular expression pattern will match any metric that ends with ``garbageCollections``. For example, ``com.acmeCorp.instance01.jvm.memory.garbageCollections`` would match, but ``com.acmeCorp.instance01.jvm.memory.garbageCollections.full`` would not.
6666

@@ -80,7 +80,7 @@ Additionally, this example uses multiple retentions. The general rule is to spec
8080

8181
By using multiple retentions, you can store long histories of metrics while saving on disk space and I/O. Because whisper averages (by default) as it downsamples, one is able to determine totals of metrics by reversing the averaging process later on down the road.
8282

83-
Example: You store the number of sales per minute for 1 year, and the sales per hour for 5 years after that. You need to know the total sales for January 1st of the year before. You can query whisper for the raw data, and you'll get 24 datapoints, one for each hour. They will most likely be floating point numbers. You can take each datapoint, multiply by 60 (the ratio of high-precision to low-precision datapoints) and still get the total sales per hour.
83+
Example: You store the number of sales per minute for 1 year, and the sales per hour for 5 years after that. You need to know the total sales for January 1st of the year before. You can query whisper for the raw data, and you'll get 24 datapoints, one for each hour. They will most likely be floating point numbers. You can take each datapoint, multiply by 60 (the ratio of high-precision to low-precision datapoints) and still get the total sales per hour.
8484

8585

8686
Additionally, whisper supports a legacy retention specification for backwards compatibility reasons - ``seconds-per-datapoint:count-of-datapoints``
@@ -140,7 +140,7 @@ You must define at least one section as the default.
140140

141141
aggregation-rules.conf
142142
----------------------
143-
Aggregation rules allow you to add several metrics together as they come in, reducing the need to sum() many metrics in every URL. Note that unlike some other config files, any time this file is modified it will take effect automatically. This requires the carbon-aggregator service to be running.
143+
Aggregation rules allow you to add several metrics together as they come in, reducing the need to sum() many metrics in every URL. Note that unlike some other config files, any time this file is modified it will take effect automatically. This requires the carbon-aggregator service to be running.
144144

145145
The form of each line in this file should be as follows:
146146

@@ -231,13 +231,25 @@ For example:
231231
These rules would strip off a suffix of _sum or _avg from any metric names after
232232
aggregation.
233233

234+
Metric Filters: allowed and blocked Metrics
235+
-------------------------------------------
236+
237+
The metric filter functionality allows any of the carbon daemons to only accept
238+
metrics that are explicitly allowed and/or to reject rejected metrics. The
239+
functionality can be enabled in carbon.conf with the ``USE_METRIC_FILTERS``
240+
flag. This can be useful when too many metrics are being sent to a Graphite
241+
instance or when there are metric senders sending useless or invalid metrics.
242+
243+
``GRAPHITE_CONF_DIR`` is searched for ``allowed_metrics.conf`` and
244+
``blocked_metrics.conf``. Each file contains one regular expression per line to
245+
match against metric values. If the allowed_metrics configuration is missing or
246+
empty, all metrics will be passed through by default.
247+
234248
whitelist and blacklist
235249
-----------------------
236-
The whitelist functionality allows any of the carbon daemons to only accept metrics that are explicitly
237-
whitelisted and/or to reject blacklisted metrics. The functionality can be enabled in carbon.conf with
238-
the ``USE_WHITELIST`` flag. This can be useful when too many metrics are being sent to a Graphite
239-
instance or when there are metric senders sending useless or invalid metrics.
250+
The whitelist/blacklist functionality has been renamed to 'allowed' and
251+
'blocked' so as to use less ambiguous language, and remove possible connotations
252+
associated with those terms.
240253

241-
``GRAPHITE_CONF_DIR`` is searched for ``whitelist.conf`` and ``blacklist.conf``. Each file contains one regular
242-
expressions per line to match against metric values. If the whitelist configuration is missing or empty,
243-
all metrics will be passed through by default.
254+
The capabilities have been renamed as of this point, but he existing ``whitelist.conf``
255+
and ``blacklist.conf`` will still be functional for the time being.

0 commit comments

Comments
 (0)