diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc index 371d96594830..7649170d1206 100644 --- a/filebeat/docs/getting-started.asciidoc +++ b/filebeat/docs/getting-started.asciidoc @@ -30,7 +30,7 @@ Filebeat provides a set of pre-built modules that you can use to rapidly implement and deploy a log monitoring solution, complete with sample dashboards and data visualizations, in about 5 minutes. These modules support common log formats, such as Nginx, Apache2, and MySQL, and can be run by issuing a simple -command. +command. This topic shows you how to run the basic modules out of the box without extra configuration. For detailed documentation and the full list of available @@ -43,12 +43,12 @@ type that isn't supported by one of the available Filebeat modules. Before running Filebeat with modules enabled, you need to: -* Install and configure the Elastic stack. See +* Install and configure the Elastic stack. See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack]. * Complete the Filebeat installation instructions described in <>. After installing Filebeat, return to this -quick start page. +quick start page. * Install the Ingest Node GeoIP and User Agent plugins, which you can do by running the following commands in the Elasticsearch home path: @@ -83,9 +83,9 @@ For subsequent runs of Filebeat, do not specify this flag. NOTE: Depending on how you've installed Filebeat, you might see errors related to file ownership or permissions when you try to run Filebeat modules. -See {libbeat}config-file-permissions.html[Config File Ownership and Permissions] +See {libbeat}/config-file-permissions.html[Config File Ownership and Permissions] in the _Beats Platform Reference_ if you encounter errors related to file -ownership or permissions. +ownership or permissions. The following example starts Filebeat with the `system` module enabled and loads the sample Kibana dashboards: @@ -97,7 +97,7 @@ filebeat -e -modules=system -setup This command takes care of configuring Filebeat, loading the recommended index template for writing to Elasticsearch, and deploying the sample dashboards -for visualizing the data in Kibana. +for visualizing the data in Kibana. To start Filebeat with the `system`, `nginx`, and `mysql` modules enabled and load the sample dashboards, run: @@ -132,7 +132,7 @@ After you've confirmed that Filebeat is sending events to Elasticsearch, launch the Kibana web interface by pointing your browser to port 5601. For example, http://127.0.0.1:5601[http://127.0.0.1:5601]. -Open the dashboard and explore the visualizations for your parsed logs. +Open the dashboard and explore the visualizations for your parsed logs. Here's an example of the syslog dashboard: @@ -141,7 +141,7 @@ image:./images/kibana-system.png[Sylog dashboard] [[filebeat-installation]] === Step 1: Installing Filebeat -Before running Filebeat, you need to install and configure the Elastic stack. See +Before running Filebeat, you need to install and configure the Elastic stack. See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack]. To download and install Filebeat, use the commands that work with your system @@ -338,7 +338,7 @@ include::../../libbeat/docs/shared-template-load.asciidoc[] [[filebeat-starting]] === Step 5: Starting Filebeat -Start Filebeat by issuing the appropriate command for your platform. +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, @@ -367,7 +367,7 @@ sudo ./filebeat -e -c filebeat.yml -d "publish" ---------------------------------------------------------------------- <1> You'll be running Filebeat as root, so you need to change ownership of the configuration file (see -{libbeat}config-file-permissions.html[Config File Ownership and Permissions] +{libbeat}/config-file-permissions.html[Config File Ownership and Permissions] in the _Beats Platform Reference_). *win:* diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc index 05584a34b91d..6f4ca85bc6db 100644 --- a/heartbeat/docs/getting-started.asciidoc +++ b/heartbeat/docs/getting-started.asciidoc @@ -7,7 +7,7 @@ related products: * Elasticsearch for storage and indexing the data. * Kibana for the UI. * Logstash (optional) for inserting data into Elasticsearch. - + See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack] for more information. @@ -28,9 +28,9 @@ install, configure, and run Heartbeat: Unlike most Beats, which you install on edge nodes, you typically install Heartbeat as part of monitoring service that runs on a separate machine and possibly even outside of the network where the services that you want to -monitor are running. +monitor are running. -//TODO: Add a separate topic that explores deployment scenarios in more detail (like installing on a sub-network where there's a firewall etc. +//TODO: Add a separate topic that explores deployment scenarios in more detail (like installing on a sub-network where there's a firewall etc. To download and install Heartbeat, use the commands that work with your system (<> for Debian/Ubuntu, <> for Redhat/Centos/Fedora, @@ -165,8 +165,8 @@ monitor: [source,yaml] ---------------------------------------------------------------------- heartbeat.monitors: -- type: icmp - schedule: '*/5 * * * * * *' +- type: icmp + schedule: '*/5 * * * * * *' hosts: ["myhost"] output.elasticsearch: hosts: ["myhost:9200"] @@ -184,7 +184,7 @@ heartbeat.monitors: - type: icmp schedule: '*/5 * * * * * *' <1> hosts: ["myhost"] -- type: tcp +- type: tcp schedule: '@every 5s' <2> hosts: ["myhost:12345"] mode: any <3> @@ -258,7 +258,7 @@ sudo ./heartbeat -e -c heartbeat.yml -d "publish" ---------------------------------------------------------------------- <1> You'll be running Heartbeat as root, so you need to change ownership of the configuration file (see -{libbeat}config-file-permissions.html[Config File Ownership and Permissions] +{libbeat}/config-file-permissions.html[Config File Ownership and Permissions] in the _Beats Platform Reference_). *win:* diff --git a/metricbeat/docs/gettingstarted.asciidoc b/metricbeat/docs/gettingstarted.asciidoc index c3b737d0bdb5..5d57427876b7 100644 --- a/metricbeat/docs/gettingstarted.asciidoc +++ b/metricbeat/docs/gettingstarted.asciidoc @@ -11,7 +11,7 @@ related products: * Kibana for the UI. * Logstash (optional) for inserting data into Elasticsearch. -See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack] for more information. +See {libbeat}/getting-started.html[Getting Started with Beats and the Elastic Stack] for more information. After installing the Elastic Stack, read the following topics to learn how to install, configure, and run Metricbeat: @@ -179,7 +179,7 @@ metricbeat.modules: enabled: true period: 10s processes: ['.*'] - cpu_ticks: false + cpu_ticks: false ------------------------------------- The following example shows how to configure two modules: the system module @@ -198,7 +198,7 @@ metricbeat.modules: enabled: true period: 10s processes: ['.*'] - cpu_ticks: false + cpu_ticks: false - module: apache metricsets: ["status"] enabled: true @@ -264,7 +264,7 @@ sudo ./metricbeat -e -c metricbeat.yml -d "publish" ---------------------------------------------------------------------- <1> You'll be running Metricbeat as root, so you need to change ownership of the configuration file (see -{libbeat}config-file-permissions.html[Config File Ownership and Permissions] +{libbeat}/config-file-permissions.html[Config File Ownership and Permissions] in the _Beats Platform Reference_). *win:* diff --git a/packetbeat/docs/gettingstarted.asciidoc b/packetbeat/docs/gettingstarted.asciidoc index b5a1962d3e92..155735d53c6e 100644 --- a/packetbeat/docs/gettingstarted.asciidoc +++ b/packetbeat/docs/gettingstarted.asciidoc @@ -279,8 +279,8 @@ sudo chown root packetbeat.yml <1> sudo ./packetbeat -e -c packetbeat.yml -d "publish" ---------------------------------------------------------------------- <1> You'll be running Packetbeat as root, so you need to change ownership -of the configuration file (see -{libbeat}config-file-permissions.html[Config File Ownership and Permissions] +of the configuration file (see +{libbeat}/config-file-permissions.html[Config File Ownership and Permissions] in the _Beats Platform Reference_). *win:*