diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml index 68d577ab22ea..b31493eb02f3 100644 --- a/auditbeat/auditbeat.reference.yml +++ b/auditbeat/auditbeat.reference.yml @@ -524,6 +524,21 @@ output.elasticsearch: # never, once, and freely. Default is never. #ssl.renegotiation: never + # The number of times to retry publishing an event after a publishing failure. + # After the specified number of retries, the events are typically dropped. + # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting + # and retry until all events are published. Set max_retries to a value less + # than 0 to retry until all events are published. The default is 3. + #max_retries: 3 + + # The maximum number of events to bulk in a single Logstash request. The + # default is 2048. + #bulk_max_size: 2048 + + # The number of seconds to wait for responses from the Logstash server before + # timing out. The default is 30s. + #timeout: 30s + #------------------------------- Kafka output ---------------------------------- #output.kafka: # Boolean flag to enable or disable the output module. @@ -935,6 +950,13 @@ output.elasticsearch: # Path to fields.yml file to generate the template #setup.template.fields: "${path.config}/fields.yml" +# A list of fields to be added to the template and Kibana index pattern. Also +# specify setup.template.overwrite: true to overwrite the existing template. +# This setting is experimental. +#setup.template.append_fields: +#- name: field_name +# type: field_type + # Enable json template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false diff --git a/docs/devguide/contributing.asciidoc b/docs/devguide/contributing.asciidoc index eab4ff520acb..1bb22810ec94 100644 --- a/docs/devguide/contributing.asciidoc +++ b/docs/devguide/contributing.asciidoc @@ -45,8 +45,8 @@ Beats]. === Setting Up Your Dev Environment The Beats are Go programs, so install the latest version of -http://golang.org/[golang] if you don't have it already. The current Go version -used for development is Golang {go-version}. +http://golang.org/[Go] if you don't have it already. The current Go version +used for development is Go {go-version}. The location where you clone is important. Please clone under the source directory of your `GOPATH`. If you don't have `GOPATH` already set, you can diff --git a/docs/devguide/create-metricset.asciidoc b/docs/devguide/create-metricset.asciidoc index 94c9531ce194..e39cd9f6366d 100644 --- a/docs/devguide/create-metricset.asciidoc +++ b/docs/devguide/create-metricset.asciidoc @@ -69,13 +69,13 @@ https://github.com/elastic/beats/blob/master/metricbeat/scripts/module/metricset include::../../metricbeat/scripts/module/metricset/metricset.go.tmpl[] ---- -The `package` clause and `import` declaration are part of the base structure of each Golang file. You should only +The `package` clause and `import` declaration are part of the base structure of each Go file. You should only modify this part of the file if your implementation requires more imports. [float] ===== Initialisation -The init method registers the metricset with the central registry. In Golang the `init()` function is called +The init method registers the metricset with the central registry. In Go the `init()` function is called before the execution of all other code. This means the module will be automatically registered with the global registry. The `New` method, which is passed to `AddMetricSet`, will be called after the setup of the module and before starting to fetch data. You normally don't need to change this part of the file. diff --git a/docs/devguide/creating-beat-from-metricbeat.asciidoc b/docs/devguide/creating-beat-from-metricbeat.asciidoc index 62f437234e86..787f61a0a576 100644 --- a/docs/devguide/creating-beat-from-metricbeat.asciidoc +++ b/docs/devguide/creating-beat-from-metricbeat.asciidoc @@ -7,7 +7,7 @@ own metricsets. [float] ==== Requirements -To create your own Beat, you must have Golang {go-version} or later installed, and the `$GOPATH` +To create your own Beat, you must have Go {go-version} or later installed, and the `$GOPATH` must be set up correctly. In addition, the following tools are required: * https://www.python.org/downloads/[python] diff --git a/docs/devguide/metricset-details.asciidoc b/docs/devguide/metricset-details.asciidoc index 126454a55d1f..e3358ec7afb8 100644 --- a/docs/devguide/metricset-details.asciidoc +++ b/docs/devguide/metricset-details.asciidoc @@ -145,8 +145,8 @@ It's important to also add tests for your metricset. There are three different t * system tests We recommend that you use all three when you create a metricset. Unit tests are -written in Golang and have no dependencies. Integration tests are also written -in Golang but require the service from which the module collects metrics to also be running. +written in Go and have no dependencies. Integration tests are also written +in Go but require the service from which the module collects metrics to also be running. System tests for Metricbeat also require the service to be running in most cases and are written in Python based on our small Python test framework. We use `virtualenv` to deal with Python dependencies. diff --git a/docs/devguide/modules-dev-guide.asciidoc b/docs/devguide/modules-dev-guide.asciidoc index 04f272959ecd..7fc1e5e10b16 100644 --- a/docs/devguide/modules-dev-guide.asciidoc +++ b/docs/devguide/modules-dev-guide.asciidoc @@ -260,7 +260,7 @@ input configuration are documented in the the Filebeat documentation. The template files use the templating language defined by the -https://golang.org/pkg/text/template/[Golang standard library]. +https://golang.org/pkg/text/template/[Go standard library]. Here is another example that also configures multiline stitching: diff --git a/docs/devguide/newbeat.asciidoc b/docs/devguide/newbeat.asciidoc index 4c980306bd89..f233e195eb15 100644 --- a/docs/devguide/newbeat.asciidoc +++ b/docs/devguide/newbeat.asciidoc @@ -77,7 +77,7 @@ daemonzing, and Windows service handling, and data processing modules. image:./images/beat_overview.png[Beat overview architecture] -The event that you create is a JSON-like object (Golang type `map[string]interface{}`) that +The event that you create is a JSON-like object (Go type `map[string]interface{}`) that contains the collected data to send to the publisher. At a minimum, the event object must contain a `@timestamp` field and a `type` field. Beyond that, events can contain any additional fields, and they can be created as often diff --git a/docs/devguide/newdashboards.asciidoc b/docs/devguide/newdashboards.asciidoc index 9cfd5aa5327d..b874dafbfe39 100644 --- a/docs/devguide/newdashboards.asciidoc +++ b/docs/devguide/newdashboards.asciidoc @@ -208,7 +208,7 @@ make update === Exporting New and Modified Beat Dashboards To export all the dashboards for any Elastic Beat or any community Beat, including any new or modified dashboards and all dependencies such as -visualizations, searches, you can use the Golang script `export_dashboards.go` from +visualizations, searches, you can use the Go script `export_dashboards.go` from https://github.com/elastic/beats/tree/master/dev-tools/cmd/dashboards[dev-tools] for exporting Kibana 6.0 dashboards or later, and the Python script `export_5x_dashboards.py` for exporting Kibana 5.x dashboards. See the dev-tools https://github.com/elastic/beats/tree/master/dev-tools/README.md[readme] for more info. diff --git a/docs/devguide/testing.asciidoc b/docs/devguide/testing.asciidoc index 0e548de333e8..3091cd01cd76 100644 --- a/docs/devguide/testing.asciidoc +++ b/docs/devguide/testing.asciidoc @@ -5,20 +5,20 @@ Beats has a various sets of tests. This guide should help to understand how the In general there are two major test suites: -* Tests written in Golang +* Tests written in Go * Tests written in Python -The tests written in Golang use the https://golang.org/pkg/testing/[Golang Testing package]. The tests written in Python depend on http://nose.readthedocs.io/en/latest/[nosetests] and require a compiled and executable binary from the Golang code. The python test run a beat with a specific config and params and either check if the output is as expected or if the correct things show up in the logs. +The tests written in Go use the https://golang.org/pkg/testing/[Go Testing package]. The tests written in Python depend on http://nose.readthedocs.io/en/latest/[nosetests] and require a compiled and executable binary from the Go code. The python test run a beat with a specific config and params and either check if the output is as expected or if the correct things show up in the logs. For both of the above test suites so called integration tests exists. Integration tests in Beats are tests which require an external system like Elasticsearch to test if the integration with this service works as expected. Beats provides in its testsuite docker containers and docker-compose files to start these environments but a developer can run the required services also locally. -==== Running Golang Tests +==== Running Go Tests -The golang tests can be executed in each Golang package by running `go test .`. This will execute all tests which don't don't require an external service to be running. To also run the Golang integration tests run `go test -tags=integration .`. It will require you to run the expected services on localhost. +The Go tests can be executed in each Go package by running `go test .`. This will execute all tests which don't don't require an external service to be running. To also run the Go integration tests run `go test -tags=integration .`. It will require you to run the expected services on localhost. To run all non integration tests for a beat run `make unit`. This will execute all the tests which are not inside a `vendor` directory. If you want to have a coverage report for the tests which were run use `make unit-tests`. A coverage report will be generated under `build/coverage` directory. -All Golang tests are in the same package as the tested code itself and have the postfix `_test` in the file name. Most of the tests are in the same package as the rest of the code. Some of the tests which should be separate from the rest of the code or should not use private variables go under `{packagename}_test`. +All Go tests are in the same package as the tested code itself and have the postfix `_test` in the file name. Most of the tests are in the same package as the rest of the code. Some of the tests which should be separate from the rest of the code or should not use private variables go under `{packagename}_test`. ==== Running Python Tests @@ -37,10 +37,10 @@ All Python tests are under `tests/system` directory. This is a quick summary of the available test commands: -* `unit`: Golang tests -* `unit-tests`: Golang tests with coverage reports -* `integration-tests`: Golang tests with services in local docker -* `integration-tests-environment`: Golang tests inside docker with service in docker +* `unit`: Go tests +* `unit-tests`: Go tests with coverage reports +* `integration-tests`: Go tests with services in local docker +* `integration-tests-environment`: Go tests inside docker with service in docker * `fast-system-tests`: Python tests * `system-tests`: Python tests with coverage report * `INTEGRATION_TESTS=1 system-tests`: Python tests with local services @@ -50,7 +50,7 @@ This is a quick summary of the available test commands: There are two experimental test commands: -* `benchmark-tests`: Running golang tests with `-bench` flag +* `benchmark-tests`: Running Go tests with `-bench` flag * `load-tests`: Running system tests with `LOAD_TESTS=1` flag @@ -60,7 +60,7 @@ If the tests were run to create a test coverage, the coverage report files can b ==== Race detection -All tests can be run with the Golang race detector enabled by setting the environment variable `RACE_DETECTOR=1`. This applies to tests in Golang and Python. For Python the test binary has to be recompile when the flag is changed. Having the race detection enabled will slow down the tests. +All tests can be run with the Go race detector enabled by setting the environment variable `RACE_DETECTOR=1`. This applies to tests in Go and Python. For Python the test binary has to be recompile when the flag is changed. Having the race detection enabled will slow down the tests. ==== Docker environment diff --git a/filebeat/docs/autodiscover-hints.asciidoc b/filebeat/docs/autodiscover-hints.asciidoc index e258e61ec4d9..a49a8abd055e 100644 --- a/filebeat/docs/autodiscover-hints.asciidoc +++ b/filebeat/docs/autodiscover-hints.asciidoc @@ -73,7 +73,7 @@ of supported processors. In order to provide ordering of the processor definition, numbers can be provided. If not, the hints builder will do arbitrary ordering: -["source","yaml",subs="attributes"] +["source","yaml"] ------------------------------------------------------------------------------------- co.elastic.logs/processors.1.dissect.tokenizer: "%{key1} %{key2}" co.elastic.logs/processors.dissect.tokenizer: "%{key2} %{key1}" diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc index 33e15b65c993..81f88a92d3af 100644 --- a/filebeat/docs/getting-started.asciidoc +++ b/filebeat/docs/getting-started.asciidoc @@ -166,7 +166,7 @@ filebeat.inputs: + The input in this example harvests all files in the path `/var/log/*.log`, which means that Filebeat will harvest all files in the directory `/var/log/` that end with `.log`. All patterns supported -by https://golang.org/pkg/path/filepath/#Glob[Golang Glob] are also supported here. +by https://golang.org/pkg/path/filepath/#Glob[Go Glob] are also supported here. + To fetch all files from a predefined level of subdirectories, the following pattern can be used: `/var/log/*/*.log`. This fetches all `.log` files from the subfolders of `/var/log`. It does not diff --git a/filebeat/docs/inputs/input-common-file-options.asciidoc b/filebeat/docs/inputs/input-common-file-options.asciidoc index bebdbfca928e..ee663f7e47aa 100644 --- a/filebeat/docs/inputs/input-common-file-options.asciidoc +++ b/filebeat/docs/inputs/input-common-file-options.asciidoc @@ -348,9 +348,10 @@ specifying 10s for `max_backoff` means that, at the worst, a new line could be added to the log file if {beatname_uc} has backed off multiple times. The default is 10s. -Requirement: max_backoff should always be set to `max_backoff <= -scan_frequency`. In case `max_backoff` should be bigger, it is recommended to -close the file handler instead let the {beatname_uc} pick up the file again. +Requirement: Set `max_backoff` to be greater than or equal to `backoff` and +less than or equal to `scan_frequency` (`backoff <= max_backoff <= scan_frequency`). +If `max_backoff` needs to be higher, it is recommended to close the file handler +instead and let {beatname_uc} pick up the file again. [float] ===== `backoff_factor` diff --git a/filebeat/docs/inputs/input-log.asciidoc b/filebeat/docs/inputs/input-log.asciidoc index 7c73c63d396c..181714a4d643 100644 --- a/filebeat/docs/inputs/input-log.asciidoc +++ b/filebeat/docs/inputs/input-log.asciidoc @@ -7,10 +7,10 @@ Log ++++ -Use the `log` input to read lines from log files. +Use the `log` input to read lines from log files. To configure this input, specify a list of glob-based <> -that must be crawled to locate and fetch the log lines. +that must be crawled to locate and fetch the log lines. Example configuration: @@ -57,6 +57,10 @@ multiple input sections: IMPORTANT: Make sure a file is not defined more than once across all inputs because this can lead to unexpected behaviour. +NOTE: When dealing with file rotation, avoid harvesting symlinks. Instead +use the <> setting to point to the original file, and specify +a pattern that matches the file you want to harvest and all of its rotated +files. [id="{beatname_lc}-input-{type}-options"] ==== Configuration options @@ -69,7 +73,7 @@ The `log` input supports the following configuration options plus the ===== `paths` A list of glob-based paths that will be crawled and fetched. All patterns -supported by https://golang.org/pkg/path/filepath/#Glob[Golang Glob] are also +supported by https://golang.org/pkg/path/filepath/#Glob[Go Glob] are also supported here. For example, to fetch all files from a predefined level of subdirectories, the following pattern can be used: `/var/log/*/*.log`. This fetches all `.log` files from the subfolders of `/var/log`. It does not diff --git a/filebeat/docs/modules/kibana.asciidoc b/filebeat/docs/modules/kibana.asciidoc index d0a1b74a7b01..881c4b4037fe 100644 --- a/filebeat/docs/modules/kibana.asciidoc +++ b/filebeat/docs/modules/kibana.asciidoc @@ -23,16 +23,18 @@ include::../include/running-modules.asciidoc[] include::../include/configuring-intro.asciidoc[] -//set the fileset name used in the included example +//set the fileset name used in the included file :fileset_ex: log include::../include/config-option-intro.asciidoc[] [float] -==== `{fileset}` log fileset settings +==== `log` fileset settings include::../include/var-paths.asciidoc[] +:fileset_ex!: + [float] === Fields diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml index f1265d5be43d..c580a75598ab 100644 --- a/filebeat/filebeat.reference.yml +++ b/filebeat/filebeat.reference.yml @@ -1184,6 +1184,21 @@ output.elasticsearch: # never, once, and freely. Default is never. #ssl.renegotiation: never + # The number of times to retry publishing an event after a publishing failure. + # After the specified number of retries, the events are typically dropped. + # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting + # and retry until all events are published. Set max_retries to a value less + # than 0 to retry until all events are published. The default is 3. + #max_retries: 3 + + # The maximum number of events to bulk in a single Logstash request. The + # default is 2048. + #bulk_max_size: 2048 + + # The number of seconds to wait for responses from the Logstash server before + # timing out. The default is 30s. + #timeout: 30s + #------------------------------- Kafka output ---------------------------------- #output.kafka: # Boolean flag to enable or disable the output module. @@ -1595,6 +1610,13 @@ output.elasticsearch: # Path to fields.yml file to generate the template #setup.template.fields: "${path.config}/fields.yml" +# A list of fields to be added to the template and Kibana index pattern. Also +# specify setup.template.overwrite: true to overwrite the existing template. +# This setting is experimental. +#setup.template.append_fields: +#- name: field_name +# type: field_type + # Enable json template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false diff --git a/filebeat/module/kibana/_meta/docs.asciidoc b/filebeat/module/kibana/_meta/docs.asciidoc index 1d622a1dc045..a7a8ca9e6156 100644 --- a/filebeat/module/kibana/_meta/docs.asciidoc +++ b/filebeat/module/kibana/_meta/docs.asciidoc @@ -18,12 +18,14 @@ include::../include/running-modules.asciidoc[] include::../include/configuring-intro.asciidoc[] -//set the fileset name used in the included example +//set the fileset name used in the included file :fileset_ex: log include::../include/config-option-intro.asciidoc[] [float] -==== `{fileset}` log fileset settings +==== `log` fileset settings include::../include/var-paths.asciidoc[] + +:fileset_ex!: diff --git a/filebeat/scripts/module/_meta/docs.asciidoc b/filebeat/scripts/module/_meta/docs.asciidoc index c5e316ec8a9e..51f180d4addd 100644 --- a/filebeat/scripts/module/_meta/docs.asciidoc +++ b/filebeat/scripts/module/_meta/docs.asciidoc @@ -37,3 +37,7 @@ the relevant file. For example: ==== `{fileset}` log fileset settings include::../include/var-paths.asciidoc[] + +:fileset_ex!: + +:modulename!: diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index ca2a11345538..99393893e6a1 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -631,6 +631,21 @@ output.elasticsearch: # never, once, and freely. Default is never. #ssl.renegotiation: never + # The number of times to retry publishing an event after a publishing failure. + # After the specified number of retries, the events are typically dropped. + # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting + # and retry until all events are published. Set max_retries to a value less + # than 0 to retry until all events are published. The default is 3. + #max_retries: 3 + + # The maximum number of events to bulk in a single Logstash request. The + # default is 2048. + #bulk_max_size: 2048 + + # The number of seconds to wait for responses from the Logstash server before + # timing out. The default is 30s. + #timeout: 30s + #------------------------------- Kafka output ---------------------------------- #output.kafka: # Boolean flag to enable or disable the output module. @@ -1042,6 +1057,13 @@ output.elasticsearch: # Path to fields.yml file to generate the template #setup.template.fields: "${path.config}/fields.yml" +# A list of fields to be added to the template and Kibana index pattern. Also +# specify setup.template.overwrite: true to overwrite the existing template. +# This setting is experimental. +#setup.template.append_fields: +#- name: field_name +# type: field_type + # Enable json template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false diff --git a/libbeat/_meta/config.reference.yml b/libbeat/_meta/config.reference.yml index 342e70dbd984..61066c4ac808 100644 --- a/libbeat/_meta/config.reference.yml +++ b/libbeat/_meta/config.reference.yml @@ -417,6 +417,21 @@ output.elasticsearch: # never, once, and freely. Default is never. #ssl.renegotiation: never + # The number of times to retry publishing an event after a publishing failure. + # After the specified number of retries, the events are typically dropped. + # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting + # and retry until all events are published. Set max_retries to a value less + # than 0 to retry until all events are published. The default is 3. + #max_retries: 3 + + # The maximum number of events to bulk in a single Logstash request. The + # default is 2048. + #bulk_max_size: 2048 + + # The number of seconds to wait for responses from the Logstash server before + # timing out. The default is 30s. + #timeout: 30s + #------------------------------- Kafka output ---------------------------------- #output.kafka: # Boolean flag to enable or disable the output module. @@ -828,6 +843,13 @@ output.elasticsearch: # Path to fields.yml file to generate the template #setup.template.fields: "${path.config}/fields.yml" +# A list of fields to be added to the template and Kibana index pattern. Also +# specify setup.template.overwrite: true to overwrite the existing template. +# This setting is experimental. +#setup.template.append_fields: +#- name: field_name +# type: field_type + # Enable json template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false diff --git a/libbeat/docs/command-reference.asciidoc b/libbeat/docs/command-reference.asciidoc index e2f37f911aa5..a6d666e78b73 100644 --- a/libbeat/docs/command-reference.asciidoc +++ b/libbeat/docs/command-reference.asciidoc @@ -14,7 +14,7 @@ :global-flags: Also see <>. -:export-command-short-desc: Exports the configuration or index template to stdout +:export-command-short-desc: Exports the configuration, index template or a dashboard to stdout :help-command-short-desc: Shows help for any command :keystore-command-short-desc: Manages the <> :modules-command-short-desc: Manages configured modules @@ -77,7 +77,7 @@ endif::[] [options="header"] |======================= -|Commands | +|Commands | |<> |{export-command-short-desc}. |<> |{help-command-short-desc}. |<> |{keystore-command-short-desc}. @@ -96,8 +96,8 @@ Also see <>. ==== `export` command {export-command-short-desc}. You can use this -command to quickly view your configuration or the contents of the index -template. +command to quickly view your configuration, see the contents of the index +template or export a dashboard from Kibana. *SYNOPSIS* @@ -113,6 +113,30 @@ template. Exports the current configuration to stdout. If you use the `-c` flag, this command exports the configuration that's defined in the specified file. + + +*`dashboard`*:: +Exporting a dashboard allows to store a dashboard on disk in a +module and load it automatically. The following command can be used: ++ +["source","shell",subs="attributes"] +---- +{beatname_lc} export dashboard --id="dashboard-id" > dashboard.json +---- ++ +The `dashboard-id` can be found in the Kibana URL. By default `export dashboard` +will write the dashboard to stdout. Above it's written into `dashboard.json` so +it can later imported again. The file contains the dashboard with all +visualizations and searches. The index pattern is removed as it is +expected to be loaded separately for {beatname_uc}. ++ +The generated `dashboard.json` file can be copied into the `kibana/6/dashboard` +directory of {beatname_lc} and next time +{beatname_lc} setup dashboards+ is +run the dashboard will be imported. ++ +In case Kibana is not running on `localhost:5061` the {beatname_uc} +configuration under `setup.kibana` must be adjusted. + [[template-subcommand]] *`template`*:: Exports the index template to stdout. You can specify the `--es.version` and @@ -176,7 +200,7 @@ Specifies the name of the command to show help for. [[keystore-command]] ==== `keystore` command -{keystore-command-short-desc}. +{keystore-command-short-desc}. *SYNOPSIS* @@ -690,4 +714,3 @@ the _Beats Platform Reference_ for more information. *`-v, --v`*:: Logs INFO-level messages. - diff --git a/libbeat/docs/outputconfig.asciidoc b/libbeat/docs/outputconfig.asciidoc index 88326a59dd09..735a5cecb005 100644 --- a/libbeat/docs/outputconfig.asciidoc +++ b/libbeat/docs/outputconfig.asciidoc @@ -14,7 +14,7 @@ == Configure the output ifdef::only-elasticsearch[] -You configure {beatname_uc} to write to Elasticsearch by setting options +You configure {beatname_uc} to write to Elasticsearch by setting options in the `output.elasticsearch` section of the +{beatname_lc}.yml+ config file endif::[] @@ -207,7 +207,7 @@ The URL of the proxy to use when connecting to the Elasticsearch servers. The value may be either a complete URL or a "host[:port]", in which case the "http" scheme is assumed. If a value is not specified through the configuration file then proxy environment variables are used. See the -https://golang.org/pkg/net/http/#ProxyFromEnvironment[golang documentation] +https://golang.org/pkg/net/http/#ProxyFromEnvironment[Go documentation] for more information about the environment variables. [[index-option-es]] @@ -539,7 +539,7 @@ configured. The default value is 2. deprecated[5.0.0] The default port to use if the port number is not given in <>. The default port number -is 10200. +is 5044. ===== `proxy_url` diff --git a/libbeat/docs/overview.asciidoc b/libbeat/docs/overview.asciidoc index 332115a4bac9..55f8eb280a56 100644 --- a/libbeat/docs/overview.asciidoc +++ b/libbeat/docs/overview.asciidoc @@ -13,9 +13,9 @@ for capturing: Audit data:: https://www.elastic.co/products/beats/auditbeat[Auditbeat] Log files:: https://www.elastic.co/products/beats/filebeat[Filebeat] Availability:: https://www.elastic.co/products/beats/heartbeat[Heartbeat] -Metrics:: https://www.elastic.co/products/beats/metricbeat[Metricbeat] -Network traffic:: https://www.elastic.co/products/beats/packetbeat[Packetbeat] -Windows event logs:: https://www.elastic.co/products/beats/winlogbeat[Winlogbeat] +Metrics:: https://www.elastic.co/products/beats/metricbeat[Metricbeat] +Network traffic:: https://www.elastic.co/products/beats/packetbeat[Packetbeat] +Windows event logs:: https://www.elastic.co/products/beats/winlogbeat[Winlogbeat] {beats} can send data directly to {es} or via https://www.elastic.co/products/logstash[{ls}], where you can further process @@ -31,7 +31,7 @@ To get started, see <>. If you have a specific use case to solve, we encourage you to create a <>. We've created an infrastructure to simplify -the process. The _libbeat_ library, written entirely in Golang, offers the API +the process. The _libbeat_ library, written entirely in Go, offers the API that all Beats use to ship data to Elasticsearch, configure the input options, implement logging, and more. To learn how to create a new Beat, see the {beatsdevguide}/index.html[Beats Developer Guide]. diff --git a/libbeat/docs/template-config.asciidoc b/libbeat/docs/template-config.asciidoc index 354e90f1001a..0ab1c35681ee 100644 --- a/libbeat/docs/template-config.asciidoc +++ b/libbeat/docs/template-config.asciidoc @@ -82,14 +82,44 @@ setup.template.overwrite: false setup.template.settings: _source.enabled: false ---------------------------------------------------------------------- -ifeval::["{beatname_lc}"!="apm-server"] -*`setup.template.append_fields`*:: A list of of fields to be added to the template and Kibana index pattern. experimental[] - -NOTE: With append_fields only new fields can be added an no existing one overwritten or changed. This is especially useful if data is collected through the http/json metricset where the data structure is not known in advance. Changing the config of append_fields means the template has to be overwritten and only applies to new indices. If there are 2 Beats with different append_fields configs the last one writing the template will win. Any changes will also have an affect on the Kibana Index pattern. - -*`setup.template.json.enabled`*:: Set to true to load a json based template file. Specify the path to your Elasticsearch -index template file and set the name of the template. experimental[] +ifeval::["{beatname_lc}"!="apm-server"] +*`setup.template.append_fields`* experimental[]:: A list of fields to be added +to the template and {kib} index pattern. This setting adds new fields. It does +not overwrite or change existing fields. ++ +This setting is useful when your data contains fields that {beatname_uc} doesn't +know about in advance. +ifeval::["{beatname_lc}"=="metricbeat"] +For example, you might want to append fields to the template when you're using +a metricset, such as the <>, and the full data +structure is not known in advance. +endif::[] ++ +If `append_fields` is specified along with `overwrite: true`, {beatname_uc} +overwrites the existing template and applies the new template when creating new +indices. Existing indices are not affected. If you're running multiple +instances of {beatname_uc} with different `append_fields` settings, the last one +writing the template takes precedence. ++ +Any changes to this setting also affect the {kib} index pattern. ++ +Example config: ++ +[source,yaml] +---- +setup.template.overwrite: true +setup.template.append_fields: +- name: test.name + type: keyword +- name: test.hostname + type: long +---- + +*`setup.template.json.enabled`*:: Set to `true` to load a +JSON-based template file. Specify the path to your {es} index template file and +set the name of the template. ++ ["source","yaml",subs="attributes"] ---------------------------------------------------------------------- setup.template.json.enabled: true @@ -97,6 +127,7 @@ setup.template.json.path: "template.json" setup.template.json.name: "template-name ---------------------------------------------------------------------- -NOTE: If the JSON template is used, the fields.yml is skipped for the template generation. +NOTE: If the JSON template is used, the `fields.yml` is skipped for the template +generation. endif::[] diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc index 25505978175d..f479b4e8f469 100644 --- a/metricbeat/docs/fields.asciidoc +++ b/metricbeat/docs/fields.asciidoc @@ -5239,7 +5239,7 @@ expvar -- type: keyword -The cmdline of this golang program start with. +The cmdline of this Go program start with. -- @@ -5247,7 +5247,7 @@ The cmdline of this golang program start with. [float] == heap fields -The golang program heap information exposed by expvar. +The Go program heap information exposed by expvar. @@ -5256,7 +5256,7 @@ The golang program heap information exposed by expvar. -- type: keyword -The cmdline of this golang program start with. +The cmdline of this Go program start with. -- diff --git a/metricbeat/docs/modules/ceph.asciidoc b/metricbeat/docs/modules/ceph.asciidoc index b1d2f75886db..a9b096fdb159 100644 --- a/metricbeat/docs/modules/ceph.asciidoc +++ b/metricbeat/docs/modules/ceph.asciidoc @@ -10,6 +10,11 @@ beta[] The Ceph module collects metrics by submitting HTTP GET requests to the http://docs.ceph.com/docs/master/man/8/ceph-rest-api/[ceph-rest-api]. The default metricsets are `cluster_disk`, `cluster_health`, `monitor_health`, `pool_disk`, `osd_tree`. +[float] +=== Compatibility + +The Ceph module is tested with Ceph Jewel (10.2.10). + [float] === Example configuration diff --git a/metricbeat/docs/modules/couchbase.asciidoc b/metricbeat/docs/modules/couchbase.asciidoc index c8c47367beb6..20d69ae14549 100644 --- a/metricbeat/docs/modules/couchbase.asciidoc +++ b/metricbeat/docs/modules/couchbase.asciidoc @@ -10,6 +10,11 @@ beta[] This module periodically fetches metrics from https://www.couchbase.com/[Couchbase] servers. The default metricsets are `bucket`, `cluster`, `node`. +[float] +=== Compatibility + +The Couchbase module is tested with Couchbase 4.5.1. + [float] === Example configuration diff --git a/metricbeat/docs/modules/docker.asciidoc b/metricbeat/docs/modules/docker.asciidoc index 5419685b6eb2..4ba7b5ee641b 100644 --- a/metricbeat/docs/modules/docker.asciidoc +++ b/metricbeat/docs/modules/docker.asciidoc @@ -7,7 +7,12 @@ This file is generated! See scripts/docs_collector.py This module fetches metrics from https://www.docker.com/[Docker] containers. The default metricsets are: `container`, `cpu`, `diskio`, `healthcheck`, `info`, `memory` and `network`. The `image` metricset is not enabled by default. -The Docker module is currently not tested on Windows. +[float] +=== Compability + +The Docker module is currently tested on Linux and Mac with the community +edition engine, versions 1.11 and 17.09.0-ce. It is not tested on Windows, +but it should also work there. [float] === Module-specific configuration notes diff --git a/metricbeat/docs/modules/dropwizard.asciidoc b/metricbeat/docs/modules/dropwizard.asciidoc index 7a110f092926..9cd2bb27471d 100644 --- a/metricbeat/docs/modules/dropwizard.asciidoc +++ b/metricbeat/docs/modules/dropwizard.asciidoc @@ -9,6 +9,10 @@ beta[] This is the http://dropwizard.io[Dropwizard] module. The default metricset is `collector`. +[float] +=== Compability + +The Dropwizard module is tested with dropwizard metrics 3.1.0. [float] diff --git a/metricbeat/docs/modules/elasticsearch.asciidoc b/metricbeat/docs/modules/elasticsearch.asciidoc index 270b3906f43d..a382b6fc0916 100644 --- a/metricbeat/docs/modules/elasticsearch.asciidoc +++ b/metricbeat/docs/modules/elasticsearch.asciidoc @@ -11,6 +11,12 @@ The Elasticsearch module contains a minimal set of metrics to enable monitoring The default metricsets are `node` and `node_stats`. +[float] +=== Compability + +The Elasticsearch module is tested with Elasticsearch 6.3 and is expected to +work with all 6.x versions. + [float] === Example configuration diff --git a/metricbeat/docs/modules/envoyproxy.asciidoc b/metricbeat/docs/modules/envoyproxy.asciidoc index 030b71153cf8..a6fb7a1919de 100644 --- a/metricbeat/docs/modules/envoyproxy.asciidoc +++ b/metricbeat/docs/modules/envoyproxy.asciidoc @@ -13,6 +13,11 @@ This is the envoyproxy module. The default metricset is `server`. +[float] +=== Compability + +The envoyproxy module is tested with Envoy 1.7.0. + [float] === Example configuration diff --git a/metricbeat/docs/modules/etcd.asciidoc b/metricbeat/docs/modules/etcd.asciidoc index 3b7184424b30..e4cba1a5340c 100644 --- a/metricbeat/docs/modules/etcd.asciidoc +++ b/metricbeat/docs/modules/etcd.asciidoc @@ -11,6 +11,11 @@ This is the Etcd Module. The Etcd module uses https://coreos.com/etcd/docs/lates The default metricsets are `leader`, `self` and `store`. +[float] +=== Compatibility + +The etcd module is tested with etcd 3.2. + [float] === Example configuration diff --git a/metricbeat/docs/modules/jolokia.asciidoc b/metricbeat/docs/modules/jolokia.asciidoc index 6674ed18981f..16eb39c60d54 100644 --- a/metricbeat/docs/modules/jolokia.asciidoc +++ b/metricbeat/docs/modules/jolokia.asciidoc @@ -7,6 +7,12 @@ This file is generated! See scripts/docs_collector.py This is the Jolokia module. +[float] +=== Compatibility + +The Jolokia module is tested with Jolokia 1.5.0, it should work with any version +since 1.2.2. + [float] diff --git a/metricbeat/docs/modules/kafka.asciidoc b/metricbeat/docs/modules/kafka.asciidoc index faacaaea5b7d..b9b472645fe7 100644 --- a/metricbeat/docs/modules/kafka.asciidoc +++ b/metricbeat/docs/modules/kafka.asciidoc @@ -11,6 +11,9 @@ This is the Kafka module. The default metricsets are `consumergroup` and `partition`. +[float] +=== Compability + This module is tested with Kafka 0.10.2 and 1.1.0. diff --git a/metricbeat/docs/modules/kibana.asciidoc b/metricbeat/docs/modules/kibana.asciidoc index 0aa7ce4c2425..ebb12ee30829 100644 --- a/metricbeat/docs/modules/kibana.asciidoc +++ b/metricbeat/docs/modules/kibana.asciidoc @@ -11,6 +11,11 @@ The Kibana module only tracks the high-level metrics. To monitor more Kibana met The default metricset is `status`. +[float] +=== Compatibility + +The Kibana module is tested with Kibana 6.3. + [float] === Example configuration diff --git a/metricbeat/docs/modules/kubernetes.asciidoc b/metricbeat/docs/modules/kubernetes.asciidoc index d2398036c8db..5b12afca67a8 100644 --- a/metricbeat/docs/modules/kubernetes.asciidoc +++ b/metricbeat/docs/modules/kubernetes.asciidoc @@ -14,6 +14,11 @@ example configuration on how to do it. The default metricsets are `container`, `node`, `pod`, `system` and `volume`. +[float] +=== Compability + +The Kubernetes module is tested with Kubernetes 1.8.0, 1.9.4 and 1.10.0. + [float] === Example configuration diff --git a/metricbeat/docs/modules/kvm.asciidoc b/metricbeat/docs/modules/kvm.asciidoc index b5acf8877dc9..05f235344ad3 100644 --- a/metricbeat/docs/modules/kvm.asciidoc +++ b/metricbeat/docs/modules/kvm.asciidoc @@ -10,7 +10,6 @@ experimental[] This is the kvm module. - [float] === Example configuration diff --git a/metricbeat/docs/modules/logstash.asciidoc b/metricbeat/docs/modules/logstash.asciidoc index 999fee81aa33..f2a062bf3b62 100644 --- a/metricbeat/docs/modules/logstash.asciidoc +++ b/metricbeat/docs/modules/logstash.asciidoc @@ -11,6 +11,11 @@ This is the Logstash module. The default metricsets are `node` and `node_stats`. +[float] +=== Compability + +The logstash module is tested with logstash 6.3. + [float] === Example configuration diff --git a/metricbeat/docs/modules/memcached.asciidoc b/metricbeat/docs/modules/memcached.asciidoc index 5b0a425e5c0d..76a61a1076f8 100644 --- a/metricbeat/docs/modules/memcached.asciidoc +++ b/metricbeat/docs/modules/memcached.asciidoc @@ -11,6 +11,11 @@ This is the Memcached module. These metricsets were tested with Memcached versio The default metricset is `stats`. +[float] +=== Compatibility + +The memcached module is tested with memcached 1.4.35. + [float] === Example configuration diff --git a/metricbeat/docs/modules/munin.asciidoc b/metricbeat/docs/modules/munin.asciidoc index 08fd4fb272ad..a30361167bb8 100644 --- a/metricbeat/docs/modules/munin.asciidoc +++ b/metricbeat/docs/modules/munin.asciidoc @@ -11,6 +11,13 @@ This is the munin module. The default metricset is `node`. +[float] +=== Compatibility + +Munin module should be compatible with any implementation of the munin network +protocol (http://guide.munin-monitoring.org/en/latest/master/network-protocol.html), +it is tested with munin node 2.0. + [float] === Example configuration diff --git a/metricbeat/docs/modules/rabbitmq.asciidoc b/metricbeat/docs/modules/rabbitmq.asciidoc index 409f773d24c9..8c623e9e4d0a 100644 --- a/metricbeat/docs/modules/rabbitmq.asciidoc +++ b/metricbeat/docs/modules/rabbitmq.asciidoc @@ -13,6 +13,13 @@ The default metricsets are `connection`, `node`, `queue` and `exchange`. If `management.path_prefix` is set in RabbitMQ configuration, `management_path_prefix` has to be set to the same value in this module configuration. +[float] +=== Compatibility + +The rabbitmq module is tested with RabbitMQ 3.7.4, and it should be compatible +with any version supporting the management plugin. This plugin needs to be +enabled. + [float] === Example configuration diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index cf4df32f4163..fc82566f257d 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -1091,6 +1091,21 @@ output.elasticsearch: # never, once, and freely. Default is never. #ssl.renegotiation: never + # The number of times to retry publishing an event after a publishing failure. + # After the specified number of retries, the events are typically dropped. + # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting + # and retry until all events are published. Set max_retries to a value less + # than 0 to retry until all events are published. The default is 3. + #max_retries: 3 + + # The maximum number of events to bulk in a single Logstash request. The + # default is 2048. + #bulk_max_size: 2048 + + # The number of seconds to wait for responses from the Logstash server before + # timing out. The default is 30s. + #timeout: 30s + #------------------------------- Kafka output ---------------------------------- #output.kafka: # Boolean flag to enable or disable the output module. @@ -1502,6 +1517,13 @@ output.elasticsearch: # Path to fields.yml file to generate the template #setup.template.fields: "${path.config}/fields.yml" +# A list of fields to be added to the template and Kibana index pattern. Also +# specify setup.template.overwrite: true to overwrite the existing template. +# This setting is experimental. +#setup.template.append_fields: +#- name: field_name +# type: field_type + # Enable json template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false diff --git a/metricbeat/module/ceph/_meta/docs.asciidoc b/metricbeat/module/ceph/_meta/docs.asciidoc index ec2e4442f365..8d46ba911f93 100644 --- a/metricbeat/module/ceph/_meta/docs.asciidoc +++ b/metricbeat/module/ceph/_meta/docs.asciidoc @@ -1,2 +1,7 @@ The Ceph module collects metrics by submitting HTTP GET requests to the http://docs.ceph.com/docs/master/man/8/ceph-rest-api/[ceph-rest-api]. The default metricsets are `cluster_disk`, `cluster_health`, `monitor_health`, `pool_disk`, `osd_tree`. + +[float] +=== Compatibility + +The Ceph module is tested with Ceph Jewel (10.2.10). diff --git a/metricbeat/module/couchbase/_meta/docs.asciidoc b/metricbeat/module/couchbase/_meta/docs.asciidoc index 08f8895a95ca..97aa22fc1ee0 100644 --- a/metricbeat/module/couchbase/_meta/docs.asciidoc +++ b/metricbeat/module/couchbase/_meta/docs.asciidoc @@ -1,2 +1,7 @@ This module periodically fetches metrics from https://www.couchbase.com/[Couchbase] servers. The default metricsets are `bucket`, `cluster`, `node`. + +[float] +=== Compatibility + +The Couchbase module is tested with Couchbase 4.5.1. diff --git a/metricbeat/module/docker/_meta/docs.asciidoc b/metricbeat/module/docker/_meta/docs.asciidoc index eaed945814d1..90c299a72608 100644 --- a/metricbeat/module/docker/_meta/docs.asciidoc +++ b/metricbeat/module/docker/_meta/docs.asciidoc @@ -1,6 +1,11 @@ This module fetches metrics from https://www.docker.com/[Docker] containers. The default metricsets are: `container`, `cpu`, `diskio`, `healthcheck`, `info`, `memory` and `network`. The `image` metricset is not enabled by default. -The Docker module is currently not tested on Windows. +[float] +=== Compability + +The Docker module is currently tested on Linux and Mac with the community +edition engine, versions 1.11 and 17.09.0-ce. It is not tested on Windows, +but it should also work there. [float] === Module-specific configuration notes diff --git a/metricbeat/module/dropwizard/_meta/docs.asciidoc b/metricbeat/module/dropwizard/_meta/docs.asciidoc index 31cef1041852..193b984ae57d 100644 --- a/metricbeat/module/dropwizard/_meta/docs.asciidoc +++ b/metricbeat/module/dropwizard/_meta/docs.asciidoc @@ -1,2 +1,6 @@ This is the http://dropwizard.io[Dropwizard] module. The default metricset is `collector`. +[float] +=== Compability + +The Dropwizard module is tested with dropwizard metrics 3.1.0. diff --git a/metricbeat/module/elasticsearch/_meta/docs.asciidoc b/metricbeat/module/elasticsearch/_meta/docs.asciidoc index 9e6909c53cd2..3a47799f4fad 100644 --- a/metricbeat/module/elasticsearch/_meta/docs.asciidoc +++ b/metricbeat/module/elasticsearch/_meta/docs.asciidoc @@ -1,3 +1,9 @@ The Elasticsearch module contains a minimal set of metrics to enable monitoring of Elasticsearch across multiple versions. To monitor more Elasticsearch metrics, use our {monitoringdoc}/xpack-monitoring.html[monitoring] feature. The default metricsets are `node` and `node_stats`. + +[float] +=== Compability + +The Elasticsearch module is tested with Elasticsearch 6.3 and is expected to +work with all 6.x versions. diff --git a/metricbeat/module/envoyproxy/_meta/docs.asciidoc b/metricbeat/module/envoyproxy/_meta/docs.asciidoc index 45ba44944984..cc900202a117 100644 --- a/metricbeat/module/envoyproxy/_meta/docs.asciidoc +++ b/metricbeat/module/envoyproxy/_meta/docs.asciidoc @@ -3,3 +3,8 @@ This is the envoyproxy module. The default metricset is `server`. + +[float] +=== Compability + +The envoyproxy module is tested with Envoy 1.7.0. diff --git a/metricbeat/module/etcd/_meta/docs.asciidoc b/metricbeat/module/etcd/_meta/docs.asciidoc index 06493114846d..cad1c1bbd604 100644 --- a/metricbeat/module/etcd/_meta/docs.asciidoc +++ b/metricbeat/module/etcd/_meta/docs.asciidoc @@ -1,3 +1,8 @@ This is the Etcd Module. The Etcd module uses https://coreos.com/etcd/docs/latest/v2/api.html [Etcd v2 API] to collect metrics. The default metricsets are `leader`, `self` and `store`. + +[float] +=== Compatibility + +The etcd module is tested with etcd 3.2. diff --git a/metricbeat/module/golang/expvar/_meta/docs.asciidoc b/metricbeat/module/golang/expvar/_meta/docs.asciidoc index 7dee43fa0ede..49e126d70d2d 100644 --- a/metricbeat/module/golang/expvar/_meta/docs.asciidoc +++ b/metricbeat/module/golang/expvar/_meta/docs.asciidoc @@ -1,2 +1,2 @@ This is the `expvar` metricset of the Golang module. -Golang can expose its variables by the expvar API. With this metricset, you can collect all the expvar-exposed variables. +Go can expose its variables by the expvar API. With this metricset, you can collect all the expvar-exposed variables. diff --git a/metricbeat/module/golang/expvar/_meta/fields.yml b/metricbeat/module/golang/expvar/_meta/fields.yml index b316b60508e7..02b88ca43f15 100644 --- a/metricbeat/module/golang/expvar/_meta/fields.yml +++ b/metricbeat/module/golang/expvar/_meta/fields.yml @@ -7,4 +7,4 @@ - name: cmdline type: keyword description: > - The cmdline of this golang program start with. + The cmdline of this Go program start with. diff --git a/metricbeat/module/golang/fields.go b/metricbeat/module/golang/fields.go index 83dd1493a089..86e5ebdfc1ba 100644 --- a/metricbeat/module/golang/fields.go +++ b/metricbeat/module/golang/fields.go @@ -31,5 +31,5 @@ func init() { // Asset returns asset data func Asset() string { - return "eJzkV9tu40YMffdXEHnKokk+wEAX2Lqo+9CmBdIWBYrCoCVKmmYuwpCyrb8vZiQ5jiJp5WwCF1s9KSOHPOfwMuQtPFK9hNxptPkCQJRoWsLVOh5cLQBS4sSrUpSzS/i4AABoPoJxaaVpAcCF87JJnM1UvoQMNYdTT5qQaQlbEgy/IhFlc17CX1fM+urvBUCmSKe8jFZvwaKhEyzhkboMR95VZXsygOe5nVNbdCh36I/HQ/ZGbTbPCwt9Wt3Th3AKIzGpVpaefeuwPFK9dz7tfZtAFJ7fCuqMgstACsWtblB6l3s0wIJeYK+kuHshS0FYfokowX3PXTAJymbOGwz/EoRzTCls61bDu69ExEFweTKIq6/pDFRr9FvMCRKnNSXiPHBlDPr6rvfTIa1OIYkT1JsSK+5rNo1vBsZGvmAf1iuILiCtfBN4tyMPWmUkykRhS+8SYu7jn+JwysPysP+WgnbHZvEaFgDwfYdcWbgfgPlc0MRVVkYFHUEzX09bmS35INt6BXtkKLAsyVI6jsvSQTZ5stHKqLORNQW7hG0tNCT0HOT3dJAuX4OOe6V1ixv2BVn4kbD8pLVL4GNTZmiCiuOUkrLaZB6juVFGmXY4xHcO5B9a40Ho1a+/Q8zVqu1X69U4sverp5+Q5WU5cXhTNgcpCIyzSlz8sySv3EBSzKupsSSGNywrWAUnbSb3esSRk+IucSYYPeHmykyiHtP/HNhjfe1czNORgDkdDuaE4xxuM7rdKTCDh3eX+2c8fL1in6U27sa8vp3an3bkw3Tx/1N8cGzjmoX6LeXVo1u45rpp7WZfqKRortV4j7utoLKUQuadaR2/aqS7wA3ftMSGyxAPuObKhE7/5+HwUDNsSbv9h/FLtLNxASp/KIxxeqj5ZoLRXVxoNlwzfNu8qlQTfNO+24ppnB4LJo8X4PZdpNNNMREFYBi7UJy/AbRpmCKYzszKJ2Lt2naJuDXcOgAgLg5Evzx8psBb+mGQetMqP7H72v3MRBtDcnzpKnF/3CFaH+MRzTwNRuTtIEQPU63gH0rkPSD096k2ZJR2Pj+z6V0syZ+AXtOOLKhGxPQDSOFdlReukpj93ZI9TuRo6j9AJrQf6wRqkoYPXDMaAmRodkPcuh1N3BqhA1+Mh7LRP3CJdiJzwla5uyhK6+ztEend4t8AAAD//8IfSX8=" + return "eJzkV91u60QQvs9TjHrVI9o+QCSOdAgiXEBBKiAkhKKJPbaX7u5YO+skfnu0aztNXdvH6WkVdPBVsrZmvu+bn525hUeql5CzRpsvALzympZwtY4HVwuAlCRxqvSK7RI+LgAAmpdgOK00LQCkYOc3CdtM5UvIUEs4daQJhZawJY/hK/Je2VyW8NeViL76ewGQKdKpLKPVW7Bo6ARLeHxdhiPHVdmeDOB5bufUFh3KHbrj8ZC9UZvN88JCn1b39CGcwkhMqpWlZ+86LI9U79mlvXcTiMLzW0GdUeAMfKEE1gyl49yhAfHoPOyVL+5eSFIQll8iSHB94iqYA2UzdgbD50EwFkphW7fa3X0F4g0Cy5NBTH0tZyBao9tiTpCw1pR4diCVMejqu96nQzqdQvLsUW9KrKSv1zS+GRgb6YJ9WK8guoC0ck3QeUcOtMrIKxNFLR0nJNLHP8XhlIeVYf8tBc3HBvEaFgDwfYdcWbgfgPlc0IQr60cFHUEzX09bmS25INt6BXsUKLAsyVI6jsvSwW/yZKOVUWcja4p1Cdva05DQc5Df08F3+Rp03CutW9ywL8jCj4TlJ605gY9NiaEJKo5TSspqkzmM5kYZZZpxiO8cyD+0xoPQq19/h5irVdur1qtxZO9XTz+h+JflJOGXsjn4gsCwVZ7j35Kc4oGkmFdTY0kMb1hWsApO2kzu9YgjJyVd4kwwesItlZlEPab/ObDH+tq5mKcjAXM6HMwJxzncZnS7U2AGD+8u9894+HrFPktt3I15fTu1P+3Iheni/6f44NgmtXjqt5RXj27hmuumtZt9oZKiuVbjPc5bj8pSCplj0zp+1Uh3gRu+aYkNlyEecC2VCZ3+z8PhoRbYkub9h/FLtLNxASp/KIxxeqjlZoLRXVxmNlILfNv8VKkm+Kb9bSuhcXriMXm8ALfvIp1uiokoAMPYhZ7dDaBNwxQhdGZWPhFrV7ZLxK3h1gEAz3Eg+uXhMwXe0g+D1JtW+Ynd1+5nJtoYkuNLV4n74w7R+hiPaOZoMCJvByF6mGoF/1Di3wNCf59qQ0Zp5/Mzm97FkvwJ6DXtyIJqREw/gC8cV3nBlY/Z3y3Z40SOpv4DZEL7seyhJt/wgWtBQ4ACzW6IW97RxK0ROvDFeCgb/YOUaCcyJ2yVu4uitGxvj0jvFv8GAAD//zhDRDk=" } diff --git a/metricbeat/module/golang/heap/_meta/fields.yml b/metricbeat/module/golang/heap/_meta/fields.yml index 70715dce3e84..4bf3742bae76 100644 --- a/metricbeat/module/golang/heap/_meta/fields.yml +++ b/metricbeat/module/golang/heap/_meta/fields.yml @@ -1,13 +1,13 @@ - name: heap type: group description: > - The golang program heap information exposed by expvar. + The Go program heap information exposed by expvar. release: beta fields: - name: cmdline type: keyword description: > - The cmdline of this golang program start with. + The cmdline of this Go program start with. - name: gc type: group diff --git a/metricbeat/module/jolokia/_meta/docs.asciidoc b/metricbeat/module/jolokia/_meta/docs.asciidoc index e6756451731c..ec71c8d74a5b 100644 --- a/metricbeat/module/jolokia/_meta/docs.asciidoc +++ b/metricbeat/module/jolokia/_meta/docs.asciidoc @@ -1,2 +1,8 @@ This is the Jolokia module. +[float] +=== Compatibility + +The Jolokia module is tested with Jolokia 1.5.0, it should work with any version +since 1.2.2. + diff --git a/metricbeat/module/kafka/_meta/docs.asciidoc b/metricbeat/module/kafka/_meta/docs.asciidoc index a8682ea194b8..05e52c5369ce 100644 --- a/metricbeat/module/kafka/_meta/docs.asciidoc +++ b/metricbeat/module/kafka/_meta/docs.asciidoc @@ -2,4 +2,7 @@ This is the Kafka module. The default metricsets are `consumergroup` and `partition`. +[float] +=== Compability + This module is tested with Kafka 0.10.2 and 1.1.0. diff --git a/metricbeat/module/kibana/_meta/docs.asciidoc b/metricbeat/module/kibana/_meta/docs.asciidoc index a979535ac65a..a941ecb240dc 100644 --- a/metricbeat/module/kibana/_meta/docs.asciidoc +++ b/metricbeat/module/kibana/_meta/docs.asciidoc @@ -1,3 +1,8 @@ The Kibana module only tracks the high-level metrics. To monitor more Kibana metrics, use our {monitoringdoc}/xpack-monitoring.html[monitoring] feature. The default metricset is `status`. + +[float] +=== Compatibility + +The Kibana module is tested with Kibana 6.3. diff --git a/metricbeat/module/kubernetes/_meta/docs.asciidoc b/metricbeat/module/kubernetes/_meta/docs.asciidoc index 30909d4127fc..59fe65436703 100644 --- a/metricbeat/module/kubernetes/_meta/docs.asciidoc +++ b/metricbeat/module/kubernetes/_meta/docs.asciidoc @@ -6,3 +6,8 @@ service within the cluster, while the rest should be pointed to kubelet service. example configuration on how to do it. The default metricsets are `container`, `node`, `pod`, `system` and `volume`. + +[float] +=== Compability + +The Kubernetes module is tested with Kubernetes 1.8.0, 1.9.4 and 1.10.0. diff --git a/metricbeat/module/kvm/_meta/docs.asciidoc b/metricbeat/module/kvm/_meta/docs.asciidoc index 99141215f113..3658a4ccae85 100644 --- a/metricbeat/module/kvm/_meta/docs.asciidoc +++ b/metricbeat/module/kvm/_meta/docs.asciidoc @@ -1,2 +1 @@ This is the kvm module. - diff --git a/metricbeat/module/logstash/_meta/docs.asciidoc b/metricbeat/module/logstash/_meta/docs.asciidoc index bddd411d4029..1627fa350270 100644 --- a/metricbeat/module/logstash/_meta/docs.asciidoc +++ b/metricbeat/module/logstash/_meta/docs.asciidoc @@ -1,3 +1,8 @@ This is the Logstash module. The default metricsets are `node` and `node_stats`. + +[float] +=== Compability + +The logstash module is tested with logstash 6.3. diff --git a/metricbeat/module/memcached/_meta/docs.asciidoc b/metricbeat/module/memcached/_meta/docs.asciidoc index 848df9e5d697..53b33a0e1117 100644 --- a/metricbeat/module/memcached/_meta/docs.asciidoc +++ b/metricbeat/module/memcached/_meta/docs.asciidoc @@ -1,3 +1,8 @@ This is the Memcached module. These metricsets were tested with Memcached version 1.4.35. The default metricset is `stats`. + +[float] +=== Compatibility + +The memcached module is tested with memcached 1.4.35. diff --git a/metricbeat/module/munin/_meta/docs.asciidoc b/metricbeat/module/munin/_meta/docs.asciidoc index d4148381d2eb..6476645f5e1f 100644 --- a/metricbeat/module/munin/_meta/docs.asciidoc +++ b/metricbeat/module/munin/_meta/docs.asciidoc @@ -1,3 +1,10 @@ This is the munin module. The default metricset is `node`. + +[float] +=== Compatibility + +Munin module should be compatible with any implementation of the munin network +protocol (http://guide.munin-monitoring.org/en/latest/master/network-protocol.html), +it is tested with munin node 2.0. diff --git a/metricbeat/module/rabbitmq/_meta/docs.asciidoc b/metricbeat/module/rabbitmq/_meta/docs.asciidoc index 7d4677f809e1..add71e58e9cd 100644 --- a/metricbeat/module/rabbitmq/_meta/docs.asciidoc +++ b/metricbeat/module/rabbitmq/_meta/docs.asciidoc @@ -3,3 +3,10 @@ The RabbitMQ module uses http://www.rabbitmq.com/management.html[HTTP API] creat The default metricsets are `connection`, `node`, `queue` and `exchange`. If `management.path_prefix` is set in RabbitMQ configuration, `management_path_prefix` has to be set to the same value in this module configuration. + +[float] +=== Compatibility + +The rabbitmq module is tested with RabbitMQ 3.7.4, and it should be compatible +with any version supporting the management plugin. This plugin needs to be +enabled. diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml index 2121bc8f9692..fddd29ee53b7 100644 --- a/packetbeat/packetbeat.reference.yml +++ b/packetbeat/packetbeat.reference.yml @@ -894,6 +894,21 @@ output.elasticsearch: # never, once, and freely. Default is never. #ssl.renegotiation: never + # The number of times to retry publishing an event after a publishing failure. + # After the specified number of retries, the events are typically dropped. + # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting + # and retry until all events are published. Set max_retries to a value less + # than 0 to retry until all events are published. The default is 3. + #max_retries: 3 + + # The maximum number of events to bulk in a single Logstash request. The + # default is 2048. + #bulk_max_size: 2048 + + # The number of seconds to wait for responses from the Logstash server before + # timing out. The default is 30s. + #timeout: 30s + #------------------------------- Kafka output ---------------------------------- #output.kafka: # Boolean flag to enable or disable the output module. @@ -1305,6 +1320,13 @@ output.elasticsearch: # Path to fields.yml file to generate the template #setup.template.fields: "${path.config}/fields.yml" +# A list of fields to be added to the template and Kibana index pattern. Also +# specify setup.template.overwrite: true to overwrite the existing template. +# This setting is experimental. +#setup.template.append_fields: +#- name: field_name +# type: field_type + # Enable json template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml index 244093083168..b686b5746d62 100644 --- a/winlogbeat/winlogbeat.reference.yml +++ b/winlogbeat/winlogbeat.reference.yml @@ -446,6 +446,21 @@ output.elasticsearch: # never, once, and freely. Default is never. #ssl.renegotiation: never + # The number of times to retry publishing an event after a publishing failure. + # After the specified number of retries, the events are typically dropped. + # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting + # and retry until all events are published. Set max_retries to a value less + # than 0 to retry until all events are published. The default is 3. + #max_retries: 3 + + # The maximum number of events to bulk in a single Logstash request. The + # default is 2048. + #bulk_max_size: 2048 + + # The number of seconds to wait for responses from the Logstash server before + # timing out. The default is 30s. + #timeout: 30s + #------------------------------- Kafka output ---------------------------------- #output.kafka: # Boolean flag to enable or disable the output module. @@ -857,6 +872,13 @@ output.elasticsearch: # Path to fields.yml file to generate the template #setup.template.fields: "${path.config}/fields.yml" +# A list of fields to be added to the template and Kibana index pattern. Also +# specify setup.template.overwrite: true to overwrite the existing template. +# This setting is experimental. +#setup.template.append_fields: +#- name: field_name +# type: field_type + # Enable json template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false