diff --git a/journalbeat/docs/config-options.asciidoc b/journalbeat/docs/config-options.asciidoc index 4cfdb7d9e093..a52f741c0c8c 100644 --- a/journalbeat/docs/config-options.asciidoc +++ b/journalbeat/docs/config-options.asciidoc @@ -101,7 +101,7 @@ The maximum number of seconds to wait before attempting to read again from journals. The default is 60s. [float] -[id="{beatname_lc}-seek"] +[id="seek"] ==== `seek` The position to start reading the journal from. Valid settings are: @@ -124,7 +124,7 @@ If you have old log files and want to skip lines, start {beatname_uc} with {beatname_uc}. [float] -[id="{beatname_lc}-include-matches"] +[id="include-matches"] ==== `include_matches` A list of filter expressions used to match fields. The format of the expression diff --git a/journalbeat/docs/filtering.asciidoc b/journalbeat/docs/filtering.asciidoc index ef8681b67fa9..1150e70f754a 100644 --- a/journalbeat/docs/filtering.asciidoc +++ b/journalbeat/docs/filtering.asciidoc @@ -7,7 +7,7 @@ metadata). {beatname_uc} provides a couple of options for filtering and enhancing exported data. You can configure {beatname_uc} to include events that match specific filtering -criteria. To do this, use the <<{beatname_lc}-include-matches,`include_matches`>> +criteria. To do this, use the <> option. The advantage of this approach is that you can reduce the number of fields that {beatname_uc} needs to process. diff --git a/journalbeat/docs/general-options.asciidoc b/journalbeat/docs/general-options.asciidoc index 12dfc390b310..c71e4140ece3 100644 --- a/journalbeat/docs/general-options.asciidoc +++ b/journalbeat/docs/general-options.asciidoc @@ -47,14 +47,14 @@ or under `paths`. For a description of this option, see This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see -<<{beatname_lc}-seek,`seek`>>. +<>. [float] ==== `include_matches` deprecated[5.6.1,Use the option under `paths` instead.] This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see -<<{beatname_lc}-include-matches,`include_matches`>>. +<>. include::{libbeat-dir}/docs/generalconfig.asciidoc[] diff --git a/journalbeat/docs/getting-started.asciidoc b/journalbeat/docs/getting-started.asciidoc index a9237c57f4af..e8f1b168fca5 100644 --- a/journalbeat/docs/getting-started.asciidoc +++ b/journalbeat/docs/getting-started.asciidoc @@ -122,15 +122,15 @@ path. For example: + If no paths are specified, {beatname_uc} reads from the default journal. -. Set the <<{beatname_lc}-seek,`seek`>> option to control the position where +. Set the <> option to control the position where {beatname_uc} starts reading the journal. The available options are `head`, `tail`, and `cursor`. The default is `cursor`, which means that on first read, {beatname_uc} starts reading at the beginning of the file, but continues reading at the last known position after a reload or restart. For more detail about the settings, see the reference docs for the -<<{beatname_lc}-seek,`seek` option>>. +<>. -. (Optional) Set the <<{beatname_lc}-include-matches,`include_matches`>> option +. (Optional) Set the <> option to filter entries in journald before collecting any log events. This reduces the number of events that {beatname_uc} needs to process. For example, to fetch only Redis events from a Docker container tagged as `redis`, use: diff --git a/libbeat/docs/monitoring/monitoring-beats.asciidoc b/libbeat/docs/monitoring/monitoring-beats.asciidoc index c750eefbea58..deb7c0b63f82 100644 --- a/libbeat/docs/monitoring/monitoring-beats.asciidoc +++ b/libbeat/docs/monitoring/monitoring-beats.asciidoc @@ -37,7 +37,6 @@ information, see configured the {es} output and want to send {beatname_uc} monitoring events to the same {es} cluster, specify the following minimal configuration: + --- ["source","yml",subs="attributes"] -------------------- monitoring: @@ -46,11 +45,11 @@ monitoring: username: {beat_monitoring_user} password: somepassword -------------------- - ++ If you configured a different output, such as {ls} or you want to send {beatname_uc} monitoring events to a separate {es} cluster (referred to as the _monitoring cluster_), you must specify additional configuration options. For example: - ++ ["source","yml",subs="attributes"] -------------------- monitoring: @@ -62,7 +61,6 @@ monitoring: -------------------- <1> This setting identifies the hosts and port numbers of {es} nodes that are part of the monitoring cluster. --- . {kibana-ref}/monitoring-xpack-kibana.html[Configure monitoring in {kib}]. diff --git a/libbeat/docs/reference-yml.asciidoc b/libbeat/docs/reference-yml.asciidoc index 44361b4fe55d..6aa17c217f22 100644 --- a/libbeat/docs/reference-yml.asciidoc +++ b/libbeat/docs/reference-yml.asciidoc @@ -12,14 +12,14 @@ The contents of the file are included here for your convenience. ifndef::has_xpack[] [source,yaml] --- +---- include::../../{beatname_lc}/{beatname_lc}.reference.yml[] --- +---- endif::has_xpack[] ifdef::has_xpack[] [source,yaml] --- +---- include::../../x-pack/{beatname_lc}/{beatname_lc}.reference.yml[] --- +---- endif::has_xpack[] diff --git a/libbeat/docs/shared-central-management.asciidoc b/libbeat/docs/shared-central-management.asciidoc index 0ea05773a821..54770c0b5857 100644 --- a/libbeat/docs/shared-central-management.asciidoc +++ b/libbeat/docs/shared-central-management.asciidoc @@ -2,10 +2,6 @@ [role="xpack"] = {beats} central management -++++ -Central management -++++ - [partintro] -- diff --git a/libbeat/docs/step-configure-output.asciidoc b/libbeat/docs/step-configure-output.asciidoc index fc2dff5b92d6..b50673990dca 100644 --- a/libbeat/docs/step-configure-output.asciidoc +++ b/libbeat/docs/step-configure-output.asciidoc @@ -7,12 +7,10 @@ to {es}, or to {ls} for additional processing. To send output directly to {es} (without using {ls}), set the location of the {es} installation: + --- endif::only-elasticsearch[] ifdef::only-elasticsearch[] . Configure the {es} output by setting the location of the {es} installation: + --- endif::only-elasticsearch[] endif::has_module_steps[] * If you're running our @@ -33,7 +31,6 @@ output.elasticsearch: hosts: ["myEShost:9200"] ---------------------------------------------------------------------- ifndef::has_module_steps[] --- + ifndef::only-elasticsearch[] To send output to {ls}, diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc index 57ccb7f095bb..5b9838f88e6b 100644 --- a/metricbeat/docs/modules_list.asciidoc +++ b/metricbeat/docs/modules_list.asciidoc @@ -3,7 +3,7 @@ This file is generated! See scripts/docs_collector.py //// [options="header"] -|=================================== +|=== |Modules |Dashboards |Metricsets |<> |image:./images/icon-no.png[No prebuilt dashboards] | .1+| .1+| |<> @@ -173,7 +173,7 @@ This file is generated! See scripts/docs_collector.py .3+| .3+| |<> beta[] |<> |<> -|================================ +|=== -- diff --git a/metricbeat/scripts/docs_collector.py b/metricbeat/scripts/docs_collector.py index 265163a3b69a..24266026545e 100644 --- a/metricbeat/scripts/docs_collector.py +++ b/metricbeat/scripts/docs_collector.py @@ -208,7 +208,7 @@ def collect(beat_name): module_list_output = generated_note module_list_output += '[options="header"]\n' - module_list_output += '|===================================\n' + module_list_output += '|===\n' module_list_output += '|Modules |Dashboards |Metricsets \n' for key, m in sorted(six.iteritems(modules_list)): @@ -235,7 +235,7 @@ def collect(beat_name): module_list_output += '|{} {} \n'.format(ms["link"], release_label) - module_list_output += '|================================' + module_list_output += '|===' module_list_output += "\n\n--\n\n" for key, m in sorted(six.iteritems(modules_list)): diff --git a/packetbeat/docs/packetbeat-filtering.asciidoc b/packetbeat/docs/packetbeat-filtering.asciidoc index 9cdff1662aed..4fefe9b0bc9e 100644 --- a/packetbeat/docs/packetbeat-filtering.asciidoc +++ b/packetbeat/docs/packetbeat-filtering.asciidoc @@ -7,7 +7,7 @@ For example, the following configuration includes a subset of the Packetbeat DNS fields so that only the requests and their response codes are reported: [source, yaml] ------------------------------------------------------ +---- processors: - include_fields: fields: @@ -18,12 +18,12 @@ processors: - dns.question.name - dns.question.etld_plus_one - dns.response_code ------------------------------------------------------ +---- The filtered event would look something like this: [source,shell] ------------------------------------------------------ +---- { "@timestamp": "2019-01-19T03:41:11.798Z", "client": { @@ -43,31 +43,31 @@ The filtered event would look something like this: }, "type": "dns" } ------------------------------------------------------ +---- If you would like to drop all the successful transactions, you can use the following configuration: [source,yaml] ------------- +---- processors: - drop_event: when: equals: http.response.status_code: 200 ------------ +---- If you don't want to export raw data for the successful transactions: [source,yaml] ------------- +---- processors: - drop_fields: when: equals: http.response.status_code: 200 fields: ["request", "response"] ------------- +---- include::{libbeat-dir}/docs/processors-using.asciidoc[]