Skip to content

Commit

Permalink
Backport to 6.x: #7969 and #8172 (#8191)
Browse files Browse the repository at this point in the history
* Improve Jolokia docs and remove proxy restriction (#7969)

* Update links to point to new GS location (#8172)

* Run make update
  • Loading branch information
dedemorton authored Sep 4, 2018
1 parent abdb6d0 commit 18bb8bd
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 37 deletions.
2 changes: 1 addition & 1 deletion filebeat/docs/migration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion filebeat/docs/modules-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ following the numbered steps under <<filebeat-getting-started>>.
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
<<filebeat-installation>>. After installing {beatname_uc}, return to this
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/shared-download-and-install.asciidoc
Original file line number Diff line number Diff line change
@@ -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
(<<deb, deb>> for Debian/Ubuntu, <<rpm, rpm>> for Redhat/Centos/Fedora, <<mac,
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/shared-getting-started-intro.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ related products:
* {kib} for the UI.
* {ls} (optional) for parsing and enhancing the data.
See {stack-ov}/get-started-elastic-stack.html[Getting started with the {stack}]
See {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]
for more information.

[TIP]
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/shared-logstash-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
To send events to {ls}, you also need to create a {ls} configuration pipeline
that listens for incoming Beats connections and indexes the received events into
{es}. For more information, see the section about
{stack-ov}/get-started-elastic-stack.html#logstash-setup[configuring {ls}] in
{stack-gs}/get-started-elastic-stack.html#logstash-setup[configuring {ls}] in
the {stack} getting started tutorial. Also see the documentation for the
{logstash-ref}/plugins-inputs-beats.html[{beats} input] and
{logstash-ref}/plugins-outputs-elasticsearch.html[{es} output] plugins.
Expand Down
13 changes: 12 additions & 1 deletion metricbeat/docs/modules/jolokia.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,18 @@ This file is generated! See scripts/docs_collector.py
[[metricbeat-module-jolokia]]
== Jolokia module

This is the Jolokia module.
This module collects metrics from
https://jolokia.org/reference/html/agents.html[Jolokia agents] running on a
target JMX server or dedicated proxy server. The default metricset is `jmx`.

To collect metrics, {beatname_uc} communicates with a Jolokia HTTP/REST
endpoint that exposes the JMX metrics over HTTP/REST/JSON.

[float]
=== Compatibility

The Jolokia module is tested with Jolokia 1.5.0. It should work with version
1.2.2 and later.

[float]
=== Compatibility
Expand Down
13 changes: 12 additions & 1 deletion metricbeat/module/jolokia/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
This is the Jolokia module.
This module collects metrics from
https://jolokia.org/reference/html/agents.html[Jolokia agents] running on a
target JMX server or dedicated proxy server. The default metricset is `jmx`.

To collect metrics, {beatname_uc} communicates with a Jolokia HTTP/REST
endpoint that exposes the JMX metrics over HTTP/REST/JSON.

[float]
=== Compatibility

The Jolokia module is tested with Jolokia 1.5.0. It should work with version
1.2.2 and later.

[float]
=== Compatibility
Expand Down
66 changes: 38 additions & 28 deletions metricbeat/module/jolokia/jmx/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,58 +1,68 @@
This is the `jmx` metricset of the Jolokia module.
The `jmx` metricset collects metrics from
https://jolokia.org/reference/html/agents.html[Jolokia agents].

[float]
=== Features and configuration
Tested with Jolokia 1.3.4.
Tested with Jolokia 1.5.0.

Metrics to be collected from each Jolokia instance are defined in the mapping section with an MBean ObjectName and
an array of Attributes to be requested with Elastic field names under which the return values should be saved.
To collect metrics from a Jolokia instance, define a mapping section that
specifies an MBean `ObjectName` followed by an array of attributes to fetch. For
each attribute in the array, specify the Elastic field name where the
returned value will be saved.

For example: to get the "Uptime" attribute from the "java.lang:type=Runtime" MBean and map it to something like
"uptime" (actually "jolokia.jmx.uptime", the prexif is added by beats framework) you have to configure following
mapping:
For example, to get the `Uptime` attribute from the `java.lang:type=Runtime`
MBean and map it to an event field called `jolokia.testnamespace.uptime`,
configure the following mapping:

[source,yaml]
---
----
- module: jolokia
metricsets: ["jmx"]
hosts: ["localhost:8778"]
namespace: "metrics"
namespace: "testnamespace" <1>
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.
2 changes: 1 addition & 1 deletion winlogbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down

0 comments on commit 18bb8bd

Please sign in to comment.