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

Backport to 6.0: Fix getting started (#5326) #5573

Merged
merged 3 commits into from
Nov 14, 2017
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
1 change: 1 addition & 0 deletions auditbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ The following topics describe how to configure {beatname_uc}:
* <<configuration-logging>>
* <<using-environ-vars>>
* <<yaml-tips>>
* <<{beatname_lc}-reference-yml>>

After changing configuration settings, you need to restart {beatname_uc} to
pick up the changes.
Expand Down
3 changes: 1 addition & 2 deletions auditbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ install, configure, and run {beatname_uc}:
* <<load-kibana-dashboards>>
* <<{beatname_lc}-starting>>
* <<view-kibana-dashboards>>
* <<command-line-options>>
* <<directory-layout>>
* <<setup-repositories>>

[id="{beatname_lc}-installation"]
=== Step 1: Install {beatname_uc}
Expand Down
7 changes: 4 additions & 3 deletions filebeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The following topics describe how to configure Filebeat:
* <<filebeat-configuration-reloading>>
* <<configuring-internal-queue>>
* <<configuring-output>>
* <<load-balancing>>
* <<configuration-ssl>>
* <<filtering-and-enhancing-data>>
* <<configuring-ingest-node>>
Expand All @@ -35,9 +36,9 @@ The following topics describe how to configure Filebeat:
* <<configuration-template>>
* <<configuration-logging>>
* <<using-environ-vars>>
* <<load-balancing>>
* <<yaml-tips>>
* <<regexp-support>>
* <<{beatname_lc}-reference-yml>>

--

Expand All @@ -58,10 +59,10 @@ include::../../libbeat/docs/queueconfig.asciidoc[]

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

include::../../libbeat/docs/shared-ssl-config.asciidoc[]

include::./load-balancing.asciidoc[]

include::../../libbeat/docs/shared-ssl-config.asciidoc[]

include::./filebeat-filtering.asciidoc[]

include::../../libbeat/docs/shared-config-ingest.asciidoc[]
Expand Down
3 changes: 3 additions & 0 deletions filebeat/docs/filebeat-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,9 @@ json.add_error_key: true
json.message_key: log
-------------------------------------------------------------------------------------

You must specify at least one of the following settings to enable JSON parsing
mode:

*`keys_under_root`*:: By default, the decoded JSON is placed under a "json" key in the output document.
If you enable this setting, the keys are copied top level in the output document. The default is false.

Expand Down
2 changes: 0 additions & 2 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ After installing the Elastic Stack, read the following topics to learn how to in
* <<filebeat-starting>>
* <<view-kibana-dashboards>>
* <<filebeat-modules-quickstart>>
* <<command-line-options>>
* <<directory-layout>>
* <<setup-repositories>>

[[filebeat-installation]]
Expand Down
8 changes: 4 additions & 4 deletions filebeat/docs/load-balancing.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[load-balancing]]
=== Load balance the output hosts
== Load balance the output hosts

Filebeat provides configuration options that you can use to fine
tune load balancing when sending events to multiple hosts.
Expand All @@ -21,9 +21,9 @@ The load balancer also supports multiple workers per host. The default is
`worker: 1`. If you increase the number of workers, additional network
connections will be used. The total number of workers participating
in load balancing is `number of hosts * workers`.
+

Example:
+

[source,yaml]
-------------------------------------------------------------------------------
filebeat.prospectors:
Expand All @@ -35,5 +35,5 @@ output.logstash:
loadbalance: true
worker: 2
-------------------------------------------------------------------------------
+

In this example, there are 4 workers participating in load balancing.
11 changes: 5 additions & 6 deletions filebeat/docs/modules-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,12 @@ the sample dashboards for visualizing the data in Kibana. For example:
./filebeat setup -e
----------------------------------------------------------------------
+
The value that you pass with the `--modules` flag is a comma-separated list of
modules that you want to set up. The `-e` flag is optional and sends output
to standard error instead of syslog.
The `-e` flag is optional and sends output to standard error instead of syslog.

. Start Filebeat and use the `--modules` flag to specify the list of modules
you want to run. The following example starts Filebeat with the `system` module
enabled (it's assumed that you've already loaded the sample dashboards):
. Start Filebeat and use the `--modules` flag to specify a comma-separated list
of modules you want to run. The following example starts Filebeat with the
`system` module enabled (it's assumed that you've already loaded the sample
dashboards):
+
[source,shell]
----------------------------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions heartbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ The following topics describe how to configure Heartbeat:
* <<using-environ-vars>>
* <<yaml-tips>>
* <<regexp-support>>
* <<{beatname_lc}-reference-yml>>

--

Expand Down
3 changes: 1 addition & 2 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ install, configure, and run Heartbeat:
* <<load-kibana-dashboards>>
* <<heartbeat-starting>>
* <<view-kibana-dashboards>>
* <<command-line-options>>
* <<directory-layout>>
* <<setup-repositories>>


[[heartbeat-installation]]
Expand Down
1 change: 1 addition & 0 deletions libbeat/docs/config-file-format.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ The following topics provide more detail to help you understand and work with co
* <<config-file-format-type>>
* <<config-file-format-env-vars>>
* <<config-gile-format-refs>>
* <<config-file-permissions>>
* <<config-file-format-cli>>
* <<config-file-format-tips>>

Expand Down
12 changes: 10 additions & 2 deletions libbeat/docs/shared-template-load.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,16 +105,24 @@ PS > {beatname_lc} setup --template
----------------------------------------------------------------------


NOTE: If you've already used {beatname_uc} to index data into Elasticsearch,
[NOTE]
=====
If you've already used {beatname_uc} to index data into Elasticsearch,
the index may contain old documents. After you load the index template,
you can delete the old documents from {beatname_lc}-* to force Kibana to look
you can delete the old documents from +{beatname_lc}-*+ to force Kibana to look
at the newest documents. Use this command:

["source","sh",subs="attributes"]
----------------------------------------------------------------------
curl -XDELETE 'http://localhost:9200/{beatname_lc}-*'
----------------------------------------------------------------------

This command will delete all indexes that match the pattern +{beatname_lc}-*+.
Before running this command, make sure you want to delete all indexes that
match the pattern.

=====

[[passing-credentials-template-loading]]
==== Pass credentials

Expand Down
1 change: 1 addition & 0 deletions metricbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ The following topics describe how to configure Metricbeat:
* <<using-environ-vars>>
* <<yaml-tips>>
* <<regexp-support>>
* <<{beatname_lc}-reference-yml>>

--

Expand Down
3 changes: 1 addition & 2 deletions metricbeat/docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ After installing the Elastic Stack, read the following topics to learn how to in
* <<load-kibana-dashboards>>
* <<metricbeat-starting>>
* <<view-kibana-dashboards>>
* <<command-line-options>>
* <<directory-layout>>
* <<setup-repositories>>

[[metricbeat-installation]]
=== Step 1: Install Metricbeat
Expand Down
1 change: 1 addition & 0 deletions packetbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ The following topics describe how to configure Packetbeat:
* <<configuration-logging>>
* <<using-environ-vars>>
* <<yaml-tips>>
* <<{beatname_lc}-reference-yml>>

--

Expand Down
3 changes: 1 addition & 2 deletions packetbeat/docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ After installing the Elastic Stack, read the following topics to learn how to in
* <<load-kibana-dashboards>>
* <<packetbeat-starting>>
* <<view-kibana-dashboards>>
* <<command-line-options>>
* <<directory-layout>>
* <<setup-repositories>>

[[packetbeat-installation]]
=== Step 1: Install Packetbeat
Expand Down
1 change: 1 addition & 0 deletions winlogbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ The following topics describe how to configure Winlogbeat:
* <<configuration-logging>>
* <<using-environ-vars>>
* <<yaml-tips>>
* <<{beatname_lc}-reference-yml>>

--

Expand Down
2 changes: 0 additions & 2 deletions winlogbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ After installing the Elastic Stack, read the following topics to learn how to in
* <<load-kibana-dashboards>>
* <<winlogbeat-starting>>
* <<view-kibana-dashboards>>
* <<command-line-options>>
* <<directory-layout>>

[[winlogbeat-installation]]
=== Step 1: Install Winlogbeat
Expand Down