Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate filters option in metrictbeat #3173

Merged
merged 1 commit into from
Dec 14, 2016
Merged

Deprecate filters option in metrictbeat #3173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 0 additions & 39 deletions metricbeat/docs/metricbeat-filtering.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

* <<metricbeat-filtering-overview,Define filters at the module level>> to
configure each module to include or exclude specific events or fields.
* <<defining-processors,Define processors>> 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
Expand Down
5 changes: 3 additions & 2 deletions metricbeat/docs/reference/configuration/metricbeat-options.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<configuration-processors>>.
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[]

Expand Down