From 3bedad841d45d60882812d830ce638a40e17a0c6 Mon Sep 17 00:00:00 2001 From: Marius Dragomir Date: Tue, 2 May 2017 11:54:19 +0300 Subject: [PATCH 1/7] Fix typo in port number (#4139) --- .../docs/reference/configuration/winlogbeat-options.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc b/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc index 0c7e7c3232e..45d3a10e74e 100644 --- a/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc +++ b/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc @@ -332,7 +332,7 @@ The hostname and port where the Beat will host an HTTP web service that provides metrics. This field is optional. The following example specifies that the metrics service is available at -http://localhost:8128/debug/vars: +http://localhost:8123/debug/vars: [source,yaml] -------------------------------------------------------------------------------- From f54e4381ec27d69fe8e3429e01fe03f45b3ea3b1 Mon Sep 17 00:00:00 2001 From: Christian Galsterer Date: Mon, 1 May 2017 10:20:56 +0200 Subject: [PATCH 2/7] [#4154] Wrong "make collect" statement documented instead of "make update" when documentation should be regenerated (#4155) --- metricbeat/docs/developer-guide/create-module.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metricbeat/docs/developer-guide/create-module.asciidoc b/metricbeat/docs/developer-guide/create-module.asciidoc index d69e47251da..135153afee4 100644 --- a/metricbeat/docs/developer-guide/create-module.asciidoc +++ b/metricbeat/docs/developer-guide/create-module.asciidoc @@ -15,7 +15,7 @@ metricset by running `make create-metricset`, default versions of these files ar * `docs.asciidoc` * `fields.yml` -After updating any of these files, make sure you run `make collect` in your beat directory so all generated +After updating any of these files, make sure you run `make update` in your beat directory so all generated files are updated. From 21fdf708df930aaf4661fa87f396d6dd8f7b2eb5 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Tue, 2 May 2017 19:26:56 -0700 Subject: [PATCH 3/7] Add info about official Beats docker image Add link to repo --- .../docs/metricbeat-in-a-container.asciidoc | 27 ++++++++++++++----- 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/metricbeat/docs/metricbeat-in-a-container.asciidoc b/metricbeat/docs/metricbeat-in-a-container.asciidoc index b4b081be0bc..d15a43b36f4 100644 --- a/metricbeat/docs/metricbeat-in-a-container.asciidoc +++ b/metricbeat/docs/metricbeat-in-a-container.asciidoc @@ -1,8 +1,23 @@ [[running-in-container]] == Running Metricbeat in a Container -Elastic does not provide any official container images for Metricbeat. The -examples on this page assume you are using your own Metricbeat container image. +ifeval::["{release-state}"=="released"] + +[NOTE] +================================================== +The https://github.com/elastic/beats-docker[official Docker images] for Beats +are available from the Elastic Docker registry. To retrieve the images, simply +issue the `docker pull` command: + ++docker pull docker.elastic.co/beats/metricbeat:{stack-version}+. + +The images are currently under development and should be considered +alpha-quality. We strongly recommend that you do not run these images +in a production environment. + +================================================== + +endif::[] When executing Metricbeat in a container, there are some important things to be aware of if you want to monitor the host machine or other @@ -17,14 +32,14 @@ This example highlights the changes required to make the system module work properly inside of a container. This enables Metricbeat to monitor the host machine from within the container. -[source,sh] +["source","sh",subs="attributes"] ---- sudo docker run \ --volume=/proc:/hostfs/proc:ro \ <1> --volume=/sys/fs/cgroup:/hostfs/sys/fs/cgroup:ro \ <2> --volume=/:/hostfs:ro \ <3> --net=host <4> - my/metricbeat:latest -system.hostfs=/hostfs + docker.elastic.co/beats/metricbeat:{stack-version} -system.hostfs=/hostfs ---- <1> Metricbeat's <> collects much of its data through the Linux proc @@ -54,12 +69,12 @@ to `/hostfs/proc` is not sufficient. Next let's look at an example of monitoring a containerized service from a Metricbeat container. -[source,sh] +["source","sh",subs="attributes"] ---- sudo docker run \ --link some-mysql:mysql \ <1> -e MYSQL_PASSWORD=secret \ <2> - my/metricbeat:latest + docker.elastic.co/beats/metricbeat:{stack-version}  ---- <1> Linking the containers enables Metricbeat access the exposed ports of the From ffd3efb6fb722999144558c744c6ab73e7740fbb Mon Sep 17 00:00:00 2001 From: Panos Georgiadis Date: Thu, 4 May 2017 08:47:47 +0200 Subject: [PATCH 4/7] Replace wrong command (chown) with chmod (#4194) --- libbeat/docs/config-file-format.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libbeat/docs/config-file-format.asciidoc b/libbeat/docs/config-file-format.asciidoc index 9a08649d824..dad5ada7970 100644 --- a/libbeat/docs/config-file-format.asciidoc +++ b/libbeat/docs/config-file-format.asciidoc @@ -351,7 +351,7 @@ writable by the owner but the permissions are "-rw-rw-r--" (to fix the permissions use: 'chmod go-w /etc/{beatname}/{beatname}.yml') -------------------------------------------------------------------------------- -To correct this problem, use `chown go-w /etc/{beatname}/{beatname}.yml` to +To correct this problem, use `chmod go-w /etc/{beatname}/{beatname}.yml` to remove write privileges from anyone other than the owner. ==== Disabling Strict Permission Checks From 33c13bd0c6e84208be97481827a91f85934f4d3b Mon Sep 17 00:00:00 2001 From: markwalkom Date: Thu, 4 May 2017 16:58:39 +1000 Subject: [PATCH 5/7] Update overview.asciidoc (#4195) Added a few "local" mentions in to make it clearer that filebeat reads local files only. --- filebeat/docs/overview.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/filebeat/docs/overview.asciidoc b/filebeat/docs/overview.asciidoc index 4e4628ffe8f..619391487c1 100644 --- a/filebeat/docs/overview.asciidoc +++ b/filebeat/docs/overview.asciidoc @@ -1,10 +1,10 @@ [[filebeat-overview]] == Overview -Filebeat is a log data shipper. Installed as an agent on your servers, Filebeat monitors the log directories or specific log files, tails the files, +Filebeat is a log data shipper for local files. Installed as an agent on your servers, Filebeat monitors the log directories or specific log files, tails the files, and forwards them either to https://www.elastic.co/products/elasticsearch[Elasticsearch] or https://www.elastic.co/products/logstash[Logstash] for indexing. -Here's how Filebeat works: When you start Filebeat, it starts one or more prospectors that look in the paths you've specified for log files. For each log file that the prospector locates, Filebeat starts a harvester. Each harvester reads a single log file for new content and sends the new log data to the spooler, which aggregates the events and sends the aggregated data to the output that you've configured for Filebeat. +Here's how Filebeat works: When you start Filebeat, it starts one or more prospectors that look in the local paths you've specified for log files. For each log file that the prospector locates, Filebeat starts a harvester. Each harvester reads a single log file for new content and sends the new log data to the spooler, which aggregates the events and sends the aggregated data to the output that you've configured for Filebeat. image:./images/filebeat.png[Beats design] From 59c71eaa0abcc3f5159ba47c595e9a66b57dabda Mon Sep 17 00:00:00 2001 From: markwalkom Date: Thu, 4 May 2017 20:31:37 +1000 Subject: [PATCH 6/7] Update how-filebeat-works.asciidoc (#4196) A further clarification to #4195, to point out filebeat handles local files only. * Update how-filebeat-works.asciidoc --- filebeat/docs/how-filebeat-works.asciidoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/filebeat/docs/how-filebeat-works.asciidoc b/filebeat/docs/how-filebeat-works.asciidoc index e8435f4038d..c38191fb191 100644 --- a/filebeat/docs/how-filebeat-works.asciidoc +++ b/filebeat/docs/how-filebeat-works.asciidoc @@ -41,6 +41,8 @@ filebeat.prospectors: Filebeat currently supports two `prospector` types: `log` and `stdin`. Each prospector type can be defined multiple times. The `log` prospector checks each file to see whether a harvester needs to be started, whether one is already running, or whether the file can be ignored (see <>). New files are only picked up if the size of the file has changed since the harvester was closed. +NOTE: Filebeat prospectors can only read local files. There is no functionality to connect to remote hosts to read stored files or logs. + [float] === How Does Filebeat Keep the State of Files? From 60a6b7d6b252bd05bc9a101e3f274d390afb456d Mon Sep 17 00:00:00 2001 From: Weidong Feng Date: Thu, 4 May 2017 06:12:03 -0500 Subject: [PATCH 7/7] Update how-filebeat-works.asciidoc (#4199) --- filebeat/docs/how-filebeat-works.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/filebeat/docs/how-filebeat-works.asciidoc b/filebeat/docs/how-filebeat-works.asciidoc index c38191fb191..3130b2c4077 100644 --- a/filebeat/docs/how-filebeat-works.asciidoc +++ b/filebeat/docs/how-filebeat-works.asciidoc @@ -39,7 +39,7 @@ filebeat.prospectors: - /var/path2/*.log ------------------------------------------------------------------------------------- -Filebeat currently supports two `prospector` types: `log` and `stdin`. Each prospector type can be defined multiple times. The `log` prospector checks each file to see whether a harvester needs to be started, whether one is already running, or whether the file can be ignored (see <>). New files are only picked up if the size of the file has changed since the harvester was closed. +Filebeat currently supports two `prospector` types: `log` and `stdin`. Each prospector type can be defined multiple times. The `log` prospector checks each file to see whether a harvester needs to be started, whether one is already running, or whether the file can be ignored (see <>). New lines are only picked up if the size of the file has changed since the harvester was closed. NOTE: Filebeat prospectors can only read local files. There is no functionality to connect to remote hosts to read stored files or logs.