Skip to content

Commit e88803e

Browse files
dedemortonruflin
authored andcommitted
Backport: doc changes in #2953, #3002, #3010, #3036, #3041 (#3043)
* Add consulbeat (#2953) * Add redditbeat to community beats list * Improve "pipelines" documentation Mention the similarity to the "indices" array and add an example. * Default docs update for filbeat * Default docs for close_eof and close_timeout added * Remove note for logstash-forward based code * Updated output docs as elasticsearch can now also be used for parsing (ingest) * Show download link to dashboards
1 parent 1c4f4fe commit e88803e

File tree

6 files changed

+38
-10
lines changed

6 files changed

+38
-10
lines changed

filebeat/docs/overview.asciidoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
[[filebeat-overview]]
22
== Overview
33

4-
Filebeat is a log data shipper initially based on the https://github.com/elastic/logstash-forwarder[Logstash-Forwarder]
5-
source code. Installed as an agent on your servers, Filebeat monitors the log directories or specific log files, tails the files,
6-
and forwards them either to https://www.elastic.co/products/logstash[Logstash] for parsing or directly to
7-
https://www.elastic.co/products/elasticsearch[Elasticsearch] for indexing.
4+
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,
5+
and forwards them either to https://www.elastic.co/products/elasticsearch[Elasticsearch] or https://www.elastic.co/products/logstash[Logstash] for indexing.
86

97
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.
108

filebeat/docs/reference/configuration/filebeat-options.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ WINDOWS: If your Windows log rotation system shows errors because it can't rota
233233

234234
WARNING: Only use this option if you understand that data loss is a potential side effect.
235235

236-
When this option is enabled, Filebeat closes a file as soon as the end of a file is reached. This is useful when your files are only written once and not updated from time to time. For example, this happens when you are writing every single log event to a new file.
236+
When this option is enabled, Filebeat closes a file as soon as the end of a file is reached. This is useful when your files are only written once and not updated from time to time. For example, this happens when you are writing every single log event to a new file. This option is disabled by default.
237237

238238
[[close-timeout]]
239239
===== close_timeout
@@ -246,6 +246,8 @@ When you use `close_timeout` for logs that contain multiline events, the harvest
246246

247247
The `close_timeout` setting won't apply if your output is stalled and no further events can be sent. At least one event must be sent after `close_timeout` elapses so the harvester can be closed after sending the event.
248248

249+
This option is set to 0 by default which means it is disabled.
250+
249251

250252
[[clean-options]]
251253
===== clean_*

libbeat/docs/communitybeats.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ https://github.com/radoondas/apachebeat[apachebeat]:: Reads status from Apache H
1111
https://github.com/goomzee/burrowbeat[burrowbeat]:: Monitors Kafka consumer lag using Burrow.
1212
https://github.com/goomzee/cassandrabeat[cassandrabeat]:: Uses Cassandra's nodetool cfstats utility to monitor Cassandra database nodes and lag.
1313
https://github.com/aidan-/cloudtrailbeat[cloudtrailbeat]:: Reads events from Amazon Web Services' https://aws.amazon.com/cloudtrail/[CloudTrail].
14+
https://github.com/Pravoru/consulbeat[consulbeat]:: Reads services health checks from consul and pushes them to elastic.
1415
https://github.com/Ingensi/dockbeat[dockbeat]:: Reads Docker container
1516
statistics and indexes them in Elasticsearch.
1617
https://github.com/radoondas/elasticbeat[elasticbeat]:: Reads status from an Elasticsearch cluster and indexes them in Elasticsearch.
@@ -36,6 +37,7 @@ managers.
3637
https://github.com/kozlice/phpfpmbeat[phpfpmbeat]:: Reads status from PHP-FPM.
3738
https://github.com/joshuar/pingbeat[pingbeat]:: Sends ICMP pings to a list
3839
of targets and stores the round trip time (RTT) in Elasticsearch.
40+
https://github.com/voigt/redditbeat[redditbeat]:: Collects new Reddit Submissions of one or multiple Subreddits.
3941
https://github.com/chrsblck/redisbeat[redisbeat]:: Used for Redis monitoring.
4042
https://github.com/consulthys/retsbeat[retsbeat]:: Collects counts of http://www.reso.org[RETS] resource/class records from https://en.wikipedia.org/wiki/Multiple_listing_service[Multiple Listing Service] (MLS) servers.
4143
https://github.com/martinhoefling/saltbeat[saltbeat]:: Reads events from salt master event bus.

libbeat/docs/index.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ include::./version.asciidoc[]
1212
:ES-version: {stack-version}
1313
:LS-version: {stack-version}
1414
:Kibana-version: {stack-version}
15+
:dashboards: https://artifacts.elastic.co/downloads/beats/beats-dashboards/beats-dashboards-{stack-version}.zip
1516

1617
include::./overview.asciidoc[]
1718

libbeat/docs/newdashboards.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Elasticsearch running on localhost for a single Beat (eg. Metricbeat):
5858
./scripts/import_dashboards -file metricbeat-dashboards-1.1.zip
5959
----------------------------------------------------------------------
6060

61-
- from the official zip archive available under http://artifacts.elastic.co/:
61+
- from the official zip archive available at {dashboards}:
6262
+
6363
[source,shell]
6464
----------------------------------------------------------------------

libbeat/docs/outputconfig.asciidoc

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -194,10 +194,35 @@ For more information, see <<configuring-ingest-node>>.
194194

195195
===== pipelines
196196

197-
Array of pipeline selector configurations supporting conditionals, format string
198-
based field access and name mappings. The first rule matching will be used to
199-
set the `pipeline` for the event to be published. If `pipelines` is missing or no
200-
rule matches, the `pipeline` field will be used.
197+
Similar to the `indices` array, this is an array of pipeline selector
198+
configurations supporting conditionals, format string based field access
199+
and name mappings. The first rule matching will be used to set the
200+
`pipeline` for the event to be published. If `pipelines` is missing or
201+
no rule matches, the `pipeline` field will be used.
202+
203+
Example elasticsearch output with `pipelines`:
204+
205+
["source","yaml"]
206+
------------------------------------------------------------------------------
207+
filebeat.prospectors:
208+
- paths: ["/var/log/app/normal/*.log"]
209+
fields:
210+
type: "normal"
211+
- paths: ["/var/log/app/critical/*.log"]
212+
fields:
213+
type: "critical"
214+
215+
output.elasticsearch:
216+
hosts: ["http://localhost:9200"]
217+
index: "filebeat-%{+yyyy.MM.dd}"
218+
pipelines:
219+
- pipeline: critical_pipeline
220+
when.equals:
221+
type: "critical"
222+
- pipeline: normal_pipeline
223+
when.equals:
224+
type: "normal"
225+
------------------------------------------------------------------------------
201226

202227
===== template
203228

0 commit comments

Comments
 (0)