From 11633c9e6b43b86bf7e11f79c6a0017413177be1 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Wed, 14 Dec 2016 15:52:07 -0800 Subject: [PATCH] Deprecate filters option in metrictbeat (#3173) --- metricbeat/docs/metricbeat-filtering.asciidoc | 39 ------------------- .../configuration/metricbeat-options.asciidoc | 5 ++- 2 files changed, 3 insertions(+), 41 deletions(-) diff --git a/metricbeat/docs/metricbeat-filtering.asciidoc b/metricbeat/docs/metricbeat-filtering.asciidoc index c78a25a890c..e312d18ce8c 100644 --- a/metricbeat/docs/metricbeat-filtering.asciidoc +++ b/metricbeat/docs/metricbeat-filtering.asciidoc @@ -1,45 +1,6 @@ [[filtering-and-enhancing-data]] == Filtering and Enhancing the Exported Data -Your use case might require only a subset of the data exported by Metricbeat, or -you might need to enhance the exported data (for example, by adding metadata). -Metricbeat provides a couple of options for filtering and enhancing exported -data. You can: - -* <> to -configure each module to include or exclude specific events or fields. -* <> to configure global processing -across all data exported by Metricbeat. - -[float] -[[metricbeat-filtering-overview]] -=== Filtering at the Metricbeat Module Level - -Each module accepts a list of filters in its configuration. These filters are -applied to the data generated by the module. These filters are applied to the -module data prior to the addition of the common Beat fields like `beat.hostname` -and `type` so they can only be used to filter fields from the module. - -The following example reduces the exported fields of the Redis module to -include only the `redis.info.memory` fields. - -[source,yaml] ----- -metricbeat.modules: -- module: redis - metricsets: ["info"] - period: 1s - hosts: ["127.0.0.1:6379"] - enabled: true - filters: - - include_fields: - fields: ['memory'] ----- - -[float] -[[defining-processors]] -=== Defining Processors - include::../../libbeat/docs/processors.asciidoc[] For example, the following configuration reduces the exported fields by diff --git a/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc b/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc index 0d0ac92c483..a44607d2fa6 100644 --- a/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc +++ b/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc @@ -62,8 +62,9 @@ A list of tags that will be sent with the metricset event. This setting is optio ===== filters -A list of filters to apply to the data generated by the module. For more detail on how to configure -filters, see <>. +deprecated[5.1,This option will be renamed and changed in a future release] + +A list of filters to apply to the data generated by the module. include::../../../../libbeat/docs/generalconfig.asciidoc[]