librato-metrics-taps 0.3.6

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,42 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    librato-metrics-taps (0.3.6)
+      jmx4r (= 0.1.4)
+      jruby-openssl (= 0.8.5)
+      librato-metrics (~> 1.0.4)
+      trollop (= 1.16.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aggregate (0.2.2)
+    bouncy-castle-java (1.5.0147)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    jmx4r (0.1.4)
+    jruby-openssl (0.8.5)
+      bouncy-castle-java (>= 1.5.0147)
+    json (1.7.3)
+    json (1.7.3-java)
+    librato-metrics (1.0.4)
+      aggregate (~> 0.2.2)
+      faraday (~> 0.7)
+      multi_json
+    multi_json (1.7.2)
+    multipart-post (1.2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    trollop (1.16.2)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  librato-metrics-taps!
+  rake
+  rdoc (~> 3.12)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mike Heffner
+
+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,145 @@
+# librato-metrics-taps
+
+Collection of helper scripts and library routines to tap into external
+metric sources and pump those metrics into Librato's Metric Service.
+
+## librato-metrics-tap-jmxbeans
+
+The *JMX Beans* tap script will connect to a JMX service and pull
+monitoring attributes from a configured set of MBeans. The values of
+these MBean attributes are pumped into Librato's Metric Service.
+
+The usage for librato-metrics-tap-jmxbeans is:
+
+```
+Usage: librato-metrics-tap-jmxbeans <options>
+
+Options:
+              --jmx-host, -j <s>:   JMX Hostname (default: localhost)
+              --jmx-port, -m <i>:   JMX Port (default: 8080)
+          --jmx-username, -x <s>:   JMX Username
+          --jmx-password, -w <s>:   JMX Password
+                 --email, -e <s>:   Metrics Email address
+                 --token, -t <s>:   Metrics API token
+                --source, -s <s>:   Optional source name
+                --prefix, -z <s>:   Optional prefix name
+          --measure-time, -a <i>:   Optional time for measurements
+           --metrics-url, -r <s>:   Metrics URL (default:
+                                    https://metrics-api.librato.com)
+              --interval, -i <i>:   Run as a daemon and poll every N seconds
+            --ignore-missing, -g:   Ignore missing beans/attributes
+        --data-file-full, -d <s>:   YAML file defining beans & attribute names
+  --data-file-attributes, -f <s>:   YAML file of bean attributes
+             --bean-name, -b <s>:   Bean name to match against or lookup
+                   --publish, -p:   Publish Bean Attributes to Librato Metrics
+               --match-beans, -c:   Output beans that match --bean-name regexp
+                   --version, -v:   Print version and exit
+                      --help, -h:   Show this message
+```
+
+You can either specify a full bean and attribute definition file or
+you can specify the bean name(s) separately on the commandline and
+specify the bean attributes from the config file.
+
+### Full Bean and Attribute Definition
+
+Use the `--data-file-full` option to specify the path to a YAML file
+defining the full list of beans and attributes to retreive. An example
+of such a configuration file is:
+
+```
+--- 
+org.apache.cassandra.internal:type=AntiEntropyStage:
+org.apache.cassandra.internal:type=FlushSorter:
+  ActiveCount:
+  CompletedTasks: counter
+  PendingTasks:
+```
+
+For example, this will grab all the attributes of the bean name
+`org.apache.cassandra.internal:type=AntiEntropyStage` and will push
+each of those attributes as metrics.
+
+If the file contains a list of attributes for a bean, it will restrict
+the attributs to the ones listed. For example, for the bean
+`org.apache.cassandra.internal:type=FlushSorter`, it will limit the
+bean attributes to *ActiveCount*, *CompletedTasks* and *PendingTasks*.
+
+By default, attributes are published as **gauges** to the Librato
+Metrics service. If instead you would like to publish the attribute as
+a counter, set the attribute name to the value 'counter'.
+
+An example full bean definition file is included for Cassandra under
+the `examples/cassandra` directory in the top-level of this gem. For
+example, to publish the thread JMX beans from Cassandra 0.8.1:
+
+```
+librato-metrics-tap-jmxbeans --email "$EMAIL" --token "$TOKEN" \
+    --publish \
+    --source "$SOURCE_NAME" \
+    --jmx-host "$JMX_HOST" --jmx-port "$JMX_PORT" \
+    --data-file-full examples/cassandra/tpstats-0_8_1.yaml \
+    --measure-time "$MEASURE_TIME"
+```
+
+### Bean attributes separate from beans
+
+Oftentimes it is useful to publish the same attributes from multiple
+beans that all export the same attribute names. In this case you can
+use the `--data-file-attributes` option to set a YAML file defining
+the bean attributes to publish. You can then set the bean names using
+the `--bean-name` option.
+
+For example, a bean attribute definition file may look like:
+
+```
+---
+LiveDiskSpaceUsed:
+LiveSSTableCount:
+MemtableColumnsCount: counter
+```
+
+If this file were used in combination with the option `--bean-name
+org.apache.cassandra.db:type=ColumnFamilies,keyspace=MyKeyspace,columnfamily=mycf`,
+then the attributes `LiveDiskSpaceUsed`, `LiveSSTableCount` and
+`MemtableColumnsCount` for the bean representing the Cassandra
+columnfamily *mycf* in the keyspace *MyKeyspace* would be published.
+
+The `--bean-name` can also be a wildcard that will be expanded to all
+matching beans. For example, the option `--bean-name
+'org.apache.cassandra.db:type=ColumnFamilies,keyspace=MyKeyspace,columnfamily=*'`
+would publish the same attributes for all column families in the
+keyspace *MyKeyspace*.
+
+Attributes are always published as *gauges* to the Librato Metrics
+service. To publish them as a counter, set their value to 'counter'.
+
+An example bean attribute definition file is included for Cassandra
+under the `examples/cassandra` directory in the top-level of this
+gem. For example, to publish the CF stats for all column families in
+the keyspace *MyKeyspace*:
+
+```
+librato-metrics-tap-jmxbeans --email "$EMAIL" --token "$TOKEN" \
+    --publish --source "$SOURCE_NAME" \
+    --jmx-host "$JMX_HOST" --jmx-port "$JMX_PORT" \
+    --bean-name 'org.apache.cassandra.db:type=ColumnFamilies,keyspace=MyKeyspace,columnfamily=*' \
+    --data-file-attributes examples/cassandra/cfstats-0_8_1.yaml \
+    --measure-time "$MEASURE_TIME"
+```
+
+## Contributing to librato-metrics-taps
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Librato, Inc. See LICENSE.txt for
+further details.
+

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+0.3.6

data/bin/librato-metrics-tap-jmxbeans

@@ -0,0 +1,209 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+require File.join(File.dirname(__FILE__), '../lib/librato/metrics/taps')
+include Librato::Metrics
+
+def err(msg)
+  $stderr.puts msg
+  exit 1
+end
+
+def get_beans(bean_name)
+  beans = Taps::JMX::match_beans(bean_name)
+  unless beans && beans.length > 0
+    err "No beans match: #{bean_name}"
+  end
+  beans
+end
+
+def match_beans(opts)
+  ret = Taps::JMX::connect!(opts[:jmx_host], opts[:jmx_port])
+  unless ret
+    err "Failed to connect to JMX endpoint"
+  end
+
+  unless opts[:bean_name]
+    err "Must specify --bean-name when matching bean names"
+  end
+
+  beans = get_beans(opts[:bean_name])
+  puts beans.join("\n")
+end
+
+def publish_beans(publisher, beans, opts)
+  (counters, gauges) = Taps::JMX::retrieve(beans, opts[:ignore_missing])
+
+  r = publisher.post(counters, gauges, opts)
+  unless r
+    $stderr.puts "ERROR: Failed to publish metrics!"
+  end
+  return r
+end
+
+opts = Trollop::options do
+  version "Version: #{Taps::version}"
+  banner <<EOS
+Librato Metrics Tap for JMX Beans
+Version: #{Taps::version}
+
+Usage: librato-metrics-tap-jmxbeans <options>
+
+Options:
+EOS
+  # JMX End point
+  opt :jmx_host, "JMX Hostname", :short => "-j", :default => "localhost"
+  opt :jmx_port, "JMX Port", :short => "-m", :default => 8080
+  opt :jmx_username, "JMX Username", :short => "-x", :type => :string
+  opt :jmx_password, "JMX Password", :short => "-w", :type => :string
+
+  opt :email, "Metrics Email address", :short => "-e", :type => :string
+  opt :token, "Metrics API token", :short => "-t", :type => :string
+  opt :source, "Optional source name", :short => "-s", :type => :string
+  opt :prefix, "Optional prefix name", :short => "-z", :type => :string
+
+  opt :measure_time, "Optional time for measurements", :short => "-a", :type => :int
+  opt :metrics_url, "Metrics URL", :short => "-r", :default => 'https://metrics-api.librato.com'
+
+  opt :interval, "Run as a daemon and poll every N seconds", :short => "-i", :type => :int
+
+  opt :ignore_missing, "Ignore missing beans/attributes", :short => "-g"
+
+  # Bean collection options
+  opt :data_file_full, "YAML file defining beans & attribute names", :short => "-d", :type => :string
+  opt :data_file_attributes, "YAML file of bean attributes", :short => "-f", :type => :string
+  opt :bean_name, "Bean name to match against or lookup", :short => "-b", :type => :string
+
+  # Commands
+  opt :publish, "Publish Bean Attributes to Librato Metrics", :short => "-p"
+  opt :match_beans, "Output beans that match --bean-name regexp", :short => "-c"
+
+end
+
+if opts[:publish] && opts[:match_beans]
+  err "Only specify one command"
+end
+
+unless opts[:publish] || opts[:match_beans]
+  err "Must specify a command"
+end
+
+if opts[:publish]
+  unless opts[:email]
+    err "Must provide email to publish"
+  end
+
+  unless opts[:token]
+    err "Must provide token to publish"
+  end
+end
+
+if opts[:match_beans]
+  match_beans(opts)
+  exit 0
+end
+
+#
+# Publishing. Read beans + attributes then push to Metrics
+#
+
+publisher = Taps::Publisher.new(opts)
+
+ret = Taps::JMX::connect!(opts[:jmx_host], opts[:jmx_port], opts[:jmx_username], opts[:jmx_password])
+unless ret
+  err "Failed to connect to JMX endpoint"
+end
+
+# Load full definition
+#
+if opts[:data_file_full]
+  filename = opts[:data_file_full]
+  begin
+    beanf = File.open(filename, "r")
+  rescue => err
+    puts "Failed to open bean file #{filename}: #{err.message}"
+    exit 1
+  end
+
+  begin
+    beans = YAML::load(beanf)
+  rescue => err
+    puts "Failed to parse #{filename}: #{err.message}"
+    exit 1
+  end
+  beanf.close
+elsif opts[:bean_name] && opts[:data_file_attributes]
+  # Load attributes from file
+  #
+  filename = opts[:data_file_attributes]
+  begin
+    beanf = File.open(filename, "r")
+  rescue => err
+    puts "Failed to open attributes file #{filename}: #{err.message}"
+    exit 1
+  end
+
+  begin
+    attrs = YAML::load(beanf)
+  rescue => err
+    puts "Failed to parse #{filename}: #{err.message}"
+    exit 1
+  end
+  beanf.close
+
+  beans = {}
+  beannames = get_beans(opts[:bean_name])
+  beannames.each do |name|
+    beans[name] = attrs
+  end
+else
+  err "Must specify --data-file-full or --data-file-attributes"
+end
+
+unless opts[:interval]
+  r = publish_beans(publisher, beans, opts)
+  exit(r ? 0 : 1)
+end
+
+# If --interval has been specified, broadcast every interval
+# seconds. We wait for interval seconds each time to ensure we
+# broadcast on the interval
+#
+# We use a random stagger to ensure that we are measuring and
+# publishing our metrics at a random point within the period. This
+# ensures that multiple entities are not measuring and reporting
+# at the same exact points in time.
+
+interval = opts[:interval]
+stagger = rand(interval)
+begin
+  t = Time.now.tv_sec
+
+  # Floor the time to the current interval
+  t2 = (t / interval) * interval
+
+  # Offset by the stagger
+  t2 += stagger
+
+  # If our stagger is < interval/2, it is possible that we
+  # went back in time. In that case, simply skip another interval
+  #
+  if t2 <= t
+    t2 += interval
+  end
+
+  sleep (t2 - t)
+  t = Time.now
+
+  # We report our measure time as the nearest interval
+  tsecs = ((t.tv_sec + (interval / 2)) / interval) * interval
+
+  publish_beans(publisher, beans, opts.merge(:measure_time => tsecs))
+end while true
+
+exit 1
+
+# Local Variables:
+# mode: ruby
+# End: