Skip to content

Commit

Permalink
Remove comments from config example code (#2513)
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton authored and ruflin committed Sep 12, 2016
1 parent 9ed0813 commit 2c5d5a7
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 174 deletions.
18 changes: 4 additions & 14 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ mac>> for OS X, and <<win, win>> for Windows).
If you use Apt or Yum, you can {libbeat}/setup-repositories.html[install Filebeat from our repositories] to update to the newest version more easily.
See our https://www.elastic.co/downloads/beats/filebeat[download page] for other installation options, such as 32-bit images.
==================================================

[[deb]]
Expand Down Expand Up @@ -91,17 +92,10 @@ default values for most configuration options.
[source,yaml]
-------------------------------------------------------------------------------------
filebeat.prospectors:
# Each - is a prospector. Most options can be set at the prospector level, so
# you can use different prospectors for various configurations.
# Below are the prospector specific configurations.
- input_type: log
# Paths that should be crawled and fetched. Glob based paths.
paths:
- /var/log/*.log
#- c:\programdata\elasticsearch\logs\*
-------------------------------------------------------------------------------------

To configure Filebeat:
Expand All @@ -115,7 +109,7 @@ For the most basic Filebeat configuration, you can define a single prospector wi
filebeat.prospectors:
- input_type: log
paths:
- "/var/log/*.log"
- /var/log/*.log
-------------------------------------------------------------------------------------
+
The prospector in this example harvests all files in the path `/var/log/*.log`, which means
Expand All @@ -131,11 +125,7 @@ fetch all files in all subdirectories of a directory.
+
[source,yaml]
----------------------------------------------------------------------
# Configure what outputs to use when sending the data collected by the beat.
# Multiple outputs may be used.
output.elasticsearch:
# Array of hosts to connect to.
hosts: ["192.168.1.42:9200"]
----------------------------------------------------------------------
+
Expand Down Expand Up @@ -197,12 +187,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 loading dashboards.
that's provided for loading dashboards.

For more information about running the script, see
{libbeat}/load-kibana-dashboards.html[Loading the Beats Dashboards].

After you've created the index pattern, you can select the `filebeat-*` index pattern in Kibana to explore
Filebeat data.
Filebeat data.

image:./images/filebeat-discover-tab.png[]
27 changes: 8 additions & 19 deletions filebeat/docs/migration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ Beats input plugin on the same Logstash instances, but set up the Beats input pl
all the machines to Filebeat, you can remove the Lumberjack plugin.

We realize that opening additional ports may not be feasible in your organization. Another option for phased migration
to Filebeat is to ship data from Logstash Forwarder directly to the Beats input plugin.
to Filebeat is to ship data from Logstash Forwarder directly to the Beats input plugin.

IMPORTANT: This data shipping path is only supported for migrating to Filebeat and will no longer be supported when Logstash Forwarder reaches https://www.elastic.co/support/eol[End of Life].

What's required?

* The https://www.elastic.co/guide/en/logstash/current/plugins-inputs-beats.html[Beats input plugin for Logstash]
* The https://www.elastic.co/guide/en/logstash/current/plugins-inputs-beats.html[Beats input plugin for Logstash]
version 2.2.8 or later.
* SSL must be explicitly enabled in the Beats input plugin (`ssl => true`) because SSL is on by default with Logstash Forwarder. The SSL/TLS configs should be the same for both the Logstash Forwarder and Filebeat instances.

Expand Down Expand Up @@ -125,11 +125,10 @@ The equivalent `prospectors` section would look like this:
[source,yaml]
-------------------------------------------------------------------------------------
filebeat.prospectors:
# Each - is a prospector. Below are the prospector specific configurations
- input_type: log
paths:
- /var/log/messages
- "/var/log/*.log"
- /var/log/*.log
document_type: syslog <1>
fields:
service: apache
Expand All @@ -139,7 +138,7 @@ filebeat.prospectors:
document_type: stdin
- input_type: log
paths:
- "/var/log/apache2/httpd-*.log"
- /var/log/apache2/httpd-*.log
document_type: apache
-------------------------------------------------------------------------------------

Expand Down Expand Up @@ -201,22 +200,12 @@ The equivalent in Filebeat would look like this:
[source,yaml]
-------------------------------------------------------------------------------------
output.logstash:
# The Logstash hosts. <1>
hosts:
hosts: <1>
- localhost:5043
# Network timeout in seconds.
timeout: 15
# Optional SSL settings <2>
# List of root certificates for HTTPS server verifications
ssl.certificate_authorities:
ssl.certificate_authorities: <2>
- ./logstash-forwarder.crt
# Certificate for SSL client authentication
ssl.certificate: ./logstash-forwarder.crt
# Client Certificate Key
ssl.key: ./logstash-forwarder.key
-------------------------------------------------------------------------------------

Expand Down Expand Up @@ -287,7 +276,7 @@ Filebeat configuration:
filebeat.prospectors:
- input_type: log
paths:
- "/var/log/*.log"
- /var/log/*.log
document_type: syslog
fields:
service: test01
Expand Down Expand Up @@ -374,7 +363,7 @@ you can use the <<fields-under-root>> configuration option:
filebeat.prospectors:
- input_type: log
paths:
- "/var/log/*.log"
- /var/log/*.log
document_type: syslog
fields:
service: test01
Expand Down
17 changes: 5 additions & 12 deletions filebeat/docs/reference/configuration/filebeat-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,15 @@ Here is a sample configuration:
[source,yaml]
-------------------------------------------------------------------------------------
filebeat.prospectors:
# Each - is a prospector. Below are the prospector specific configurations
- input_type: log
# Paths that should be crawled and fetched. Glob based paths.
# For each file found under this path, a harvester is started.
paths:
- "/var/log/apache/httpd-*.log"
# Type to be published in the 'type' field. For Elasticsearch output,
# the type defines the document type these entries should be stored
# in. Default: log
- /var/log/apache/httpd-*.log
document_type: apache
- input_type: log
paths:
- /var/log/messages
- "/var/log/*.log"
- /var/log/*.log
-------------------------------------------------------------------------------------

==== Options
Expand Down Expand Up @@ -433,14 +426,14 @@ lines. The `backoff` value will be multiplied each time with the `backoff_factor

===== harvester_limit

EXPERIMENTAL
experimental[]

harvester_limit limits the number of harvesters that are started in parallel for one prospector. This directly relates
`harvester_limit` limits the number of harvesters that are started in parallel for one prospector. This directly relates
to the maximum number of file handlers that are opened. The default is 0 which means there is no limit. This configuration
is useful if the number of files to be harvested exceeds the open file handler limit of the operating system.

As setting a limit on harvester means that potentially not all files are opened in parallel, it is recommended to use
this option in combination with the close_* options to make sure harvesters are stopped more often so new files can be
this option in combination with the `close_*` options to make sure harvesters are stopped more often so new files can be
picked up.

Currently if a new harvester can be started again, the new harvester to be started is picked randomly. This means it can
Expand Down
14 changes: 3 additions & 11 deletions libbeat/docs/generalconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,8 @@ Here is an example configuration:

[source,yaml]
------------------------------------------------------------------------------
# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
# If this options is not defined, the hostname is used.
#name:
# The tags of the shipper are included in their own field with each
# transaction published. Tags make it easy to group servers by different
# logical properties.
name: "my-shipper"
tags: ["service-X", "web-tier"]
------------------------------------------------------------------------------

==== General Options
Expand Down Expand Up @@ -144,12 +136,12 @@ that if finds. Then, for each transaction, the Beat exports the GeoIP location o
The recommended values for geoip.paths are `/usr/share/GeoIP/GeoLiteCity.dat`
and `/usr/local/var/GeoIP/GeoLiteCity.dat`.

If no paths are configured, GeoIP is disabled.

Example:

[source,yaml]
------------------------------------------------------------------------------
# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
geoip:
paths:
- "/usr/share/GeoIP/GeoLiteCity.dat"
Expand Down
5 changes: 0 additions & 5 deletions libbeat/docs/loggingconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,8 @@ is used on Windows systems, and syslog output is used on Linux and OS X.
[source,yaml]
------------------------------------------------------------------------------
logging.level: warning
# enable file rotation with default configuration
logging.to_files: true
# do not log to syslog
logging.to_syslog: false
logging.files:
path: /var/log/mybeat
name: mybeat.log
Expand Down
1 change: 0 additions & 1 deletion libbeat/docs/newbeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,6 @@ You also need to add `path` to `etc/beat.yml`:
[source,yml]
----------------------------------------------------------------------
countbeat:
# Defines how often an event is sent to the output
period: 10s
path: "."
----------------------------------------------------------------------
Expand Down
Loading

0 comments on commit 2c5d5a7

Please sign in to comment.