sensu-plugins-jolokia-metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 948f9971f9210fabdc2fdac6788890686b080e26
+  data.tar.gz: 1373283f01a6a9e106c034ec0b27d4aa228b4115
+SHA512:
+  metadata.gz: 411816d1eee0d0251c6e309ed6f5fc6cb58acde20f1df5990acc500f317dd566908ca7f5df83cca6b0fcd8518019dad2d2f39247a51c9fda8cc15e24bc8972b0
+  data.tar.gz: 5439b3562acd03d42d9dac19923f501ff2f1bedbeea8cc9a4c965e7c594327e3d09b9e1d15c6ebb04118228fc007cb617ea308f0424f29d0aa7eeebbde8b4342

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
+## [Unreleased]
+
+## [0.0.1] - 2020-03-31
+
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-jolokia-metrics)
+[![Build Status](https://travis-ci.org/fgouteroux/sensu-plugins-jolokia-metrics.svg?branch=master)](https://travis-ci.org/fgouteroux/sensu-plugins-jolokia-metrics)
+
+## Sensu Jolokia Metrics Plugin
+
+- [Overview](#overview)
+- [Usage examples](#usage-examples)
+- [Configuration](#configuration)
+  - [Sensu Go](#sensu-go)
+    - [Asset definition](#asset-definition)
+    - [Check definition](#check-definition)
+  - [Sensu Core](#sensu-core)
+    - [Check definition](#check-definition)
+- [Functionality](#functionality)
+- [Installation](#installation)
+
+### Overview 
+
+This plugin provides native HTTP instrumentation for jolokia metrics collection.
+
+The Sensu assets packaged from this repository are built against the Sensu ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator or handler), make sure you include the corresponding Sensu ruby runtime asset in the list of assets needed by the resource.  The current ruby-runtime assets can be found [here](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the [Bonsai Asset Index](bonsai.sensu.io)
+
+#### Files
+ * bin/jolokia-metrics.rb
+
+## Usage examples
+
+**jolokia-metrics.rb**
+```
+Usage: jolokia-metrics.rb (options)
+    -u, --url URL          Full URL to the jolokia endpoint
+    -f, --file FILE        File path with metrics name to retrieve
+    -s, --scheme SCHEME    Metric naming scheme, text to prepend to metric
+    -d, --debug            Include debug output, should not use in production.
+    -k, --insecure         Disable SSL verification
+```
+
+### Configuration
+#### Sensu Go
+##### Asset registration
+
+Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 or later, you can use the following command to add the asset: 
+
+`sensuctl asset add fgouteroux/sensu-plugins-jolokia-metrics`
+
+If you're using an earlier version of sensuctl, you can download the asset definition from [this project's Bonsai Asset Index page](https://bonsai.sensu.io/assets/fgouteroux/sensu-plugins-jolokia-metrics).
+
+##### Asset definition
+
+```yaml
+---
+type: Asset
+api_version: core/v2
+metadata:
+  name: sensu-plugins-jolokia-metrics
+spec:
+  url: https://assets.bonsai.sensu.io/30d8361243af8c7806e2d6db4a6dc576dab02966/sensu-plugins-jolokia-metrics_0.0.2_centos_linux_amd64.tar.gz
+  sha512: eb39c9c92984975c9339dcaddefba9fa6d1bc52b6ae73693ca4d4e6068a0b320e3d6eeb69afdd8c1210222953effd520ffc24687eba7d433c92c44f797c99c5c
+```
+
+##### Check definition
+
+```yaml
+---
+type: CheckConfig
+spec:
+  command: "jolokia-metrics.rb --url http://localhost:8778/jolokia/read --file /tmp/metrics.beans.yaml"
+  handlers: []
+  high_flap_threshold: 0
+  interval: 10
+  low_flap_threshold: 0
+  publish: true
+  runtime_assets:
+  - sensu-plugins-jolokia-metrics
+  - sensu-ruby-runtime
+  subscriptions:
+  - linux
+  output_metric_format: graphite_plaintext
+  output_metric_handlers:
+  - graphite
+```
+#### Sensu Core
+##### Check definition
+```json
+{
+  "checks": {
+    "check-jolokia-metrics": {
+    "command": "jolokia-metrics.rb --url http://localhost:8778/jolokia/read --file /tmp/metrics.beans.yaml",
+    "subscribers": [
+      "servers"
+    ],
+    "interval": 60
+    }
+  }
+}
+```
+
+### Functionality
+
+**jolokia-metrics.rb**
+
+Collect jolokia metrics defined in an yaml file with one single post request.
+
+
+**/tmp/metrics.beans.yaml**
+```yaml
+data:
+  - {"type": "read",  "mbean": "java.lang:type=Memory"}
+  - {"type": "read",  "mbean": "java.lang:type=Threading"}
+  - {"type": "read",  "mbean": "java.lang:type=GarbageCollector,name=*"}
+  - {"type": "read",  "mbean": "kafka.server:type=BrokerTopicMetrics,name=MessagesInPerSec"}
+  - {"type": "read",  "mbean": "kafka.server:type=BrokerTopicMetrics,name=BytesInPerSec"}
+  - {"type": "read",  "mbean": "kafka.server:type=BrokerTopicMetrics,name=BytesOutPerSec"}
+```
+
+It's possible to define custom patterns to escape metric characters.
+Is some case java mbean can be named like this: 'java.lang:type=Memory'
+
+
+To escape, add the key 'patterns' in config file:
+
+```yaml
+patterns:
+  - ['*', '_']    # default value
+  - ['.', '_']    # default value
+  - [',', '.']    # default value
+  - [' ', '_']    # default value
+  - ['(', '']     # default value
+  - [')', '']     # default value
+  - [':', '.']    # default value
+  - ['name=', '']
+  - ['type=', '']
+  - ['request=', '']
+```
+
+If this key 'patterns' is not defined default value are applied.
+
+
+## Installation
+
+### Sensu Go
+
+See the instructions above for [asset registration](#asset-registration)
+
+### Sensu Core
+Install and setup plugins on [Sensu Core](https://docs.sensu.io/sensu-core/latest/installation/installing-plugins/)

data/bin/jolokia-metrics.rb

@@ -0,0 +1,145 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#   jolokia-metrics.rb
+#
+# DESCRIPTION:
+#   Read metrics from jolokia HTTP endpoint.
+#
+# OUTPUT:
+#   Graphite formatted data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   EX: ./jolokia-metrics.rb -u http://127.0.0.1:8080/jolokia/read -f jmx_beans.yaml
+#
+# LICENSE:
+#   Arnaud Delalande  <arnaud.delalande@adevo.fr>
+#   Francois Gouteroux <francois.gouteroux@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'rest-client'
+require 'socket'
+require 'yaml'
+require 'json'
+#
+# Jolokia2Graphite - see description above
+#
+class Jolokia2Graphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :url,
+         description: 'Full URL to the endpoint',
+         short: '-u URL',
+         long: '--url URL',
+         default: 'http://localhost:8778/jolokia/read'
+
+  option :scheme,
+         description: 'Metric naming scheme',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: Socket.gethostname.to_s.gsub!('.', '_')
+
+  option :file,
+         description: 'File path with metrics definitions to retrieve',
+         short: '-f FILE',
+         long: '--file FILE'
+
+  option :insecure,
+         description: 'By default, every SSL connection made is verified to be secure. This option allows you to disable the verification',
+         short: '-k',
+         long: '--insecure',
+         boolean: true,
+         default: false
+
+  option :debug,
+         short: '-d',
+         long: '--debug',
+         default: false
+
+  def deep_value(metric, input, timestamp, patterns)
+    case input
+    when Hash
+      input.each do |key, value|
+        deep_value("#{metric}.#{escape_metric(key, patterns)}", value, timestamp, patterns)
+      end
+    when Numeric
+      output metric, input, timestamp
+    end
+  end
+
+  def escape_metric(name, patterns)
+    res = name.dup
+
+    if patterns.empty?
+      patterns = [
+        ['*', '_'],
+        ['.', '_'],
+        [',', '.'],
+        [' ', '_'],
+        ['(', ''],
+        [')', ''],
+        [':', '.'],
+        ['=', '.']
+      ]
+    end
+    patterns.each { |replace| res.gsub!(replace[0], replace[1]) }
+    res
+  end
+
+  def run
+    puts "args config: #{config}" if config[:debug]
+
+    begin
+      cnf = YAML.load_file(config[:file])
+      patterns = cnf['patterns'] || []
+    rescue StandardError => e
+      puts "Error: #{e.backtrace}"
+      critical "Error: #{e}"
+    end
+
+    begin
+      data = RestClient::Request.execute(
+        url: config[:url],
+        method: :post,
+        payload: cnf['data'].to_json,
+        headers: { content_type: 'application/json' },
+        verify_ssl: !config[:insecure]
+      )
+      puts "Http response: #{data}" if config[:debug]
+
+      ::JSON.parse(data).each do |resp|
+        if !resp['status'] || (resp['status'] != 200)
+          err = resp.to_yaml[0..300]
+          if config[:debug]
+            err = resp.to_yaml
+          end
+          warn "Error status: #{resp['status']} - Stacktrace: #{err}"
+          next
+        end
+        mbean = resp['request']['mbean']
+        attribute = resp['request']['attribute']
+        path      = resp['request']['path']
+        if mbean && !mbean.include?('*')
+          path_ =  [mbean, attribute, path].reject { |c| !c || c.is_a?(Array) }.map { |c| escape_metric(c, patterns) }.join('.')
+          metric = [config[:scheme].to_s, path_].select { |c| c }.compact.join('.')
+        else
+          metric = config[:scheme].to_s
+        end
+        deep_value(metric.to_s, resp['value'], resp['timestamp'], patterns)
+      end
+    rescue Errno::ECONNREFUSED
+      critical "#{config[:url]} is not responding"
+    rescue RestClient::RequestTimeout
+      critical "#{config[:url]} Connection timed out"
+    end
+    ok
+  end
+end

data/lib/sensu-plugins-jolokia-metrics.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sensu-plugins-jolokia-metrics/version'

data/lib/sensu-plugins-jolokia-metrics/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SensuPluginsJolokiaMetrics
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,282 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-jolokia-metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: kitchen-docker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: kitchen-localhost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: kitchen-vagrant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: |-
+  This plugin provides native HTTP instrumentation
+                                for jolokia metrics collection.
+email: <sensu-users@googlegroups.com>
+executables:
+- jolokia-metrics.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/jolokia-metrics.rb
+- lib/sensu-plugins-jolokia-metrics.rb
+- lib/sensu-plugins-jolokia-metrics/version.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/fgouteroux/sensu-plugins-jolokia-metrics
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for various http monitors and metrics
+test_files: []