Skip to content

Commit

Permalink
Cherrypick multiple doc changes into 5.2 (elastic#3216, elastic#3321, e…
Browse files Browse the repository at this point in the history
…lastic#3320, elastic#3312, elastic#3331, elastic#3336) (elastic#3347)

* Edit haproxy module docs

* Add fixes from review feedback

* Fix broken Edit links

* Update close_timeout docs  (elastic#3320)

Clarified close_timeout when there are updates to the file.

* Fix typo in regexp

Should be `regexp` and not `reqexp`

* Fix a couple of typos and a broken link

* Change "versions" to "supported_protocols" (elastic#3336)

Urso pointed out during the Heartbeat review that this name is wrong.
  • Loading branch information
dedemorton authored and tsg committed Jan 12, 2017
1 parent 4079ac8 commit 01ded70
Show file tree
Hide file tree
Showing 42 changed files with 382 additions and 325 deletions.
1 change: 1 addition & 0 deletions filebeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,5 @@ The following topics describe how to configure Filebeat:

--

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/reference/configuration.asciidoc ?>]
include::reference/configuration.asciidoc[]
19 changes: 19 additions & 0 deletions filebeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,60 @@ include::../../libbeat/docs/version.asciidoc[]

include::./overview.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/getting-started.asciidoc ?>]
include::./getting-started.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/command-line.asciidoc ?>]
include::./command-line.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/shared-directory-layout.asciidoc ?>]
include::../../libbeat/docs/shared-directory-layout.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/upgrading.asciidoc ?>]
include::./upgrading.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/how-filebeat-works.asciidoc ?>]
include::./how-filebeat-works.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/configuring-howto.asciidoc ?>]
include::./configuring-howto.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/filebeat-filtering.asciidoc ?>]
include::./filebeat-filtering.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/multiline.asciidoc ?>]
include::./multiline.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/shared-config-ingest.asciidoc ?>]
include::../../libbeat/docs/shared-config-ingest.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/shared-env-vars.asciidoc ?>]
include::../../libbeat/docs/shared-env-vars.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/multiple-prospectors.asciidoc ?>]
include::./multiple-prospectors.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/load-balancing.asciidoc ?>]
include::./load-balancing.asciidoc[]

:allplatforms:
pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/yaml.asciidoc ?>]
include::../../libbeat/docs/yaml.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/regexp.asciidoc ?>]
include::../../libbeat/docs/regexp.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/fields.asciidoc ?>]
include::./fields.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/securing-filebeat.asciidoc ?>]
include::./securing-filebeat.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/troubleshooting.asciidoc ?>]
include::./troubleshooting.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/faq.asciidoc ?>]
include::./faq.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/migration.asciidoc ?>]
include::./migration.asciidoc[]
1 change: 1 addition & 0 deletions filebeat/docs/reference/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes
* <<configuration-logging>>
* <<configuration-processors>>

pass::[<?edit_url https://github.com/elastic/beats/edit/master/filebeat/docs/reference/configuration/filebeat-options.asciidoc ?>]
include::configuration/filebeat-options.asciidoc[]


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,9 @@ When this option is enabled, Filebeat closes a file as soon as the end of a file

WARNING: Only use this option if you understand that data loss is a potential side effect. Another side effect is that multiline events might not be completely sent before the timeout expires.

When this option is enabled, Filebeat gives every harvester a predefined lifetime. Regardless of where the reader is in the file, reading will stop after the `close_timeout` period has elapsed. This option can be useful for older log files when you want to spend only a predefined amount of time on the files. If you set `close_timeout` to equal `ignore_older`, the file will not be picked up if it's modified while the harvester is closed. This combination of settings normally leads to data loss, and the complete file is not sent.
When this option is enabled, Filebeat gives every harvester a predefined lifetime. Regardless of where the reader is in the file, reading will stop after the `close_timeout` period has elapsed. This option can be useful for older log files when you want to spend only a predefined amount of time on the files. While `close_timeout` will close the file after the predefined timeout, if the file is still being updated, the prospector will start a new harvester again per the defined `scan_frequency`. And the close_timeout for this harvester will start again with the countdown for the timeout.

If you set `close_timeout` to equal `ignore_older`, the file will not be picked up if it's modified while the harvester is closed. This combination of settings normally leads to data loss, and the complete file is not sent.

When you use `close_timeout` for logs that contain multiline events, the harvester might stop in the middle of a multiline event, which means that only parts of the event will be sent. If the harvester is started again and the file still exists, only the second part of the event will be sent.

Expand Down Expand Up @@ -567,13 +569,18 @@ Example configuration:
filebeat.shutdown_timeout: 5s
-------------------------------------------------------------------------------------

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/generalconfig.asciidoc ?>]
include::../../../../libbeat/docs/generalconfig.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/outputconfig.asciidoc ?>]
include::../../../../libbeat/docs/outputconfig.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/shared-path-config.asciidoc ?>]
include::../../../../libbeat/docs/shared-path-config.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/loggingconfig.asciidoc ?>]
include::../../../../libbeat/docs/loggingconfig.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/processors-config.asciidoc ?>]
include::../../../../libbeat/docs/processors-config.asciidoc[]

8 changes: 8 additions & 0 deletions filebeat/docs/securing-filebeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,20 @@ The following topics describe how to secure communication between Filebeat and o
* <<securing-communication-elasticsearch>>
* <<configuring-ssl-logstash>>

//sets block macro for https.asciidoc included in next section
pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/https.asciidoc ?>]

--

[[securing-communication-elasticsearch]]
== Securing Communication With Elasticsearch

include::../../libbeat/docs/https.asciidoc[]

//sets block macro for shared-ssl-logstash-config.asciidoc included in next section
pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/shared-ssl-logstash-config.asciidoc ?>]

[[configuring-ssl-logstash]]
== Securing Communication With Logstash by Using SSL

include::../../libbeat/docs/shared-ssl-logstash-config.asciidoc[]
6 changes: 6 additions & 0 deletions filebeat/docs/troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,19 @@ following tips:
* <<enable-filebeat-debugging>>
* <<faq>>

//sets block macro for getting-help.asciidoc included in next section
pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/getting-help.asciidoc ?>]

--

[[getting-help]]
== Getting Help

include::../../libbeat/docs/getting-help.asciidoc[]

//sets block macro for debugging.asciidoc included in next section
pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/debugging.asciidoc ?>]

[[enable-filebeat-debugging]]
== Debugging

Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/dashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ visualizations, and searches for {beatname_uc}. The script also creates an index
+{beatname_lc}-*+, for {beatname_uc}.

The steps in this section show how to import {beatname_uc} dashboards. You may want to import dashboards for more than
one Beat or specify import options that aren't described here. See {libbeat}/[Importing Existing Beat Dashboards]
one Beat or specify import options that aren't described here. See {libbeat}/import-dashboards.html[Importing Existing Beat Dashboards]
in the _Beats Platform Reference_ for a full list of command-line options.

To import the Kibana dashboards for {beatname_uc}:
Expand Down
11 changes: 11 additions & 0 deletions libbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,39 @@ include::./version.asciidoc[]

include::./overview.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/communitybeats.asciidoc ?>]
include::./communitybeats.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/gettingstarted.asciidoc ?>]
include::./gettingstarted.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/installing-beats.asciidoc ?>]
include::./installing-beats.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/repositories.asciidoc ?>]
include::./repositories.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/breaking.asciidoc ?>]
include::./breaking.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/upgrading.asciidoc ?>]
include::./upgrading.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/config-file-format.asciidoc ?>]
include::./config-file-format.asciidoc[]

pass::[<?page_header Always refer to the documentation in master for the latest information about contributing to Beats.?>]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/newbeat.asciidoc ?>]
include::./newbeat.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/event-conventions.asciidoc ?>]
include::./event-conventions.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/newdashboards.asciidoc ?>]
include::./newdashboards.asciidoc[]

pass::[<?page_header ?>]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/libbeat/docs/release.asciidoc ?>]
include::./release.asciidoc[]
9 changes: 5 additions & 4 deletions libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,8 @@ Valid values are `0.8.2.0`, `0.8.2.1`, `0.8.2.2`, `0.8.2`, `0.8`, `0.9.0.0`,

===== username

The username for connecting to Kafka. If username is configured, the passowrd must be configured as well. Only SASL/PLAIN is supported.
The username for connecting to Kafka. If username is configured, the password
must be configured as well. Only SASL/PLAIN is supported.

===== password

Expand Down Expand Up @@ -657,7 +658,7 @@ Kafka output broker event partitioning strategy. Must be one of `random`,

*`random.group_events`*: Sets the number of events to be published to the same
partition, before the partitioner selects a new partition by random. The
default value is 1 meaning after each event a new parition is picked randomly.
default value is 1 meaning after each event a new partition is picked randomly.

*`round_robin.group_events`*: Sets the number of events to be published to the
same partition, before the partitioner selects the next partition. The default
Expand Down Expand Up @@ -689,7 +690,7 @@ The number of concurrent load-balanced Kafka output workers.
Kafka metadata update settings. The metadata do contain information about
brokers, topics, partition, and active leaders to use for publishing.

*`refresh_frequency`*:: Metadata refreash interval. Defaults to 10 minutes.
*`refresh_frequency`*:: Metadata refresh interval. Defaults to 10 minutes.

*`retry.max`*:: Total number of metadata update retries when cluster is in middle of leader election. The default is 3.

Expand Down Expand Up @@ -1104,7 +1105,7 @@ The client certificate key used for client authentication. This option is requir

The passphrase used to decrypt an encrypted key stored in the configured `key` file.

===== versions
===== supported_protocols

List of allowed SSL/TLS versions. If SSL/TLS server decides for protocol versions
not configured, the connection will be dropped during or after the handshake. The
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/processors-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ For example, the following condition checks if the process name starts with

[source,yaml]
-----
reqexp:
regexp:
system.process.name: "foo.*"
-----

Expand Down
2 changes: 1 addition & 1 deletion metricbeat/_meta/beat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ metricbeat.modules:
#certificate: "/etc/pki/client/cert.pem"
#key: "/etc/pki/client/cert.key"

#------------------------------- haproxy Module ------------------------------
#------------------------------- HAProxy Module ------------------------------
#- module: haproxy
#metricsets: ["info", "stat"]
#enabled: true
Expand Down
1 change: 1 addition & 0 deletions metricbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,5 @@ metricbeat:

--

pass::[<?edit_url https://github.com/elastic/beats/edit/master/metricbeat/docs/reference/configuration.asciidoc ?>]
include::reference/configuration.asciidoc[]
6 changes: 5 additions & 1 deletion metricbeat/docs/developer-guide/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,17 @@ directly from the service itself and not via a third-party tool. The goal is to
have as few movable parts as possible and for Metricbeat to run as close as
possible to the service that it needs to monitor.


pass::[<?edit_url https://github.com/elastic/beats/edit/master/metricbeat/docs/developer-guide/create-metricset.asciidoc ?>]
include::./create-metricset.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/metricbeat/docs/developer-guide/metricset-details.asciidoc ?>]
include::./metricset-details.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/metricbeat/docs/developer-guide/create-module.asciidoc ?>]
include::./create-module.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/metricbeat/docs/developer-guide/creating-beat-from-metricbeat.asciidoc ?>]
include::./creating-beat-from-metricbeat.asciidoc[]

pass::[<?edit_url https://github.com/elastic/beats/edit/master/metricbeat/docs/developer-guide/faq.asciidoc ?>]
include::./faq.asciidoc[]
Loading

0 comments on commit 01ded70

Please sign in to comment.