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

[6.8][DOCS] Backport: Fix asciidoctor build #13502

Merged
merged 6 commits into from
Sep 5, 2019
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
8 changes: 4 additions & 4 deletions auditbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3061,6 +3061,8 @@ type: text

The path to the file.

--

*`file.path.raw`*::
+
--
Expand All @@ -3069,8 +3071,6 @@ type: keyword
The path to the file. This is a non-analyzed field that is useful for aggregations.


--

--

*`file.target_path`*::
Expand Down Expand Up @@ -3214,6 +3214,8 @@ type: text
An array of strings describing a possible external origin for this file. For example, the URL it was downloaded from. Only supported in macOS, via the kMDItemWhereFroms attribute. Omitted if origin information is not available.


--

*`file.origin.raw`*::
+
--
Expand All @@ -3222,8 +3224,6 @@ type: keyword
This is a non-analyzed field that is useful for aggregations on the origin data.


--

--

[float]
Expand Down
4 changes: 2 additions & 2 deletions docs/devguide/migrate-dashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ dashboards:
Using the yml file, you can export all the dashboards for a single module or for the entire Beat using a single command:

[source,shell]
------------------
----
cd metricbeat/module/system
go run ../../../dev-tools/cmd/dashboards/export_dashboards.go -yml module.yml
-------------------
----

12 changes: 6 additions & 6 deletions docs/devguide/newdashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The `setup` phase loads:
For more details about the `setup` command, run the following:

[source,shell]
-------------------------
----
./metricbeat help setup

This command does initial setup of the environment:
Expand All @@ -73,15 +73,15 @@ Flags:
--machine-learning Setup machine learning job configurations only
--modules string List of enabled modules (comma separated)
--template Setup index template only
---------------------------
----

The flags are useful when you don't want to load everything. For example, to
import only the dashboards, use the `--dashboards` flag:

[source,shell]
---------------------
----
./metricbeat setup --dashboards
-------------------------------
----

Starting with Beats 6.0.0, the dashboards are no longer loaded directly into Elasticsearch. Instead, they are imported directly into Kibana.
Thus, if your Kibana instance is not listening on localhost, or you enabled
Expand All @@ -90,9 +90,9 @@ the config for the Beat, or pass the Kibana host and credentials as
arguments to the `setup` command. For example:

[source,shell]
-------------------------
----
./metricbeat setup -E setup.kibana.host=192.168.3.206:5601 -E setup.kibana.username=elastic -E setup.kibana.password=secret
--------------------------
----

By default, the `setup` command imports the dashboards from the `kibana`
directory, which is available in the Beat package.
Expand Down
4 changes: 4 additions & 0 deletions filebeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:has_ml_jobs: yes
:has_central_config:
:has_solutions:
:ignores_max_retries:
:has_docker_label_ex:
:has_modules_command:
:has_registry:
:deb_os:
:rpm_os:
:mac_os:
Expand Down
4 changes: 2 additions & 2 deletions heartbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,8 @@ type: text
Service url used by monitor.


--

*`http.url.raw`*::
+
--
Expand All @@ -633,8 +635,6 @@ type: keyword
The service url used by monitor. This is a non-analyzed field that is useful for aggregations.


--

--

[float]
Expand Down
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 @@ -123,15 +123,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
16 changes: 8 additions & 8 deletions libbeat/docs/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,31 +80,31 @@ endif::[]
[options="header"]
|=======================
|Commands |
ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
|<<deploy-command,`deploy`>> | {deploy-command-short-desc}.
endif::[]
|<<export-command,`export`>> |{export-command-short-desc}.
|<<help-command,`help`>> |{help-command-short-desc}.
|<<keystore-command,`keystore`>> |{keystore-command-short-desc}.
ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
|<<package-command,`package`>> |{package-command-short-desc}.
|<<remove-command,`remove`>> |{remove-command-short-desc}.
endif::[]
ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="metricbeat")]
ifdef::has_modules_command[]
|<<modules-command,`modules`>> |{modules-command-short-desc}.
endif::[]
|<<run-command,`run`>> |{run-command-short-desc}.
|<<setup-command,`setup`>> |{setup-command-short-desc}.
|<<test-command,`test`>> |{test-command-short-desc}.
ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
|<<update-command,`update`>> |{update-command-short-desc}.
endif::[]
|<<version-command,`version`>> |{version-command-short-desc}.
|=======================

Also see <<global-flags,Global flags>>.

ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
[[deploy-command]]
==== `deploy` command

Expand Down Expand Up @@ -302,7 +302,7 @@ Shows help for the `keystore` command.

See <<keystore>> for more examples.

ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
[[package-command]]
==== `package` command

Expand Down Expand Up @@ -364,7 +364,7 @@ Shows help for the `remove` command.
-----
endif::[]

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="metricbeat")]
ifdef::has_modules_command[]
[[modules-command]]
==== `modules` command

Expand Down Expand Up @@ -717,7 +717,7 @@ ifeval::["{beatname_lc}"=="metricbeat"]
-----
endif::[]

ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
[[update-command]]
==== `update` command

Expand Down
17 changes: 7 additions & 10 deletions libbeat/docs/monitoring/monitoring-beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,31 +36,28 @@ information, see
. Add the `xpack.monitoring` settings in the {beatname_uc} configuration file. If you
configured {es} output, specify the following minimal configuration:
+
--
[source, yml]
--------------------
----
xpack.monitoring.enabled: true
--------------------

----
+
If you configured a different output, such as {ls}, you must specify additional
configuration options. For example:

+
["source","yml",subs="attributes"]
--------------------
----
xpack.monitoring:
enabled: true
elasticsearch:
hosts: ["https://example.com:9200", "https://example2.com:9200"]
username: {beat_monitoring_user}
password: somepassword
--------------------

----
+
NOTE: Currently you must send monitoring data to the same cluster as all other events.
If you configured {es} output, do not specify additional hosts in the monitoring
configuration.

--

. {kibana-ref}/monitoring-xpack-kibana.html[Configure monitoring in {kib}].

. To verify your monitoring configuration, point your web browser at your {kib}
Expand Down
32 changes: 8 additions & 24 deletions libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -441,21 +441,17 @@ endif::[]

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]


Expand Down Expand Up @@ -717,21 +713,17 @@ The number of seconds to wait for responses from the Logstash server before timi

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]

===== `bulk_max_size`
Expand Down Expand Up @@ -947,21 +939,17 @@ brokers, topics, partition, and active leaders to use for publishing.

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]

===== `bulk_max_size`
Expand Down Expand Up @@ -1211,21 +1199,17 @@ Redis after a network error. The default is 60s.

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::["{beatname_lc}"!="filebeat" and "{beatname_lc}"!="winlogbeat"]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]


Expand Down
6 changes: 5 additions & 1 deletion libbeat/docs/processors-using.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ ifeval::["{beatname_lc}"=="filebeat"]
:processor-scope: input
endif::[]

ifeval::["{beatname_lc}"=="auditbeat" or "{beatname_lc}"=="metricbeat"]
ifeval::["{beatname_lc}"=="auditbeat"]
:processor-scope: module
endif::[]

ifeval::["{beatname_lc}"=="metricbeat"]
:processor-scope: module
endif::[]

Expand Down
Loading