Custom percentile reporting

README.md

@@ -377,6 +377,19 @@ will display:
 
 [metriks-sematext](https://github.com/sematext/metriks-sematext) gem provides reporter for sending metrics to [SPM](http://sematext.com/spm/index.html).
 
+## Custom percentile reporting
+
+The Graphite, LibratoMetrics, Logger, and Riemann reporters all support
+reporting customized percentiles for histograms, timers, and utilization timers.
+By default, these reporters will report the p95 for these metric types.  The
+example below shows how to enable a custom set of percentile metrics
+
+``` ruby
+  Metriks::Reporter::Graphite.new('localhost', 3004, :percentiles => [:p95, :p99])
+```
+
+These percentiles are supported: `:p75, :p95, :p98, :p99, :p999`.
+
 # Application Server Configuration
 
 Depending on how your application server operates, you may need to configure how reporters are created. Please look at [Troubleshooting](https://github.com/eric/metriks/wiki/Troubleshooting) for more information.

lib/metriks/counter.rb

@@ -40,5 +40,23 @@ def decrement(decr = 1)
     def count
       @count.value
     end
+
+    # Public: An array of methods to be used for reporting metrics through a
+    # reporter.
+    #
+    # Returns an array of symbols of methods that can be called.
+    def self.reportable_metrics
+      [:count]
+    end
+
+    # Public: An array of methods to be used for reporting snapshot metrics
+    # through a reporter.
+    #
+    # options - No supported options.
+    #
+    # Returns an array of symbols of methods that can be called.
+    def self.reportable_snapshot_metrics(options = {})
+      []
+    end
   end
 end

lib/metriks/gauge.rb

@@ -23,5 +23,23 @@ def set(val)
     def value
       @callback ? @callback.call : @gauge.value
     end
+
+    # Public: An array of methods to be used for reporting metrics through a
+    # reporter.
+    #
+    # Returns an array of symbols.
+    def self.reportable_metrics
+      [:value]
+    end
+
+    # Public: An array of methods to be used for reporting snapshot metrics
+    # through a reporter.
+    #
+    # options - No supported options.
+    #
+    # Returns an array of symbols.
+    def self.reportable_snapshot_metrics(options = {})
+      []
+    end
   end
 end

lib/metriks/histogram.rb

@@ -108,5 +108,24 @@ def update_variance(value)
         new_values
       end
     end
+
+    # Public: An array of methods to be used for reporting metrics through a
+    # reporter.
+    #
+    # Returns an array of symbols of methods that can be called.
+    def self.reportable_metrics
+      [:count, :min, :max, :mean, :stddev]
+    end
+
+    # Public: An array of methods to be used for reporting snapshot metrics
+    # through a reporter.
+    #
+    # options[:percentiles] - An array of percentiles methods to include. These
+    # must be valid methods on Metriks::Snapshot.
+    #
+    # Returns an array of symbols of methods that can be called.
+    def self.reportable_snapshot_metrics(options = {})
+      [:median] + options.fetch(:percentiles, [])
+    end
   end
 end

lib/metriks/meter.rb

@@ -81,5 +81,26 @@ def mean_rate
 
     def stop
     end
+
+    # Public: An array of methods to be used for reporting metrics through a
+    # reporter.
+    #
+    # Returns an array of symbols of methods that can be called.
+    def self.reportable_metrics
+      [
+        :count, :one_minute_rate, :five_minute_rate, :fifteen_minute_rate,
+        :mean_rate
+      ]
+    end
+
+    # Public: An array of methods to be used for reporting snapshot metrics
+    # through a reporter.
+    #
+    # options - No supported options.
+    #
+    # Returns an array of symbols of methods that can be called.
+    def self.reportable_snapshot_metrics(options = {})
+      []
+    end
   end
 end

lib/metriks/reporter/graphite.rb

@@ -2,17 +2,19 @@
 
 module Metriks::Reporter
   class Graphite
-    attr_reader :host, :port
+    attr_reader :host, :port, :percentile_methods
 
     def initialize(host, port, options = {})
       @host = host
       @port = port
 
       @prefix = options[:prefix]
 
-      @registry  = options[:registry] || Metriks::Registry.default
-      @interval  = options[:interval] || 60
-      @on_error  = options[:on_error] || proc { |ex| }
+      @registry = options[:registry] || Metriks::Registry.default
+      @interval = options[:interval] || 60
+      @on_error = options[:on_error] || proc { |ex| }
+
+      @percentile_methods = Metriks::Snapshot.methods_for_percentiles(options[:percentiles] || :p95)
     end
 
     def socket
@@ -48,45 +50,8 @@ def restart
 
     def write
       @registry.each do |name, metric|
-        case metric
-        when Metriks::Meter
-          write_metric name, metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate
-          ]
-        when Metriks::Counter
-          write_metric name, metric, [
-            :count
-          ]
-        when Metriks::Gauge
-          write_metric name, metric, [
-            :value
-          ]
-        when Metriks::UtilizationTimer
-          write_metric name, metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate,
-            :min, :max, :mean, :stddev,
-            :one_minute_utilization, :five_minute_utilization,
-            :fifteen_minute_utilization, :mean_utilization,
-          ], [
-            :median, :get_95th_percentile
-          ]
-        when Metriks::Timer
-          write_metric name, metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate,
-            :min, :max, :mean, :stddev
-          ], [
-            :median, :get_95th_percentile
-          ]
-        when Metriks::Histogram
-          write_metric name, metric, [
-            :count, :min, :max, :mean, :stddev
-          ], [
-            :median, :get_95th_percentile
-          ]
-        end
+        write_metric name, metric, metric.class.reportable_metrics,
+          metric.class.reportable_snapshot_metrics(:percentiles => percentile_methods)
       end
     end
 

lib/metriks/reporter/librato_metrics.rb

@@ -3,14 +3,15 @@
 
 module Metriks::Reporter
   class LibratoMetrics
-    attr_accessor :prefix, :source
+    attr_accessor :prefix, :source, :percentile_methods
 
     def initialize(email, token, options = {})
       @email = email
       @token = token
 
       @prefix = options[:prefix]
       @source = options[:source]
+      @percentile_methods = Metriks::Snapshot.methods_for_percentiles(options[:percentiles] || :p95)
 
       @registry  = options[:registry] || Metriks::Registry.default
       @time_tracker = Metriks::TimeTracker.new(options[:interval] || 60)
@@ -46,45 +47,8 @@ def restart
     def write
       gauges = []
       @registry.each do |name, metric|
-        gauges << case metric
-        when Metriks::Meter
-          prepare_metric name, metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate
-          ]
-        when Metriks::Counter
-          prepare_metric name, metric, [
-            :count
-          ]
-        when Metriks::Gauge
-          prepare_metric name, metric, [
-            :value
-          ]
-        when Metriks::UtilizationTimer
-          prepare_metric name, metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate,
-            :min, :max, :mean, :stddev,
-            :one_minute_utilization, :five_minute_utilization,
-            :fifteen_minute_utilization, :mean_utilization,
-          ], [
-            :median, :get_95th_percentile
-          ]
-        when Metriks::Timer
-          prepare_metric name, metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate,
-            :min, :max, :mean, :stddev
-          ], [
-            :median, :get_95th_percentile
-          ]
-        when Metriks::Histogram
-          prepare_metric name, metric, [
-            :count, :min, :max, :mean, :stddev
-          ], [
-            :median, :get_95th_percentile
-          ]
-        end
+        gauges << prepare_metric(name, metric, metric.class.reportable_metrics,
+                                 metric.class.reportable_snapshot_metrics(:percentiles => percentile_methods))
       end
 
       gauges.flatten!

lib/metriks/reporter/logger.rb

@@ -3,7 +3,7 @@
 
 module Metriks::Reporter
   class Logger
-    attr_accessor :prefix, :log_level, :logger
+    attr_accessor :prefix, :log_level, :logger, :percentile_methods
 
     def initialize(options = {})
       @logger    = options[:logger]    || ::Logger.new(STDOUT)
@@ -13,6 +13,8 @@ def initialize(options = {})
       @registry     = options[:registry] || Metriks::Registry.default
       @time_tracker = Metriks::TimeTracker.new(options[:interval] || 60)
       @on_error     = options[:on_error] || proc { |ex| }
+
+      @percentile_methods = Metriks::Snapshot.methods_for_percentiles(options.fetch(:percentiles, :p95))
     end
 
     def start
@@ -51,42 +53,20 @@ def write
       @registry.each do |name, metric|
         case metric
         when Metriks::Meter
-          log_metric name, 'meter', metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate
-          ]
+          log_metric name, 'meter', metric, metric.class.reportable_metrics
         when Metriks::Counter
-          log_metric name, 'counter', metric, [
-            :count
-          ]
+          log_metric name, 'counter', metric, metric.class.reportable_metrics
         when Metriks::Gauge
-          log_metric name, 'gauge', metric, [
-            :value
-          ]
+          log_metric name, 'gauge', metric, metric.class.reportable_metrics
         when Metriks::UtilizationTimer
-          log_metric name, 'utilization_timer', metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate,
-            :min, :max, :mean, :stddev,
-            :one_minute_utilization, :five_minute_utilization,
-            :fifteen_minute_utilization, :mean_utilization,
-          ], [
-            :median, :get_95th_percentile
-          ]
+          log_metric name, 'utilization_timer', metric, metric.class.reportable_metrics,
+            metric.class.reportable_snapshot_metrics(:percentiles => percentile_methods)
         when Metriks::Timer
-          log_metric name, 'timer', metric, [
-            :count, :one_minute_rate, :five_minute_rate,
-            :fifteen_minute_rate, :mean_rate,
-            :min, :max, :mean, :stddev
-          ], [
-            :median, :get_95th_percentile
-          ]
+          log_metric name, 'timer', metric, metric.class.reportable_metrics,
+            metric.class.reportable_snapshot_metrics(:percentiles => percentile_methods)
         when Metriks::Histogram
-          log_metric name, 'histogram', metric, [
-            :count, :min, :max, :mean, :stddev
-          ], [
-            :median, :get_95th_percentile
-          ]
+          log_metric name, 'histogram', metric, metric.class.reportable_metrics,
+            metric.class.reportable_snapshot_metrics(:percentiles => percentile_methods)
         end
       end
     end