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

Cherrypick multiple doc changes into 5.4 (forward and backports) #4240

Merged
merged 7 commits into from
May 8, 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
4 changes: 3 additions & 1 deletion filebeat/docs/how-filebeat-works.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ 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 <<ignore-older,`ignore_older`>>). 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 <<ignore-older,`ignore_older`>>). 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.

[float]
=== How Does Filebeat Keep the State of Files?
Expand Down
4 changes: 2 additions & 2 deletions filebeat/docs/overview.asciidoc
Original file line number Diff line number Diff line change
@@ -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]

Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/config-file-format.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/docs/developer-guide/create-module.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
27 changes: 21 additions & 6 deletions metricbeat/docs/metricbeat-in-a-container.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 <<metricbeat-module-system,system module>> collects much of its data through the Linux proc
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
--------------------------------------------------------------------------------
Expand Down