kb-simple-metrics 0.0.12-java

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/
+.rbenv-version
+.rbenv-gemsets
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple-metrics.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012 Simple Finance Technology Corp.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,144 @@
+# Simple::Metrics
+
+A simple JRuby wrapper around Coda's excellent <a href="http://metrics.codahale.com/">Metrics package</a>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple-metrics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-metrics
+
+## Healthchecks
+
+Monitor the health of your application in a granular way.
+
+In a Sinatra/Padrino app, register healthchecks as an extension like so:
+
+    register Simple::Metrics::Healthchecks
+
+To register a new healthcheck:
+
+    class NurseRatched
+      extend Simple::Metrics::Healthchecks
+
+      attr_accessor :temp
+
+      new_healthcheck("temperature") do
+        if @temp = 98
+          Simple::Metrics::HEALTHY
+        elsif @temp > 101
+          Simple::Metrics::UNHEALTHY.new("Fever!")
+        else
+          Simple::Metrics::WARNING
+        end
+      end
+    end
+
+Run all healthchecks:
+
+    NurseRatched.run_all_healthchecks
+
+Your healthchecks will be run in a separate thread every 5 seconds. This is a great way to monitor the health of your db connections, thread pools and connections to queues.
+
+If you are running the servlet in a warbler .war file (see example below), you can monitor the overall health of your application with nagios or other monitoring tools.
+
+## Timers
+
+From: <a href="http://metrics.codahale.com/getting-started/#timers">Timers</a>:
+
+A timer measures both the rate that a particular piece of code is called and the distribution of its duration.
+
+    class Samovar
+      include Simple::Metrics
+
+      def buh
+        timer("tea time") do
+          "Brewing..."
+        end
+      end
+    end
+
+## Meters
+
+From: <a href="http://metrics.codahale.com/getting-started/#meters">Meters</a>:
+
+"A meter measures the rate of events over time (e.g., “requests per second”). In addition to the mean rate, meters also track 1-, 5-, and 15-minute moving averages."
+
+    class Rdio
+      extend Simple::Metrics::Meter
+
+      define_meter :bump_meter
+
+      def bump_dat
+        bump_meter.mark
+      end
+    end
+
+## Send metrics directly to graphite
+   
+In a Sinatra app:
+
+    register Simple::Metrics::Graphite
+
+    enable_graphite_reporter("graphite.example.com", 2003, "services.#{RACK_ENV}")
+
+## Exposing metrics from within your app
+
+In order to view/collect the health and metrics of your application from the web, you'll need to add the servlet endpoints.
+For this example, I'm using <a href="https://github.com/jruby/warbler">Warbler</a> to package
+the application as a .war
+
+In config/web.xml, add the following servlet mappings:
+
+      <servlet>
+        <servlet-name>metrics.MetricsServlet</servlet-name>
+        <servlet-class>com.yammer.metrics.reporting.MetricsServlet</servlet-class>
+      </servlet>
+      <servlet-mapping>
+        <servlet-name>metrics.MetricsServlet</servlet-name>
+        <url-pattern>/metrics</url-pattern>
+      </servlet-mapping>
+
+      <servlet>
+        <servlet-name>metrics.HealthCheckServlet</servlet-name>
+        <servlet-class>com.yammer.metrics.reporting.HealthCheckServlet</servlet-class>
+      </servlet>
+      <servlet-mapping>
+        <servlet-name>metrics.HealthCheckServlet</servlet-name>
+        <url-pattern>/healthcheck</url-pattern>
+      </servlet-mapping>
+
+      <servlet>
+        <servlet-name>metrics.ThreadDumpServlet</servlet-name>
+        <servlet-class>com.yammer.metrics.reporting.ThreadDumpServlet</servlet-class>
+        <url-pattern>/threads</url-pattern>
+      </servlet>
+
+      <servlet>
+        <servlet-name>metrics.PingServlet</servlet-name>
+        <servlet-class>com.yammer.metrics.reporting.PingServlet</servlet-class>
+      </servlet>
+      <servlet-mapping>
+        <servlet-name>metrics.PingServlet</servlet-name>
+        <url-pattern>/ping</url-pattern>
+      </servlet-mapping>
+
+Now you can visit your application and get a thread dump, health check or collect metrics using collectd:
+
+    > curl localhost:9292/threads
+      main id=1 state=WAITING
+      - waiting on <0x073772c5> (a java.lang.Object)
+      - locked <0x073772c5> (a java.lang.Object)
+      at java.lang.Object.wait(Native Method)
+
+## API documentation
+
+<a href="http://simplefinance.github.io/simple-metrics/">API Docs</a>

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "yard"
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'README.md']
+end

data/doc/NurseRatched.html

@@ -0,0 +1,246 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: NurseRatched
+  
+    &mdash; Documentation by YARD 0.8.3
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (N)</a> &raquo;
+    
+    
+    <span class="title">NurseRatched</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: NurseRatched
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">NurseRatched</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+      <dt class="r2">Extended by:</dt>
+      <dd class="r2"><span class='object_link'><a href="Simple/Metrics/Healthchecks.html" title="Simple::Metrics::Healthchecks (module)">Simple::Metrics::Healthchecks</a></span></dd>
+      
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">README.md</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+  <h2>Constant Summary</h2>
+  
+  <h3 class="inherited">Constants included
+     from <span class='object_link'><a href="Simple/Metrics.html" title="Simple::Metrics (module)">Simple::Metrics</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics.html#DEFAULT_DURATION_UNIT-constant" title="Simple::Metrics::DEFAULT_DURATION_UNIT (constant)">Simple::Metrics::DEFAULT_DURATION_UNIT</a></span>, <span class='object_link'><a href="Simple/Metrics.html#DEFAULT_RATE_UNIT-constant" title="Simple::Metrics::DEFAULT_RATE_UNIT (constant)">Simple::Metrics::DEFAULT_RATE_UNIT</a></span>, <span class='object_link'><a href="Simple/Metrics.html#DEFAULT_TIMING_UNIT-constant" title="Simple::Metrics::DEFAULT_TIMING_UNIT (constant)">Simple::Metrics::DEFAULT_TIMING_UNIT</a></span>, <span class='object_link'><a href="Simple/Metrics.html#VERSION-constant" title="Simple::Metrics::VERSION (constant)">Simple::Metrics::VERSION</a></span></p>
+
+
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#temp-instance_method" title="#temp (instance method)">- (Object) <strong>temp</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute temp.
+</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+
+  
+  
+  
+  
+  
+  
+  <h2>Method Summary</h2>
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Simple/Metrics/Healthchecks.html" title="Simple::Metrics::Healthchecks (module)">Simple::Metrics::Healthchecks</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics/Healthchecks.html#new_healthcheck-instance_method" title="Simple::Metrics::Healthchecks#new_healthcheck (method)">new_healthcheck</a></span>, <span class='object_link'><a href="Simple/Metrics/Healthchecks.html#run_all_healthchecks-instance_method" title="Simple::Metrics::Healthchecks#run_all_healthchecks (method)">run_all_healthchecks</a></span>, <span class='object_link'><a href="Simple/Metrics/Healthchecks.html#run_healthcheck_loop-instance_method" title="Simple::Metrics::Healthchecks#run_healthcheck_loop (method)">run_healthcheck_loop</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Simple/Metrics.html" title="Simple::Metrics (module)">Simple::Metrics</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics.html#metrics_registry-instance_method" title="Simple::Metrics#metrics_registry (method)">#metrics_registry</a></span>, <span class='object_link'><a href="Simple/Metrics.html#new_metric_name-instance_method" title="Simple::Metrics#new_metric_name (method)">#new_metric_name</a></span>, <span class='object_link'><a href="Simple/Metrics.html#sanitize_classname-instance_method" title="Simple::Metrics#sanitize_classname (method)">#sanitize_classname</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Simple/Metrics/Timer.html" title="Simple::Metrics::Timer (module)">Simple::Metrics::Timer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics/Timer.html#timer-instance_method" title="Simple::Metrics::Timer#timer (method)">#timer</a></span></p>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="temp=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="temp-instance_method">
+  
+    - (<tt>Object</tt>) <strong>temp</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>
+Returns the value of attribute temp
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'README.md', line 26</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_temp identifier id'>temp</span>
+  <span class='rubyid_@temp ivar id'>@temp</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+</div>
+
+    <div id="footer">
+  Generated on Mon Nov 05 22:03:45 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.3 (ruby-1.9.2).
+</div>
+
+  </body>
+</html>

data/doc/Rdio.html

@@ -0,0 +1,233 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Rdio
+  
+    &mdash; Documentation by YARD 0.8.3
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (R)</a> &raquo;
+    
+    
+    <span class="title">Rdio</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Rdio
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Rdio</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+      <dt class="r2">Extended by:</dt>
+      <dd class="r2"><span class='object_link'><a href="Simple/Metrics/Meter.html" title="Simple::Metrics::Meter (module)">Simple::Metrics::Meter</a></span></dd>
+      
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">README.md</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+  <h2>Constant Summary</h2>
+  
+  <h3 class="inherited">Constants included
+     from <span class='object_link'><a href="Simple/Metrics.html" title="Simple::Metrics (module)">Simple::Metrics</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics.html#DEFAULT_DURATION_UNIT-constant" title="Simple::Metrics::DEFAULT_DURATION_UNIT (constant)">Simple::Metrics::DEFAULT_DURATION_UNIT</a></span>, <span class='object_link'><a href="Simple/Metrics.html#DEFAULT_RATE_UNIT-constant" title="Simple::Metrics::DEFAULT_RATE_UNIT (constant)">Simple::Metrics::DEFAULT_RATE_UNIT</a></span>, <span class='object_link'><a href="Simple/Metrics.html#DEFAULT_TIMING_UNIT-constant" title="Simple::Metrics::DEFAULT_TIMING_UNIT (constant)">Simple::Metrics::DEFAULT_TIMING_UNIT</a></span>, <span class='object_link'><a href="Simple/Metrics.html#VERSION-constant" title="Simple::Metrics::VERSION (constant)">Simple::Metrics::VERSION</a></span></p>
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#bump_dat-instance_method" title="#bump_dat (instance method)">- (Object) <strong>bump_dat</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Simple/Metrics/Meter.html" title="Simple::Metrics::Meter (module)">Simple::Metrics::Meter</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics/Meter.html#define_meter-instance_method" title="Simple::Metrics::Meter#define_meter (method)">define_meter</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Simple/Metrics.html" title="Simple::Metrics (module)">Simple::Metrics</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics.html#metrics_registry-instance_method" title="Simple::Metrics#metrics_registry (method)">#metrics_registry</a></span>, <span class='object_link'><a href="Simple/Metrics.html#new_metric_name-instance_method" title="Simple::Metrics#new_metric_name (method)">#new_metric_name</a></span>, <span class='object_link'><a href="Simple/Metrics.html#sanitize_classname-instance_method" title="Simple::Metrics#sanitize_classname (method)">#sanitize_classname</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Simple/Metrics/Timer.html" title="Simple::Metrics::Timer (module)">Simple::Metrics::Timer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Simple/Metrics/Timer.html#timer-instance_method" title="Simple::Metrics::Timer#timer (method)">#timer</a></span></p>
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="bump_dat-instance_method">
+  
+    - (<tt>Object</tt>) <strong>bump_dat</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+80
+81
+82</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'README.md', line 80</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_bump_dat identifier id'>bump_dat</span>
+  <span class='rubyid_bump_meter identifier id'>bump_meter</span><span class='dot token'>.</span><span class='rubyid_mark identifier id'>mark</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Mon May 13 23:22:16 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.3 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>