logstash-input-jmx 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b960e6c16e259f4b5f6f399f866d1029d663553
-  data.tar.gz: d75ef687ae03e0d4f8d5b4bb16d258dc6575b525
+  metadata.gz: 67673b34c4e945d059fcaa7e33a03ca2070b1bba
+  data.tar.gz: 7f2d0ad1b534e028be342a40576e051fd5d5b55d
 SHA512:
-  metadata.gz: 77b9a796e34f408753af49da83c4d67052e8d0c31d585617f64de7d1439a59745e94c62b33adb22dea6728d0416d6a0255cd80817cd3e90850cee63e869cbc54
-  data.tar.gz: df2348e08eb37b68e59ad88288ea65e483eb0ffb4ba27592388387095633dee87167695809d0243f42c210bb798b76ee2e44d54cbc47841d6a94c15b32900781
+  metadata.gz: 1880ae440dbc2769ac3f56a00cea10c256740992663ca0ef86050a715e5ed5838cf29571b0ba576383a1b8292f5a31b674f7a54ca76fc9c259e6de85756c566d
+  data.tar.gz: 1680bf84de7847953ad9d98aab0144b60c37b1be82058680c0e045236c96e7ee25b16288320f8e81471668ca7e42582581f61b641d29ef451130118d4ffd497e

data/CONTRIBUTORS

@@ -5,6 +5,8 @@ Contributors:
 * Nicolas Fraison (ashangit)
 * Pier-Hugues Pellerin (ph)
 * Richard Pijnenburg (electrical)
+* Pere Urbon-Bayes (purbon)
+* Colin Surprenant (colinsurprenant)
 
 Note: If you've sent us patches, bug reports, or otherwise contributed to
 Logstash, and you aren't on the list above and want to be, please let us know

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/logstash/inputs/jmx.rb

@@ -1,6 +1,95 @@
-# Permits to retrieve metrics from jmx.
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/json"
+
+# 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:
+# [source,ruby]
+#     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:
+# [source,js]
+#     {
+#       //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.
+# [source,ruby]
+#     {
+#       "@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
+#     }
+#
+# [source,ruby]
+#     {
+#       "@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"
+#     }
+#
 class LogStash::Inputs::Jmx < LogStash::Inputs::Base
-  # TODO add documentation
   config_name 'jmx'
 
   #Class Var
@@ -10,7 +99,7 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
   # Path where json conf files are stored
   config :path, :validate => :string, :required => true
 
-  # Indicate interval between to jmx metrics retrieval
+  # Indicate interval between two jmx metrics retrieval
   # (in s)
   config :polling_frequency, :validate => :number, :default => 60
 
@@ -20,11 +109,9 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
   # Read and parse json conf
   private
   def read_conf(file_conf)
-    require 'json'
-
     @logger.debug("Parse json #{file_conf} to ruby data structure")
     json = File.read(file_conf)
-    JSON.parse(json)
+    LogStash::Json.load(json)
   end
 
   # Verify that all required parameter are present in the conf_hash

data/logstash-input-jmx.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-jmx'
-  s.version         = '0.1.3'
+  s.version         = '0.1.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Retrieve metrics from jmx."
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
-  s.authors         = ["Elasticsearch"]
-  s.email           = 'info@elasticsearch.com'
-  s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
+  s.authors         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
   s.require_paths = ["lib"]
 
   # Files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jmx
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
-- Elasticsearch
+- Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
-email: info@elasticsearch.com
+email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -73,7 +73,7 @@ files:
 - lib/logstash/inputs/jmx.rb
 - logstash-input-jmx.gemspec
 - spec/inputs/jmx_spec.rb
-homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
 metadata:
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.5
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: Retrieve metrics from jmx.