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.

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

Rename doc files and IDs for "filters" to "processors" renaming #1981

Merged
merged 2 commits into from
Jul 8, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions filebeat/docs/filebeat-filtering.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[filtering-data]]
[[filtering-and-enhancing-data]]
== Filtering and Enhancing the Exported Data

When your use case requires only a subset of the data exported by Filebeat or you need to add metadata, you can <<filebeat-filtering-overview,use Filebeat config options to filter the data>>, or you can <<defining-processors,define processors>>.
Expand Down Expand Up @@ -29,7 +29,7 @@ See <<configuration-filebeat-options,Filebeat configuration options>> for more i
[[defining-processors]]
=== Defining Processors

include::../../libbeat/docs/filtering.asciidoc[]
include::../../libbeat/docs/processors.asciidoc[]

For example, the following configuration drops all the DEBUG messages.

Expand Down Expand Up @@ -77,4 +77,4 @@ processors:
source: "test"
----------------

See <<configuration-filter>> for more information.
See <<configuration-processors>> for more information.
2 changes: 1 addition & 1 deletion filebeat/docs/reference/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes
* <<configuration-filebeat-options>>
* <<configuration-global-options>>
* <<configuration-general>>
* <<configuration-filter>>
* <<configuration-processors>>
* <<elasticsearch-output>>
* <<logstash-output>>
* <<kafka-output>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ filebeat.config_dir: path/to/configs

include::../../../../libbeat/docs/generalconfig.asciidoc[]

include::../../../../libbeat/docs/filteringconfig.asciidoc[]
include::../../../../libbeat/docs/processors-config.asciidoc[]

include::../../../../libbeat/docs/outputconfig.asciidoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
//// Use the appropriate variables defined in the index.asciidoc file to
//// resolve Beat names: beatname_uc and beatname_lc.
//// Use the following include to pull this content into a doc file:
//// include::../../libbeat/docs/filteringconfig.asciidoc[]
//// include::../../libbeat/docs/processors-config.asciidoc[]
//// Make sure this content appears below a level 2 heading.
//////////////////////////////////////////////////////////////////////////

[[configuration-filter]]
[[configuration-processors]]
=== Processors Configuration (was Filters)

//TODO: Remove was Filters from the above title and remove extra sections that show the alpha4 configuration
Expand Down Expand Up @@ -65,7 +65,7 @@ processors:

------

See <<filtering-data>> for specific {beatname_uc} examples.
See <<filtering-and-enhancing-data>> for specific {beatname_uc} examples.

[[filtering-condition]]
==== Condition
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion metricbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ A Metricbeat configuration contains a list of modules. Each module contains the
* `hosts`: A list of hosts to fetch information from. For some modules, such as the System module, this setting is not required.
* `fields`: A dictionary of fields that will be sent with the metricset event. This setting is optional.
* `tags`: A list of tags that will be sent with the metricset event. This setting is optional.
* `filters`: With filters you can reduce the amount of data that is sent in the event. For more about the available filter options, see <<filtering-data>>. This setting is optional.
* `filters`: With filters you can reduce the amount of data that is sent in the event. For more about the available filter options, see <<filtering-and-enhancing-data>>. This setting is optional.

The following example shows a basic configuration for the Apache module:

Expand Down
34 changes: 31 additions & 3 deletions metricbeat/docs/metricbeat-filtering.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[filtering-data]]
[[filtering-and-enhancing-data]]
== Filtering and Enhancing the Exported Data

When your use case requires only a subset of the data exported by Metricbeat or you need to add metadata,
Expand All @@ -18,6 +18,8 @@ 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.

deprecated[5.0.0-alpha4,The `filters` section is being renamed to `processors` in 5.0.0-beta1. Therefore the following configuration is deprecated]

[source,yaml]
----
metricbeat.modules:
Expand All @@ -31,20 +33,46 @@ metricbeat.modules:
fields: ['redis.info.memory']
----

coming[5.0.0-beta1,Begin using the following configuration starting with 5.0.0-beta1]

[source,yaml]
----
metricbeat.modules:
- module: redis
metricsets: ["info"]
period: 1s
hosts: ["127.0.0.1:6379"]
enabled: true
processors:
- include_fields:
fields: ['redis.info.memory']
----

[float]
[[defining-processors]]
=== Defining Processors

include::../../libbeat/docs/filtering.asciidoc[]
include::../../libbeat/docs/processors.asciidoc[]

For example, the following filters configuration reduces the exported fields by
dropping the `beat.name` and `beat.hostname` fields under `beat`, from all documents.

deprecated[5.0.0-alpha4,The `filters` section is being renamed to `processors` in 5.0.0-beta1. Therefore the following configuration is deprecated]

[source, yaml]
----
filters:
- drop_fields:
fields: ['beat']
----

See <<configuration-filter>> for more information.
coming[5.0.0-beta1,Begin using the following configuration starting with 5.0.0-beta1]

[source, yaml]
----
processors:
- drop_fields:
fields: ['beat']
----

See <<configuration-processors>> for more information.
2 changes: 1 addition & 1 deletion metricbeat/docs/reference/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes

* <<configuration-metricbeat>>
* <<configuration-general>>
* <<configuration-filter>>
* <<configuration-processors>>
* <<elasticsearch-output>>
* <<logstash-output>>
* <<kafka-output>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ 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-filter>>.
filters, see <<configuration-processors>>.

include::../../../../libbeat/docs/generalconfig.asciidoc[]

include::../../../../libbeat/docs/filteringconfig.asciidoc[]
include::../../../../libbeat/docs/processors-config.asciidoc[]

include::../../../../libbeat/docs/outputconfig.asciidoc[]

Expand Down
2 changes: 1 addition & 1 deletion packetbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ include::./securing-packetbeat.asciidoc[]

include::./visualizing-data-packetbeat.asciidoc[]

include::./filtering.asciidoc[]
include::./processors.asciidoc[]

include::./troubleshooting.asciidoc[]

Expand Down
10 changes: 5 additions & 5 deletions packetbeat/docs/packetbeat-filtering.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[filtering-data]]
[[filtering-and-enhancing-data]]
== Filtering and Enhancing the Exported Data

include::../../libbeat/docs/filtering.asciidoc[]
include::../../libbeat/docs/processors.asciidoc[]

For example, the following filters configuration includes a subset of the Packetbeat DNS fields so that only the
requests and their response codes are reported:
Expand Down Expand Up @@ -57,7 +57,7 @@ coming[5.0.0-beta1,Begin using the following configuration starting with 5.0.0-b

[source,yaml]
------------
filters:
processors:
- drop_event:
when:
equals:
Expand All @@ -82,12 +82,12 @@ coming[5.0.0-beta1,Begin using the following configuration starting with 5.0.0-b

[source,yaml]
------------
filters:
processors:
- drop_fields:
when:
equals:
http.code: 200
fields: ["request", "response"]
------------

See <<configuration-filter>> for more information.
See <<configuration-processors>> for more information.
2 changes: 1 addition & 1 deletion packetbeat/docs/reference/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes
* <<configuration-protocols>>
* <<configuration-processes>>
* <<configuration-general>>
* <<configuration-filter>>
* <<configuration-processors>>
* <<elasticsearch-output>>
* <<logstash-output>>
* <<kafka-output>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ process' command line as read from `/proc/<pid>/cmdline`.

include::../../../../libbeat/docs/generalconfig.asciidoc[]

include::../../../../libbeat/docs/filteringconfig.asciidoc[]
include::../../../../libbeat/docs/processors-config.asciidoc[]

include::../../../../libbeat/docs/outputconfig.asciidoc[]

Expand Down
2 changes: 1 addition & 1 deletion winlogbeat/docs/reference/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes

* <<configuration-winlogbeat-options>>
* <<configuration-general>>
* <<configuration-filter>>
* <<configuration-processors>>
* <<elasticsearch-output>>
* <<logstash-output>>
* <<kafka-output>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ The metrics are served as a JSON document. The metrics include:

include::../../../../libbeat/docs/generalconfig.asciidoc[]

include::../../../../libbeat/docs/filteringconfig.asciidoc[]
include::../../../../libbeat/docs/processors-config.asciidoc[]

include::../../../../libbeat/docs/outputconfig.asciidoc[]

Expand Down
17 changes: 14 additions & 3 deletions winlogbeat/docs/winlogbeat-filtering.asciidoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
[[filtering-data]]
[[filtering-and-enhancing-data]]
== Filtering and Enhancing the Exported Data

include::../../libbeat/docs/filtering.asciidoc[]
include::../../libbeat/docs/processors.asciidoc[]

For example, the following filter configuration drops a few fields that are rarely used (`provider_guid`, `process_id`, `thread_id`, and `version`) and one nested field, `event_data.ErrorSourceTable`:

deprecated[5.0.0-alpha4,The `filters` section is being renamed to `processors` in 5.0.0-beta1. Therefore the following configuration is deprecated]

[source, yaml]
-----------------------------------------------------
filters:
- drop_fields:
fields: [provider_guid, process_id, thread_id, version, event_data.ErrorSourceTable]
-----------------------------------------------------

See <<configuration-filter>> for more information.
coming[5.0.0-beta1,Begin using the following configuration starting with 5.0.0-beta1]

[source, yaml]
-----------------------------------------------------
processors:
- drop_fields:
fields: [provider_guid, process_id, thread_id, version, event_data.ErrorSourceTable]
-----------------------------------------------------

See <<configuration-processors>> for more information.