logstash-input-jmx 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf1d9ed39a9edd9a28f5cd7a6bcd3bfc46cb4fc4
-  data.tar.gz: 4fbc5c8b0d77b3375ff3745ffe4e310cf01670d8
+  metadata.gz: 437380d57bea6a1695c2ed5b7d0ed982860a47f2
+  data.tar.gz: c5dc3603c6062da55daa7059d97b413e5c84f29a
 SHA512:
-  metadata.gz: 49498f27ae5814f817bff216e790b3b22190e4700ebe185b569303a2710508e0c783b89e4d60c3287f3b5aad2014008c72eacbefd60fc862febfeaf50c4a08a5
-  data.tar.gz: bba4e01ea2a13d2b8a7988e6a5eae3742a8ad374c324438f267beb6ac0d843ade7fa3192c82fedc9858e3339cba2c25790ad8c0144dc0dd76da446c8b94485b1
+  metadata.gz: 950c100835e20f0d7df3b8ad5b115ef23364efc4bff1d267d3cc9e599f39fd16a717eb1e8ce1f305c7f591ab5ecbb269ffe9d9592a2a79bb1a3c6ec5cad7237b
+  data.tar.gz: 165e18b60459732a0fae197479bc72921bd8dc4e628c0beb2dd3c026d86674a82c0c8852b7dd56e46e93dabed59c3978ef388ceaa23787062a69f5cd67060848

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-gemspec
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,157 @@
+:plugin: jmx
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Jmx input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+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"
+    }
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Jmx Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-nb_thread>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-path>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-polling_frequency>> |<<number,number>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-nb_thread"]
+===== `nb_thread` 
+
+  * Value type is <<number,number>>
+  * Default value is `4`
+
+Indicate number of thread launched to retrieve metrics
+
+[id="plugins-{type}s-{plugin}-path"]
+===== `path` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Path where json conf files are stored
+
+[id="plugins-{type}s-{plugin}-polling_frequency"]
+===== `polling_frequency` 
+
+  * Value type is <<number,number>>
+  * Default value is `60`
+
+Indicate interval between two jmx metrics retrieval
+(in s)
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-jmx.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-jmx'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   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/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jmx
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/jmx.rb
 - logstash-input-jmx.gemspec
 - spec/inputs/jmx_spec.rb