Skip to content

Commit

Permalink
[DOCS] Make processor conditionals opt-out rather than opt-in (elasti…
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton authored Nov 21, 2019
1 parent ac444b4 commit 85a88d4
Show file tree
Hide file tree
Showing 13 changed files with 124 additions and 27 deletions.
4 changes: 4 additions & 0 deletions auditbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:docker_platform:
:win_os:
:linux_os:
:no_decode_cef_processor:
:no_decode_csv_fields_processor:
:no_script_processor:
:no_timestamp_processor:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down
4 changes: 0 additions & 4 deletions filebeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:has_solutions:
:ignores_max_retries:
:has_docker_label_ex:
:has_decode_cef_processor:
:has_decode_csv_fields_processor:
:has_script_processor:
:has_timestamp_processor:
:has_modules_command:
:has_registry:
:deb_os:
Expand Down
4 changes: 4 additions & 0 deletions heartbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:docker_platform:
:win_os:
:no_dashboards:
:no_decode_cef_processor:
:no_decode_csv_fields_processor:
:no_script_processor:
:no_timestamp_processor:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down
4 changes: 1 addition & 3 deletions journalbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,12 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:github_repo_name: beats
:discuss_forum: beats/{beatname_lc}
:beat_default_index_prefix: {beatname_lc}
:has_decode_csv_fields_processor:
:has_script_processor:
:has_timestamp_processor:
:deb_os:
:rpm_os:
:linux_os:
:docker_platform:
:no_dashboards:
:no_decode_cef_processor:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down
110 changes: 101 additions & 9 deletions libbeat/docs/processors-list.asciidoc
Original file line number Diff line number Diff line change
@@ -1,78 +1,170 @@
// TODO: Create script that generates this file. Condiitional coding needs to
// TODO: Create script that generates this file. Conditional coding needs to
// be preserved.

//# tag::processors-list[]
ifndef::no_add_cloud_metadata_processor[]
* <<add-cloud-metadata,`add_cloud_metadata`>>
endif::[]
ifndef::no_add_docker_metadata_processor[]
* <<add-docker-metadata,`add_docker_metadata`>>
endif::[]
ifndef::no_add_fields_processor[]
* <<add-fields, `add_fields`>>
endif::[]
ifndef::no_add_host_metadata_processor[]
* <<add-host-metadata,`add_host_metadata`>>
endif::[]
ifndef::no_add_kubernetes_metadata_processor[]
* <<add-kubernetes-metadata,`add_kubernetes_metadata`>>
endif::[]
ifndef::no_add_labels_processor[]
* <<add-labels, `add_labels`>>
endif::[]
ifndef::no_add_locale_processor[]
* <<add-locale,`add_locale`>>
endif::[]
ifndef::no_add_observer_metadata_processor[]
* <<add-observer-metadata,`add_observer_metadata`>>
endif::[]
ifndef::no_add_process_metadata_processor[]
* <<add-process-metadata,`add_process_metadata`>>
endif::[]
ifndef::no_add_tags_processor[]
* <<add-tags, `add_tags`>>
endif::[]
ifndef::no_community_id_processor[]
* <<community-id,`community_id`>>
endif::[]
ifndef::no_convert_processor[]
* <<convert,`convert`>>
endif::[]
ifndef::no_decode_base64_field_processor[]
* <<decode-base64-field,`decode_base64_field`>>
ifdef::has_decode_cef_processor[]
endif::[]
ifndef::no_decode_cef_processor[]
* <<processor-decode-cef,`decode_cef`>>
endif::[]
ifdef::has_decode_csv_fields_processor[]
ifndef::no_decode_csv_fields_processor[]
* <<decode-csv-fields,`decode_csv_fields`>>
endif::[]
ifndef::no_decode_json_fields_processor[]
* <<decode-json-fields,`decode_json_fields`>>
endif::[]
ifndef::no_decompress_gzip_field_processor[]
* <<decompress-gzip-field,`decompress_gzip_field`>>
endif::[]
ifndef::no_dissect_processor[]
* <<dissect, `dissect`>>
endif::[]
ifndef::no_dns_processor[]
* <<processor-dns, `dns`>>
endif::[]
ifndef::no_drop_event_processor[]
* <<drop-event,`drop_event`>>
endif::[]
ifndef::no_drop_fields_processor[]
* <<drop-fields,`drop_fields`>>
endif::[]
ifndef::no_extract_array_processor[]
* <<extract-array,`extract_array`>>
endif::[]
ifndef::no_include_fields_processor[]
* <<include-fields,`include_fields`>>
endif::[]
ifndef::no_registered_domain_processor[]
* <<processor-registered-domain,`registered_domain`>>
endif::[]
ifndef::no_rename_processor[]
* <<rename-fields,`rename`>>
ifdef::has_script_processor[]
endif::[]
ifndef::no_script_processor[]
* <<processor-script,`script`>>
endif::[]
ifdef::has_timestamp_processor[]
ifndef::no_timestamp_processor[]
* <<processor-timestamp,`timestamp`>>
endif::[]
//# end::processors-list[]

//# tag::processors-include[]
ifndef::no_add_cloud_metadata_processor[]
include::{libbeat-processors-dir}/add_cloud_metadata/docs/add_cloud_metadata.asciidoc[]
endif::[]
ifndef::no_add_docker_metadata_processor[]
include::{libbeat-processors-dir}/add_docker_metadata/docs/add_docker_metadata.asciidoc[]
endif::[]
ifndef::no_add_fields_processor[]
include::{libbeat-processors-dir}/actions/docs/add_fields.asciidoc[]
endif::[]
ifndef::no_add_host_metadata_processor[]
include::{libbeat-processors-dir}/add_host_metadata/docs/add_host_metadata.asciidoc[]
endif::[]
ifndef::no_add_kubernetes_metadata_processor[]
include::{libbeat-processors-dir}/add_kubernetes_metadata/docs/add_kubernetes_metadata.asciidoc[]
endif::[]
ifndef::no_add_labels_processor[]
include::{libbeat-processors-dir}/actions/docs/add_labels.asciidoc[]
endif::[]
ifndef::no_add_locale_processor[]
include::{libbeat-processors-dir}/add_locale/docs/add_locale.asciidoc[]
endif::[]
ifndef::no_add_observer_metadata_processor[]
include::{libbeat-processors-dir}/add_observer_metadata/docs/add_observer_metadata.asciidoc[]
endif::[]
ifndef::no_add_process_metadata_processor[]
include::{libbeat-processors-dir}/add_process_metadata/docs/add_process_metadata.asciidoc[]
endif::[]
ifndef::no_add_tags_processor[]
include::{libbeat-processors-dir}/actions/docs/add_tags.asciidoc[]
endif::[]
ifndef::no_community_id_processor[]
include::{libbeat-processors-dir}/communityid/docs/communityid.asciidoc[]
endif::[]
ifndef::no_convert_processor[]
include::{libbeat-processors-dir}/convert/docs/convert.asciidoc[]
endif::[]
ifndef::no_decode_base64_field_processor[]
include::{libbeat-processors-dir}/actions/docs/decode_base64_field.asciidoc[]
ifdef::has_decode_cef_processor[]
endif::[]
ifndef::no_decode_cef_processor[]
include::{x-filebeat-processors-dir}/decode_cef/docs/decode_cef.asciidoc[]
endif::[]
ifdef::has_decode_csv_fields_processor[]
ifndef::no_decode_csv_fields_processor[]
include::{libbeat-processors-dir}/decode_csv_fields/docs/decode_csv_fields.asciidoc[]
endif::[]
ifndef::no_decode_json_fields_processor[]
include::{libbeat-processors-dir}/actions/docs/decode_json_fields.asciidoc[]
endif::[]
ifndef::no_decompress_gzip_field_processor[]
include::{libbeat-processors-dir}/actions/docs/decompress_gzip_field.asciidoc[]
endif::[]
ifndef::no_dissect_processor[]
include::{libbeat-processors-dir}/dissect/docs/dissect.asciidoc[]
endif::[]
ifndef::no_dns_processor[]
include::{libbeat-processors-dir}/dns/docs/dns.asciidoc[]
endif::[]
ifndef::no_drop_event_processor[]
include::{libbeat-processors-dir}/actions/docs/drop_event.asciidoc[]
endif::[]
ifndef::no_drop_fields_processor[]
include::{libbeat-processors-dir}/actions/docs/drop_fields.asciidoc[]
endif::[]
ifndef::no_extract_array_processor[]
include::{libbeat-processors-dir}/extract_array/docs/extract_array.asciidoc[]
endif::[]
ifndef::no_include_fields_processor[]
include::{libbeat-processors-dir}/actions/docs/include_fields.asciidoc[]
endif::[]
ifndef::no_registered_domain_processor[]
include::{libbeat-processors-dir}/registered_domain/docs/registered_domain.asciidoc[]
endif::[]
ifndef::no_rename_processor[]
include::{libbeat-processors-dir}/actions/docs/rename.asciidoc[]
ifdef::has_script_processor[]
endif::[]
ifndef::no_script_processor[]
include::{libbeat-processors-dir}/script/docs/script.asciidoc[]
endif::[]
ifdef::has_timestamp_processor[]
ifndef::no_timestamp_processor[]
include::{libbeat-processors-dir}/timestamp/docs/timestamp.asciidoc[]
endif::[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
ifdef::has_decode_csv_fields_processor[]
[[decode-csv-fields]]
=== Decode CSV fields

Expand Down Expand Up @@ -40,5 +39,3 @@ The `decode_csv_fields` has the following settings:
`fail_on_error`:: (Optional) If set to true, in case of an error the changes to
the event are reverted, and the original event is returned. If set to `false`,
processing continues also if an error happens. Default is `true`.

endif::[]
2 changes: 0 additions & 2 deletions libbeat/processors/script/docs/script.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
ifdef::has_script_processor[]
[[processor-script]]
=== Script Processor

Expand Down Expand Up @@ -167,4 +166,3 @@ thrown.

*Example*: `event.AppendTo("error.message", "invalid file hash");`
|===
endif::[]
2 changes: 0 additions & 2 deletions libbeat/processors/timestamp/docs/timestamp.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
ifdef::has_timestamp_processor[]
[[processor-timestamp]]
=== Timestamp

Expand Down Expand Up @@ -64,4 +63,3 @@ processors:
- drop_fields:
fields: [start_time]
----
endif::[]
4 changes: 4 additions & 0 deletions metricbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:linux_os:
:docker_platform:
:win_os:
:no_decode_cef_processor:
:no_decode_csv_fields_processor:
:no_script_processor:
:no_timestamp_processor:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down
4 changes: 4 additions & 0 deletions packetbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:linux_os:
:docker_platform:
:win_os:
:no_decode_cef_processor:
:no_decode_csv_fields_processor:
:no_script_processor:
:no_timestamp_processor:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down
4 changes: 2 additions & 2 deletions winlogbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:beat_default_index_prefix: {beatname_lc}
:has_registry:
:ignores_max_retries:
:has_script_processor:
:has_timestamp_processor:
:win_os:
:win_only:
:no_decode_cef_processor:
:no_decode_csv_fields_processor:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
ifdef::has_decode_cef_processor[]
[[processor-decode-cef]]
[role="xpack"]
=== Decode CEF
Expand Down Expand Up @@ -36,4 +35,3 @@ The `decode_cef` processor has the following configuration settings.
| `ignore_failure` | no | false | Ignore failures when the source field does not contain a CEF message. |
| `id` | no | | An identifier for this processor instance. Useful for debugging. |
|======
endif::[]
4 changes: 4 additions & 0 deletions x-pack/functionbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:linux_os:
:no_dashboards:
:no_repos:
:no_decode_cef_processor:
:no_decode_csv_fields_processor:
:no_script_processor:
:no_timestamp_processor:

include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[]

Expand Down

0 comments on commit 85a88d4

Please sign in to comment.