riemann-cassandra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 435287e0892932e20729f671a9c3f03896b72f32
+  data.tar.gz: 83b7f39de5561cd91e912b5663582d444e2b9e3e
+SHA512:
+  metadata.gz: cdb29f96feb385eef3cd06f95388bcba97a7f29dd5a7644a42f1aa75b8eb3e2c76ef40fc7efdb45bc058f7bd2481eacb36ac430b5e6cf4a2b923eab0b43b5295
+  data.tar.gz: 8a8f1aad9ea40a30fcbd6eaa9dfbaeba6dbad25ba0b7dcc6145ba615a48a73c8507c8f51b48e00f465ce0fe7152ae49821f208d352a2b401cfe8321104e96437

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+ruby '2.2.2', :engine => 'jruby', :engine_version => '9.0.3.0'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Deyan Dobrinov
+
+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,32 @@
+# Riemann::Cassandra
+Gem for sending Cassandra metrics to Riemann. To use it you will need an JMX enabled Cassandra and JRuby.
+
+# Metrics
+* Throughput (writes|reads)
+* Latency (writes|reads)
+* Key cache hit rate
+* Timeout exceptions (writes|reads)
+* Unavailable exceptions (writes|reads)
+* (TODO) Load
+* (TODO) Total disk space used
+* (TODO) Completed compaction tasks
+* (TODO) Pending compaction tasks
+* (TODO) ParNew garbage collections (count|time)
+* (TODO) CMS garbage collections (count|time)
+* (TODO) Exceptions
+* (TODO) Pending tasks (per stage)
+* (TODO) Currently blocked tasks
+
+More:
+* https://www.datadoghq.com/blog/how-to-monitor-cassandra-performance-metrics/
+* https://www.datadoghq.com/blog/how-to-collect-cassandra-metrics/
+
+## Installation
+1. Install [JRuby](http://jruby.org/)
+2. Run `$ gem install riemann-cassandra`
+
+## Usage
+`riemann-cassandra --host my.riemann.server --cassandra_jmx_host my.cassandra.server --cassandra_jmx_port 7199`
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/riemann-cassandra

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require 'socket'
+require 'riemann/client'
+require 'riemann/cassandra'
+
+opts_parser = Trollop::Parser.new do
+  opt :host, "Riemann host", default: '127.0.0.1'
+  opt :port, "Riemann port", default: 5555
+  opt :event_host, "Event hostname", type: String, default: Socket.gethostname
+  opt :interval, "Seconds between updates", type: :int, default: 5
+  opt :tag, "Tag to add to events", type: String, multi: true
+  opt :ttl, "TTL for events", type: Integer, default: 10
+  opt :attribute, "Attribute to add to the event", type: String, multi: true
+  opt :timeout, "Timeout (in seconds) when waiting for acknowledgements", default: 30
+  opt :tcp, "Use TCP transport instead of UDP (improves reliability, slight overhead.", default: true
+
+  opt :cassandra_jmx_host, 'Cassandra JMX host', type: :string, default: "localhost"
+  opt :cassandra_jmx_port, 'Cassandra JMX port', type: :int, default: 7199
+end
+
+opts = Trollop::with_standard_exception_handling opts_parser do
+  opts_parser.parse ARGV
+end
+
+# Initialise Riemann client
+riemann = Riemann::Client.new(host: opts[:host], port: opts[:port], timeout: opts[:timeout])
+
+if opts[:tcp]
+  riemann = riemann.tcp
+else
+  riemann = riemann.udp
+end
+
+# Initialise Cassandra JMX client
+cassandra = Riemann::Cassandra::Client.new opts[:cassandra_jmx_host], opts[:cassandra_jmx_port]
+
+loop do
+  begin
+    # Send metric events
+    Riemann::Cassandra::METRIC_PARAMS.each do |mp|
+      metric_event = {
+        service:     "cassandra #{mp[:service]}",
+        host:        opts[:event_host],
+        metric:      cassandra.metric(mp[:type], mp[:scope], mp[:name], mp[:attribute]),
+        description: mp[:description],
+        time:        Time.now.utc.to_i,
+        tags:        opts[:tags],
+        ttl:         opts[:ttl]
+      }
+
+      riemann << metric_event
+      puts metric_event
+    end
+
+    # Send health event
+    # health_event = {
+    #   service:     'cassandra health',
+    #   host:        opts[:event_host],
+    #   state:       'ok',
+    #   description: 'Cassandra status connection ok',
+    #   time:        Time.now.utc.to_i,
+    #   tags:        opts[:tags],
+    #   ttl:         opts[:ttl]
+    # }
+
+    # riemann << health_event
+    # puts health_event
+    puts "\n"
+  rescue => e
+    $stderr.puts "#{e.class} #{e}\n#{e.backtrace.join "\n"}"
+  end
+
+  sleep(opts[:interval])
+end

data/lib/riemann/cassandra.rb

@@ -0,0 +1,8 @@
+require 'riemann/cassandra/version'
+require 'riemann/cassandra/client'
+require 'riemann/cassandra/metric_params'
+
+module Riemann
+  module Cassandra
+  end
+end

data/lib/riemann/cassandra/client.rb

@@ -0,0 +1,23 @@
+require 'java'
+
+import javax.management.ObjectName
+import javax.management.remote.JMXConnectorFactory
+import javax.management.remote.JMXServiceURL
+
+module Riemann
+  module Cassandra
+    class Client
+      attr_reader :mbean_server_connection
+
+      def initialize(hostname, port)
+        @service_url = JMXServiceURL.new("service:jmx:rmi:///jndi/rmi://#{hostname}:#{port}/jmxrmi")
+        @mbean_server_connection = JMXConnectorFactory.connect(@service_url, nil).getMBeanServerConnection
+      end
+
+      def metric(type, scope, name, attribute)
+        jmx_path = "org.apache.cassandra.metrics:type=#{type},scope=#{scope},name=#{name}"
+        mbean_server_connection.get_attribute(ObjectName.new(jmx_path), attribute)
+      end
+    end
+  end
+end

data/lib/riemann/cassandra/metric_params.rb

@@ -0,0 +1,19 @@
+module Riemann
+  module Cassandra
+    # https://www.datadoghq.com/blog/how-to-collect-cassandra-metrics/
+    METRIC_PARAMS = [
+      { service: 'read_throughput',              type: 'ClientRequest', scope: 'Read',     name: 'Latency',      attribute: 'OneMinuteRate', description: '' },
+      { service: 'write_throughput',             type: 'ClientRequest', scope: 'Write',    name: 'Latency',      attribute: 'OneMinuteRate', description: '' },
+      { service: 'total_read_latency',           type: 'ClientRequest', scope: 'Read',     name: 'TotalLatency', attribute: 'Count',         description: '' },
+      { service: 'total_write_latency',          type: 'ClientRequest', scope: 'Write',    name: 'TotalLatency', attribute: 'Count',         description: '' },
+      { service: 'read_latency',                 type: 'ClientRequest', scope: 'Read',     name: 'Latency',      attribute: 'Count',         description: '' },
+      { service: 'write_latency',                type: 'ClientRequest', scope: 'Write',    name: 'Latency',      attribute: 'Count',         description: '' },
+      { service: 'key_cache_hits',               type: 'Cache',         scope: 'KeyCache', name: 'Hits',         attribute: 'Count',         description: '' },
+      { service: 'key_cache_requests',           type: 'Cache',         scope: 'KeyCache', name: 'Requests',     attribute: 'Count',         description: '' },
+      { service: 'read_timeout_exceptions',      type: 'ClientRequest', scope: 'Read',     name: 'Timeouts',     attribute: 'Count',         description: '' },
+      { service: 'write_timeout_exceptions',     type: 'ClientRequest', scope: 'Write',    name: 'Timeouts',     attribute: 'Count',         description: '' },
+      { service: 'read_unavailable_exceptions',  type: 'ClientRequest', scope: 'Read',     name: 'Unavailables', attribute: 'Count',         description: '' },
+      { service: 'write_unavailable_exceptions', type: 'ClientRequest', scope: 'Write',    name: 'Unavailables', attribute: 'Count',         description: '' }
+    ]
+  end
+end

data/lib/riemann/cassandra/version.rb

@@ -0,0 +1,5 @@
+module Riemann
+  module Cassandra
+    VERSION = "0.1.0"
+  end
+end

data/riemann-cassandra.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'riemann/cassandra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "riemann-cassandra"
+  spec.version       = Riemann::Cassandra::VERSION
+  spec.authors       = ["Deyan Dobrinov"]
+  spec.email         = ["deyan.dobrinov@gmail.com"]
+
+  spec.summary       = %q{Gem for sending Cassandra metrics to Riemann.}
+  spec.description   = %q{Gem for sending Cassandra metrics to Riemann.}
+  spec.homepage      = "https://github.com/dobrinov/riemann-cassandra"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["riemann-cassandra"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'riemann-client', '~> 0.2.6'
+  spec.add_runtime_dependency 'trollop', '~> 2.1.2'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: riemann-cassandra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deyan Dobrinov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  name: riemann-client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  name: trollop
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+description: Gem for sending Cassandra metrics to Riemann.
+email:
+- deyan.dobrinov@gmail.com
+executables:
+- riemann-cassandra
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/riemann-cassandra
+- lib/riemann/cassandra.rb
+- lib/riemann/cassandra/client.rb
+- lib/riemann/cassandra/metric_params.rb
+- lib/riemann/cassandra/version.rb
+- riemann-cassandra.gemspec
+homepage: https://github.com/dobrinov/riemann-cassandra
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Gem for sending Cassandra metrics to Riemann.
+test_files: []