IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Jolokia module Kafka module »
Elastic Docs ›Metricbeat Reference [6.7] ›Modules ›Jolokia module

Jolokia jmx metricset

edit

Jolokia jmx metricset

edit

The jmx metricset collects metrics from Jolokia agents.

Features and configuration

edit

Tested with Jolokia 1.5.0.

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 an event field called jolokia.testnamespace.uptime, configure the following mapping:

- module: jolokia
  metricsets: ["jmx"]
  hosts: ["localhost:8778"]
  namespace: "testnamespace" 
  http_method: "POST" 
  jmx.mappings:
    - mbean: 'java.lang:type=Runtime'
      attributes:
        - attr: Uptime
          field: uptime 
          event: uptime 
      target:
          url: "service:jmx:rmi:///jndi/rmi://targethost:9999/jmxrmi"
          user: "jolokia"
          password: "s!cr!t"

The namespace setting is required. This setting is used along with the module name to qualify field names in the output event.

The http_method setting is optional. By default all requests to Jolokia are performed using POST HTTP method. This setting allows only two values: POST or GET.

The field where the returned value will be saved. This field will be called jolokia.testnamespace.uptime in the output event.

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.

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".

You can configure nested metric aliases by using dots in the mapping name (for example, gc.cms_collection_time). For more examples, see /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, you should configure multiple modules.

When wildcards are used, an event is sent to Elastic for each matching MBean, and an mbean field is added to the event.

Accessing Jolokia via POST or GET method

edit

All requests to Jolokia are made by default using HTTP POST method. However, there are specific circumstances on the environment where Jolokia agent is deployed, in which POST method can be unavailable. In this case you can use HTTP GET method, by defining http_method attribute. In general you can use either POST or GET, but GET has the following drawbacks:

  1. Proxy requests are not allowed.
  2. If more than one jmx.mappings are defined, then Metricbeat will perform as many GET requests as the mappings defined. For example the following configuration with 3 mappings will create 3 GET requests, one for every MBean. On the contrary, if you use HTTP POST, Metricbeat will create only 1 request to Jolokia. 
- module: jolokia
  metricsets: ["jmx"]
  enabled: true
  period: 10s
  hosts: ["localhost:8080"]
  namespace: "jolokia_metrics"
  path: "/jolokia"
  http_method: 'GET'
  jmx.mappings:
    - mbean: 'java.lang:type=Memory'
      attributes:
       - attr: HeapMemoryUsage
         field: memory.heap_usage
       - attr: NonHeapMemoryUsage
         field: memory.non_heap_usage
    - mbean: 'Catalina:name=*,type=ThreadPool'
      attributes:
       - attr: port
         field: catalina.port
       - attr: maxConnections
         field: catalina.maxConnections
    - mbean: 'java.lang:type=Runtime'
      attributes:
       - attr: Uptime
         field: uptime

Limitations

edit
  1. All Jolokia requests have canonicalNaming set to false. See the Jolokia Protocol documentation for more detail about this parameter.
  2. If http_method is set to GET, then Proxy requests are not allowed. Thus, setting a value to target section is going to fail with an error.

Exposed fields, dashboards, indexes, etc.

edit

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.

Fields

edit

For a description of each field in the metricset, see the exported fields section.

Here is an example document generated by this metricset:

{
    "@timestamp": "2017-10-12T08:05:34.853Z",
    "beat": {
        "hostname": "host.example.com",
        "name": "host.example.com"
    },
    "event": {
        "dataset": "jolokia.jmx",
        "duration": 115000
    },
    "jolokia": {
        "testnamespace": {
            "memory": {
                "heap_usage": {
                    "committed": 514850816,
                    "init": 536870912,
                    "max": 7635730432,
                    "used": 56910392
                },
                "non_heap_usage": {
                    "committed": 29949952,
                    "init": 2555904,
                    "max": -1,
                    "used": 28942544
                }
            },
            "uptime": 1663331
        }
    },
    "metricset": {
        "host": "127.0.0.1:8778",
        "module": "jolokia",
        "name": "jmx",
        "namespace": "jolokia.testnamespace",
        "rtt": 115
    }
}
« Jolokia module Kafka module »