jmxedit

  • Version: 3.0.1
  • Released on: 2017-01-10
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-input-jmx.

This input plugin permits to retrieve metrics from remote Java applications using JMX. Every polling_frequency, it scans a folder containing json configuration files describing JVMs to monitor with metrics to retrieve. Then a pool of threads will retrieve metrics and create events.

## The configuration:

In Logstash configuration, you must set the polling frequency, the number of thread used to poll metrics and a directory absolute path containing json files with the configuration per jvm of metrics to retrieve. Logstash input configuration example:

jmx {
  //Required
  path => "/apps/logstash_conf/jmxconf"
  //Optional, default 60s
  polling_frequency => 15
  type => "jmx"
  //Optional, default 4
  nb_thread => 4
}

Json JMX configuration example:

{
  //Required, JMX listening host/ip
  "host" : "192.168.1.2",
  //Required, JMX listening port
  "port" : 1335,
  //Optional, the username to connect to JMX
  "username" : "user",
  //Optional, the password to connect to JMX
  "password": "pass",
  //Optional, use this alias as a prefix in the metric name. If not set use <host>_<port>
  "alias" : "test.homeserver.elasticsearch",
  //Required, list of JMX metrics to retrieve
  "queries" : [
  {
    //Required, the object name of Mbean to request
    "object_name" : "java.lang:type=Memory",
    //Optional, use this alias in the metrics value instead of the object_name
    "object_alias" : "Memory"
  }, {
    "object_name" : "java.lang:type=Runtime",
    //Optional, set of attributes to retrieve. If not set retrieve
    //all metrics available on the configured object_name.
    "attributes" : [ "Uptime", "StartTime" ],
    "object_alias" : "Runtime"
  }, {
    //object_name can be configured with * to retrieve all matching Mbeans
    "object_name" : "java.lang:type=GarbageCollector,name=*",
    "attributes" : [ "CollectionCount", "CollectionTime" ],
    //object_alias can be based on specific value from the object_name thanks to ${<varname>}.
    //In this case ${type} will be replaced by GarbageCollector...
    "object_alias" : "${type}.${name}"
  }, {
    "object_name" : "java.nio:type=BufferPool,name=*",
    "object_alias" : "${type}.${name}"
  } ]
}

Here are examples of generated events. When returned metrics value type is number/boolean it is stored in metric_value_number event field otherwise it is stored in metric_value_string event field.

{
  "@version" => "1",
  "@timestamp" => "2014-02-18T20:57:27.688Z",
  "host" => "192.168.1.2",
  "path" => "/apps/logstash_conf/jmxconf",
  "type" => "jmx",
  "metric_path" => "test.homeserver.elasticsearch.GarbageCollector.ParNew.CollectionCount",
  "metric_value_number" => 2212
}
{
  "@version" => "1",
  "@timestamp" => "2014-02-18T20:58:06.376Z",
  "host" => "localhost",
  "path" => "/apps/logstash_conf/jmxconf",
  "type" => "jmx",
  "metric_path" => "test.homeserver.elasticsearch.BufferPool.mapped.ObjectName",
  "metric_value_string" => "java.nio:type=BufferPool,name=mapped"
}

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

jmx {
    path => ...
}

Available configuration options:

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

nb_threadedit

  • Value type is number
  • Default value is 4

Indicate number of thread launched to retrieve metrics

pathedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

Path where json conf files are stored

polling_frequencyedit

  • Value type is number
  • Default value is 60

Indicate interval between two jmx metrics retrieval (in s)

tagsedit

  • Value type is array
  • There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

typeedit

  • Value type is string
  • There is no default value for this setting.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.