Skip to content
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
4 changes: 2 additions & 2 deletions journalbeat/docs/config-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion journalbeat/docs/filtering.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<include-matches,`include_matches`>>
option. The advantage of this approach is that you can reduce the number of
fields that {beatname_uc} needs to process.

Expand Down
4 changes: 2 additions & 2 deletions journalbeat/docs/general-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`>>.
<<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-matches,`include_matches`>>.

include::{libbeat-dir}/docs/generalconfig.asciidoc[]

6 changes: 3 additions & 3 deletions journalbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<seek,`seek`>> 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>>.
<<seek,`seek` option>>.

. (Optional) Set the <<{beatname_lc}-include-matches,`include_matches`>> option
. (Optional) Set the <<include-matches,`include_matches`>> 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:
Expand Down
6 changes: 2 additions & 4 deletions libbeat/docs/monitoring/monitoring-beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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}].

Expand Down
8 changes: 4 additions & 4 deletions libbeat/docs/reference-yml.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
4 changes: 0 additions & 4 deletions libbeat/docs/shared-central-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
[role="xpack"]
= {beats} central management

++++
<titleabbrev>Central management</titleabbrev>
++++

[partintro]
--

Expand Down
3 changes: 0 additions & 3 deletions libbeat/docs/step-configure-output.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -33,7 +31,6 @@ output.elasticsearch:
hosts: ["myEShost:9200"]
----------------------------------------------------------------------
ifndef::has_module_steps[]
--
+
ifndef::only-elasticsearch[]
To send output to {ls},
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This file is generated! See scripts/docs_collector.py
////

[options="header"]
|===================================
|===
|Modules |Dashboards |Metricsets
|<<metricbeat-module-aerospike,Aerospike>> |image:./images/icon-no.png[No prebuilt dashboards] |
.1+| .1+| |<<metricbeat-metricset-aerospike-namespace,namespace>>
Expand Down Expand Up @@ -173,7 +173,7 @@ This file is generated! See scripts/docs_collector.py
.3+| .3+| |<<metricbeat-metricset-zookeeper-connection,connection>> beta[]
|<<metricbeat-metricset-zookeeper-mntr,mntr>>
|<<metricbeat-metricset-zookeeper-server,server>>
|================================
|===

--

Expand Down
4 changes: 2 additions & 2 deletions metricbeat/scripts/docs_collector.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)):
Expand All @@ -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)):
Expand Down
16 changes: 8 additions & 8 deletions packetbeat/docs/packetbeat-filtering.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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": {
Expand All @@ -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[]