diff --git a/filebeat/docs/migration.asciidoc b/filebeat/docs/migration.asciidoc index 01b87846852..92c1102ef3b 100644 --- a/filebeat/docs/migration.asciidoc +++ b/filebeat/docs/migration.asciidoc @@ -31,7 +31,7 @@ https://github.com/elastic/logstash-forwarder[Logstash Forwarder] to {beatname_u {beatname_uc} requires the {logstash-ref}/plugins-inputs-beats.html[Beats input plugin for Logstash]. For information about getting started with this plugin, -see {stack-ov}/get-started-elastic-stack.html#logstash-setup[Configure Logstash to +see {stack-gs}/get-started-elastic-stack.html#logstash-setup[Configure Logstash to listen for Beats input] in the {stack} getting started tutorial. In both the 1.5.x and 2.x versions of Logstash, this plugin can be loaded in diff --git a/filebeat/docs/modules-getting-started.asciidoc b/filebeat/docs/modules-getting-started.asciidoc index c1d6d267893..fe9f8814654 100644 --- a/filebeat/docs/modules-getting-started.asciidoc +++ b/filebeat/docs/modules-getting-started.asciidoc @@ -23,7 +23,7 @@ following the numbered steps under <>. Before running {beatname_uc} modules: * Install and configure the Elastic stack. See -{stack-ov}/get-started-elastic-stack.html[Getting started with the {stack}]. +{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]. * Complete the {beatname_uc} installation instructions described in <>. After installing {beatname_uc}, return to this diff --git a/libbeat/docs/gettingstarted.asciidoc b/libbeat/docs/gettingstarted.asciidoc index ae65c0d8d18..eedb206f636 100644 --- a/libbeat/docs/gettingstarted.asciidoc +++ b/libbeat/docs/gettingstarted.asciidoc @@ -3,7 +3,7 @@ Each Beat is a separately installable product. Before installing Beats, you need to install and configure the {stack}. To learn how to get up and running -quickly, see {stack-ov}/get-started-elastic-stack.html[Getting started with the +quickly, see {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]. [TIP] diff --git a/libbeat/docs/shared-download-and-install.asciidoc b/libbeat/docs/shared-download-and-install.asciidoc index d2c25c567a2..fe719f64d2c 100644 --- a/libbeat/docs/shared-download-and-install.asciidoc +++ b/libbeat/docs/shared-download-and-install.asciidoc @@ -1,6 +1,6 @@ *Before you begin*: If you haven't installed the {stack}, do that now. See -{stack-ov}/get-started-elastic-stack.html[Getting started with the {stack}]. +{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]. To download and install {beatname_uc}, use the commands that work with your system (<> for Debian/Ubuntu, <> for Redhat/Centos/Fedora, < jmx.mappings: - mbean: 'java.lang:type=Runtime' attributes: - attr: Uptime - field: uptime - event: uptime + field: uptime <2> + event: uptime <3> target: url: "service:jmx:rmi:///jndi/rmi://targethost:9999/jmxrmi" user: "jolokia" password: "s!cr!t" ---- +---- +<1> The `namespace` setting is required. This setting is used along with the +module name to qualify field names in the output event. +<2> The field where the returned value will be saved. This field will be called +`jolokia.testnamespace.uptime` in the output event. +<3> The `event` setting is optional. Use this setting to group all attributes +with the same `event` value into the same event when sending data to Elastic. -In case the underlying attribute is an object (e.g. see HeapMemoryUsage attribute in java.lang:type=Memory) its -structure will be published to Elastic "as is". +If the underlying attribute is an object (such as the `HeapMemoryUsage` +attribute in `java.lang:type=Memory`), its structure will be published to +Elastic "as is". -It is possible to configure nested metric aliases by using dots in the mapping name (e.g. gc.cms_collection_time). For examples please refer to the +You can configure nested metric aliases by using dots in the mapping name (for +example, `gc.cms_collection_time`). For more examples, see https://github.com/elastic/beats/blob/{doc-branch}/metricbeat/module/jolokia/jmx/_meta/test/config.yml[/jolokia/jmx/test/config.yml]. -All metrics from a single mapping will be POSTed to the defined host/port and sent to Elastic as a single event. -To make it possible to differentiate between metrics from multiple similar applications running on the same host, -please configure multiple modules. +All metrics from a single mapping will be POSTed to the defined host/port and +sent to Elastic as a single event. To make it possible to differentiate between +metrics from multiple similar applications running on the same host, you should +configure multiple modules. -When wildcards are used, an event will be sent to Elastic for each matching mbean, in that case a `mbean` field is added. - -Optionally, an `event` name can be added to each attribute, this makes all metrics with the same `event` -to be grouped in the same event when being sent to Elastic. - -It is required to set a namespace in the general module config section. +When wildcards are used, an event is sent to Elastic for each matching +MBean, and an `mbean` field is added to the event. [float] === Limitations -No authentication against Jolokia is supported yet. -All Jolokia requests have canonicalNaming set to false (details see here: https://jolokia.org/reference/html/protocol.html). +All Jolokia requests have `canonicalNaming` set to `false`. See the +https://jolokia.org/reference/html/protocol.html[Jolokia Protocol] documentation +for more detail about this parameter. [float] === Exposed fields, dashboards, indexes, etc. -Since this is a very general module that can be tailored for any application that exposes its metrics over Jolokia, it -comes with no exposed fields description, dashboards or index patterns. +Because this module is very general and can be tailored for any application that +exposes its metrics over Jolokia, it comes with no exposed field descriptions, +dashboards, or index patterns. diff --git a/winlogbeat/docs/getting-started.asciidoc b/winlogbeat/docs/getting-started.asciidoc index 3a4185b1f78..dca176fbd85 100644 --- a/winlogbeat/docs/getting-started.asciidoc +++ b/winlogbeat/docs/getting-started.asciidoc @@ -15,7 +15,7 @@ include::../../libbeat/docs/shared-getting-started-intro.asciidoc[] === Step 1: Install Winlogbeat *Before you begin*: If you haven't installed the {stack}, do that now. See -{stack-ov}/get-started-elastic-stack.html[Getting started with the {stack}]. +{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]. . Download the Winlogbeat zip file from the https://www.elastic.co/downloads/beats/winlogbeat[downloads page].