From 311aa8c6a8bd13be53b7b0aac03ed36b41a461c1 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Wed, 15 Feb 2017 17:24:48 -0800 Subject: [PATCH] Add doc changes to improve getting started --- filebeat/docs/getting-started.asciidoc | 14 ++++++++++++-- heartbeat/docs/getting-started.asciidoc | 8 +++++++- libbeat/docs/gettingstarted.asciidoc | 9 +++++---- metricbeat/docs/gettingstarted.asciidoc | 10 ++++++++-- packetbeat/docs/gettingstarted.asciidoc | 9 +++++++-- winlogbeat/docs/getting-started.asciidoc | 4 +++- 6 files changed, 42 insertions(+), 12 deletions(-) diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc index 9651cf58c8a..e6c53aa3ea8 100644 --- a/filebeat/docs/getting-started.asciidoc +++ b/filebeat/docs/getting-started.asciidoc @@ -94,7 +94,8 @@ see <>. To configure Filebeat, you edit the configuration file. For rpm and deb, you'll find the configuration file at `/etc/filebeat/filebeat.yml`. For mac and win, look in -the archive that you just extracted. +the archive that you just extracted. There’s also a full example configuration file +called `filebeat.full.yml` that shows all non-deprecated options. Here is a sample of the `filebeat` section of the `filebeat.yml` file. Filebeat uses predefined default values for most configuration options. @@ -166,6 +167,10 @@ include::../../libbeat/docs/shared-template-load.asciidoc[] Start Filebeat by issuing the appropriate command for your platform. +NOTE: If you use an init.d script to start Filebeat on deb or rpm, you can't +specify command line flags (see <>). To specify flags, +start Filebeat in the foreground. + *deb:* [source,shell] @@ -203,7 +208,12 @@ Filebeat is now ready to send log files to your defined output. We don't offer prebuilt dashboards for visualizing Filebeat data. However, to make it easier for you to explore Filebeat data in Kibana, we've created a Filebeat index pattern: `filebeat-*`. To load this pattern, you can use the script -that's provided for importing dashboards. +that's provided for importing dashboards: + +[source,shell] +---------------------------------------------------------------------- +./scripts/import_dashboards -only-index +---------------------------------------------------------------------- For more information about running the script, see {libbeat}/import-dashboards.html[Importing Existing Beat Dashboards] in the _Beats Platform Reference_. diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc index 7ea6344033f..60ceed474c6 100644 --- a/heartbeat/docs/getting-started.asciidoc +++ b/heartbeat/docs/getting-started.asciidoc @@ -108,7 +108,9 @@ options, see <>. To configure Heartbeat, you edit the configuration file. For rpm and deb, you'll find the configuration file at +/etc/heartbeat/heartbeat.yml+. -For mac and win, look in the archive that you just extracted. +For mac and win, look in the archive that you just extracted. There’s also a +full example configuration file called `heartbeat.full.yml` that shows all +non-deprecated options. Heartbeat provides monitors to check the status of hosts at set intervals. You configure each monitor individually. Heartbeat currently provides monitors @@ -185,6 +187,10 @@ include::../../libbeat/docs/shared-template-load.asciidoc[] Start Heartbeat by issuing the appropriate command for your platform. +NOTE: If you use an init.d script to start Heartbeat on deb or rpm, you can't +specify command line flags (see <>). To specify flags, +start Heartbeat in the foreground. + *deb:* ["source","sh",subs="attributes"] diff --git a/libbeat/docs/gettingstarted.asciidoc b/libbeat/docs/gettingstarted.asciidoc index 6435529c247..cbeb893692a 100644 --- a/libbeat/docs/gettingstarted.asciidoc +++ b/libbeat/docs/gettingstarted.asciidoc @@ -112,14 +112,15 @@ You should see a response similar to this: ["source","sh",subs="attributes"] ---------------------------------------------------------------------- { - "name" : "Angela Del Toro", + "name" : "ofgAtrJ", "cluster_name" : "elasticsearch", + "cluster_uuid" : "3h9xSrVlRJmDHgQ8FLnByA", "version" : { "number" : "{ES-version}", - "build_hash" : "8ff36d139e16f8720f2947ef62c8167a888992fe", - "build_timestamp" : "2016-01-27T13:32:39Z", + "build_hash" : "db0d481", + "build_date" : "2017-02-09T22:05:32.386Z", "build_snapshot" : false, - "lucene_version" : "6.1.0" + "lucene_version" : "6.4.1" }, "tagline" : "You Know, for Search" } diff --git a/metricbeat/docs/gettingstarted.asciidoc b/metricbeat/docs/gettingstarted.asciidoc index cc136f5320c..daaff98b19e 100644 --- a/metricbeat/docs/gettingstarted.asciidoc +++ b/metricbeat/docs/gettingstarted.asciidoc @@ -112,7 +112,9 @@ For more information about these options, see To configure Metricbeat, you edit the configuration file. For rpm and deb, you'll find the configuration file at `/etc/metricbeat/metricbeat.yml`. For mac -and win, look in the archive that you just extracted. +and win, look in the archive that you just extracted. There’s also a full +example configuration file called `metricbeat.full.yml` that shows all +non-deprecated options. Metricbeat uses <> to collect metrics. You configure each module individually. The following example shows the default configuration @@ -190,7 +192,11 @@ include::../../libbeat/docs/shared-template-load.asciidoc[] [[metricbeat-starting]] === Step 4: Starting Metricbeat -Run Metricbeat by issuing the following command: +Run Metricbeat by issuing the appropriate command for your platform. + +NOTE: If you use an init.d script to start Metricbeat on deb or rpm, you can't +specify command line flags (see <>). To specify flags, +start Metricbeat in the foreground. *deb:* diff --git a/packetbeat/docs/gettingstarted.asciidoc b/packetbeat/docs/gettingstarted.asciidoc index b0956bbc414..f3227ec210b 100644 --- a/packetbeat/docs/gettingstarted.asciidoc +++ b/packetbeat/docs/gettingstarted.asciidoc @@ -100,7 +100,8 @@ more information about these options, see <>. To configure Packetbeat, you edit the configuration file. For rpm and deb, you'll find the configuration file at `/etc/packetbeat/packetbeat.yml`. For mac and win, look in -the archive that you just extracted. +the archive that you just extracted. There’s also a full example configuration file called +`packetbeat.full.yml` that shows all non-deprecated options. To configure Packetbeat: @@ -204,7 +205,11 @@ include::../../libbeat/docs/shared-template-load.asciidoc[] [[packetbeat-starting]] === Step 4: Starting Packetbeat -Run Packetbeat by issuing the following command: +Run Packetbeat by issuing the command that is appropriate for your platform. + +NOTE: If you use an init.d script to start Packetbeat on deb or rpm, you can't +specify command line flags (see <>). To specify flags, +start Packetbeat in the foreground. *deb:* diff --git a/winlogbeat/docs/getting-started.asciidoc b/winlogbeat/docs/getting-started.asciidoc index 8ce6937f2d2..b929904b27b 100644 --- a/winlogbeat/docs/getting-started.asciidoc +++ b/winlogbeat/docs/getting-started.asciidoc @@ -57,7 +57,9 @@ execution policy for the current session to allow the script to run. For example Before starting Winlogbeat, you should look at the configuration options in the configuration file, for example `C:\Program Files\Winlogbeat\winlogbeat.yml`. -For more information about these options, see <>. +There’s also a full example configuration file called `winlogbeat.full.yml` that +shows all non-deprecated options. For more information about these options, see +<>. [[winlogbeat-configuration]] === Step 2: Configuring Winlogbeat