meter 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fd53f330e039e19bf426396f41ef53246f47aff
-  data.tar.gz: 077c2be0e237a1f06af9aafd846d536027c6eaf8
+  metadata.gz: c7251d39b8598a821768f8b5194d091a4cf567da
+  data.tar.gz: 2a901ecbdbbdd2ba0f1e663b09b526dd2d485e8c
 SHA512:
-  metadata.gz: 8d31866e279376f65636be45c9cfbc5056907e559bd5eaaa3cc7106d11e37a8e44b630881286456d7edd04dced7aa4e13fa1642cf5131f012f27761050e21712
-  data.tar.gz: 01fdf3b7af762fece7e79eacf40bdc66914daaa4363d0936f7eea85259e0c6bc0ca2f146479719bb18a32fecd89e7fede96afb745a7ebf13c33bbf5a8bcf55ae
+  metadata.gz: 6f681d9e84b87ed9ae215a54149a4a7ffe8e376b9452f67641cb8c46ddbcde141761e886dde90821fd3bbd7fd23c51caded9b12455dec197230e5c6f74a5ed55
+  data.tar.gz: 193dddf526ebbe275b2278bc1f69f8af1b4805e05845b11b2c21d519713f29f0e14d792fa9355f3fd32025221ff97e62ac01f4d740f35eaac401b660d938ccc8

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 Bukowskis
+
+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,36 @@
+# Meter
+
+A generic abstraction layer for tracking metrics and other data via configurable backends.
+
+# Installation
+
+```bash
+gem install meter
+````
+
+# Usage
+
+#### Configuration
+
+```ruby
+Meter.configure do |config|
+  config.namespace = 'my_app'
+  config.backends << Meter::Backends::Datadog.new
+  config.backends << Meter::Backends::JsonLog.new
+end
+
+#### Syntax
+
+```ruby
+Meter.increment key, sample_rate: 0.5, tags: {}, data: {}
+````
+
+#### Examples
+
+```ruby
+Meter.increment 'my.key'
+Meter.increment 'my.key', 5
+Meter.increment 'my.key', 5, sample_rate: 0.25
+
+Meter.gauge 'my.gauge.key', 20
+```

data/lib/meter.rb

@@ -1,36 +1,58 @@
-require 'meter/backends'
+require 'meter/backends/base'
+require 'meter/backends/udp'
+require 'meter/backends/statsd'
+require 'meter/backends/datadog'
+require 'meter/backends/json_log'
 require 'meter/configure'
+require 'meter/mdc'
+require 'meter/metric/base'
+require 'meter/metric/counter'
+require 'meter/metric/gauge'
+require 'meter/metric/histogram'
+require 'meter/metric/timing'
+require 'meter/rails/middleware'
+require "meter/rails/railtie" if defined?(Rails::Railtie)
 
 module Meter
 
-  def self.increment(key, options = {})
-    id = options.delete(:id)
-    backends.datadog.increment key, options
-    backends.counter.increment("#{::Meter.config.namespace}.#{key}.#{id}", options) if id
-
-  rescue => exception
-    ::Meter.config.logger.error exception.inspect
-  end
-
-  def self.gauge(key, value, options = {})
-    backends.datadog.gauge key, value, options
-
-  rescue => exception
-    ::Meter.config.logger.error exception.inspect
+  class << self
+    def increment(key, value: 1, sample_rate: 1, tags: {}, data: {})
+      metric = Metric::Counter.new(name: key, value: value, sample_rate: sample_rate, tags: tags, data: data)
+      send_metric_to_backends(metric)
+    rescue => exception
+      ::Meter.config.logger.error exception.inspect
+    end
+    alias :track :increment
+
+    def gauge(key, value, sample_rate: 1, tags: {}, data: {})
+      metric = Metric::Gauge.new(name: key, value: value, sample_rate: sample_rate, tags: tags, data: data)
+      send_metric_to_backends(metric)
+    rescue => exception
+      ::Meter.config.logger.error exception.inspect
+    end
+
+    def histogram(key, value, sample_rate: 1, tags: {}, data: {})
+      metric = Metric::Histogram.new(name: key, value: value, sample_rate: sample_rate, tags: tags, data: data)
+      send_metric_to_backends(metric)
+    rescue => exception
+      ::Meter.config.logger.error exception.inspect
+    end
+
+    def timing(key, value, sample_rate: 1, tags: {}, data: {})
+      metric = Metric::Timing.new(name: key, value: value, sample_rate: sample_rate, tags: tags, data: data)
+      send_metric_to_backends(metric)
+    rescue => exception
+      ::Meter.config.logger.error exception.inspect
+    end
+
+    def send_metric_to_backends(metric)
+      return unless should_sample? metric.sample_rate
+      config.backends.each {|backend| backend.emit_metric(metric)}
+      metric
+    end
+
+    def should_sample?(sample_rate = 1)
+      rand < sample_rate
+    end
   end
-
-  def self.histogram(key, value, options = {})
-    backends.datadog.histogram key, value, options
-
-  rescue => exception
-    ::Meter.config.logger.error exception.inspect
-  end
-
-  def self.log(key, data)
-    backends.heka.log key, data
-
-  rescue => exception
-    ::Meter.config.logger.error exception.inspect
-  end
-
 end

data/lib/meter/backends/base.rb

@@ -0,0 +1,27 @@
+module Meter
+  module Backends
+    class Base
+
+      def self.supported_metrics
+        []
+      end
+
+      def supported_metric?(metric)
+        self.class.supported_metrics.include? metric.type
+      end
+
+      def emit_metric(metric)
+        return unless supported_metric? metric
+        metric_data = convert_to_backend_format(metric)
+        output_data(metric_data)
+      end
+
+      def convert_to_backend_format(metric)
+      end
+
+      def output_data(data)
+      end
+
+    end
+  end
+end

data/lib/meter/backends/datadog.rb

@@ -0,0 +1,28 @@
+require 'socket'
+
+module Meter
+  module Backends
+    class Datadog < ::Meter::Backends::Statsd
+
+      def self.supported_metrics
+        [:counter, :gauge, :timing, :histogram]
+      end
+
+      def convert_to_backend_format(metric)
+        rate = "|@#{metric.sample_rate}" unless metric.sample_rate == 1
+        tags = "|##{convert_tags_to_datadog_format(metric.tags)}" unless metric.tags.empty?
+        "#{metric.name}:#{metric.value}|#{statsd_type(metric)}#{rate}#{tags}"
+      end
+
+      def convert_tags_to_datadog_format(tags = {})
+        tags.map{|key,val| "#{key}:#{val}"}.join(',')
+      end
+
+      def statsd_type(metric)
+        types = {counter: ':c', gauge: ':g', timing: ':ms', histogram: ':h'}
+        types[metric.type]
+      end
+
+    end
+  end
+end

data/lib/meter/backends/json_log.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module Meter
+  module Backends
+    class JsonLog < ::Meter::Backends::Base
+
+      def self.supported_metrics
+        [:counter, :gauge, :timing, :histogram]
+      end
+
+      def convert_to_backend_format(metric)
+        {statname: metric.name, metric_type: metric.type, metric_value: metric.value}.merge(metric.data).merge(metric.tags)
+      end
+
+      def output_data(data)
+        log_file.open('a') { |f| f.puts(JSON.dump data) }
+      end
+
+      private
+
+      def log_file
+        ::Meter.config.log_dir.join('application.json.log')
+      end
+
+    end
+  end
+end

data/lib/meter/backends/statsd.rb

@@ -0,0 +1,23 @@
+require 'socket'
+
+module Meter
+  module Backends
+    class Statsd < ::Meter::Backends::Udp
+
+      def self.supported_metrics
+        [:counter, :gauge, :timing]
+      end
+
+      def convert_to_backend_format(metric)
+        rate = "|@#{metric.sample_rate}" unless metric.sample_rate == 1
+        "#{metric.name}:#{metric.value}|#{statsd_type(metric)}#{rate}"
+      end
+
+      def statsd_type(metric)
+        types = {counter: ':c', gauge: ':g', timing: ':ms'}
+        types[metric.type]
+      end
+
+    end
+  end
+end

data/lib/meter/backends/udp.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'socket'
+
+module Meter
+  module Backends
+    class Udp < ::Meter::Backends::Base
+
+      attr_reader :host, :port
+
+      def initialize(host: '127.0.0.1', port: 8125)
+        @host, @port = host, port
+      end
+
+      def output_data(data)
+        socket.send data, 0, self.host, self.port
+      end
+
+      def socket
+        Thread.current["meter_socket_#{self.class.name}"] ||= UDPSocket.new
+      end
+
+    end
+  end
+end

data/lib/meter/configuration.rb

@@ -1,6 +1,5 @@
 require 'logger'
 require 'pathname'
-require 'meter/backend'
 
 module Meter
   class Configuration
@@ -39,6 +38,11 @@ module Meter
     end
     attr_writer :hostname
 
+    def backends
+      @backends ||= []
+    end
+    attr_writer :backends
+
     private
 
     def default_logger

data/lib/meter/mdc.rb

@@ -0,0 +1,18 @@
+# stolen from https://github.com/steveklabnik/request_store
+module Meter
+  module MDC
+    def self.tags
+      Thread.current[:meter_mdc_tags] ||= {}
+    end
+
+    def self.data
+      Thread.current[:meter_mdc_data] ||= {}
+    end
+
+    def self.clear!
+      Thread.current[:meter_mdc_tags] = {}
+      Thread.current[:meter_mdc_data] = {}
+    end
+
+  end
+end

data/lib/meter/metric/base.rb

@@ -0,0 +1,57 @@
+module Meter
+  module Metric
+    class Base
+
+      attr_reader   :name
+      attr_reader   :tags
+      attr_reader   :data
+      attr_accessor :value
+      attr_accessor :sample_rate
+
+      def type
+      end
+
+      def initialize(name:, value: default_value, sample_rate: 1, tags: {}, data: {})
+        self.name = name
+        self.value = value
+        self.sample_rate = sample_rate
+        self.tags = tags
+        self.data = data
+      end
+
+      def name=(new_name)
+        # Replace Ruby module scoping with '.' and reserved chars (: | @) with underscores.
+        @name = new_name.to_s.gsub('::', '.').tr(':|@', '_')
+      end
+
+      def tags=(new_tags)
+        @tags = default_tags.merge(new_tags)
+      end
+
+      def data=(new_data)
+        @data = default_data.merge(new_data)
+      end
+
+      private
+
+      def default_value
+      end
+
+      def default_tags
+        {
+          app:         ::Meter.config.namespace,
+          environment: ::Meter.config.environment
+        }.merge(::Meter::MDC.tags)
+      end
+
+      def default_data
+        {
+          timestamp: Time.now.strftime("%FT%H:%M:%S%:z"),
+          host:      ::Meter.config.hostname,
+        }.merge(::Meter::MDC.data)
+      end
+
+
+    end
+  end
+end

data/lib/meter/metric/counter.rb

@@ -0,0 +1,17 @@
+module Meter
+  module Metric
+    class Counter < Meter::Metric::Base
+
+      def type
+        :counter
+      end
+
+      private
+
+      def default_value
+        1
+      end
+
+    end
+  end
+end

data/lib/meter/metric/gauge.rb

@@ -0,0 +1,11 @@
+module Meter
+  module Metric
+    class Gauge < Meter::Metric::Base
+
+      def type
+        :gauge
+      end
+
+    end
+  end
+end

data/lib/meter/metric/histogram.rb

@@ -0,0 +1,10 @@
+module Meter
+  module Metric
+    class Histogram < Meter::Metric::Base
+
+      def type
+        :histogram
+      end
+    end
+  end
+end

data/lib/meter/metric/timing.rb

@@ -0,0 +1,11 @@
+module Meter
+  module Metric
+    class Timing < Meter::Metric::Base
+
+      def type
+        :timing
+      end
+
+    end
+  end
+end

data/lib/meter/rails/middleware.rb

@@ -0,0 +1,15 @@
+module Meter
+  module Rails
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      ensure
+        Meter::MDC.clear!
+      end
+    end
+  end
+end

data/lib/meter/rails/railtie.rb

@@ -0,0 +1,19 @@
+module Meter
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "meter.insert_middleware" do |app|
+        if ActionDispatch.const_defined? :RequestId
+          app.config.middleware.insert_after ActionDispatch::RequestId, Meter::Rails::Middleware
+        else
+          app.config.middleware.insert_after Rack::MethodOverride, Meter::Rails::Middleware
+        end
+
+        if ActionDispatch.const_defined?(:Reloader) && ActionDispatch::Reloader.respond_to?(:to_cleanup)
+          ActionDispatch::Reloader.to_cleanup do
+            Meter::MDC.clear!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/meter/version.rb

@@ -1,8 +1,8 @@
 module Meter
   module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 1
-    TINY  = 7
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meter
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - bukowskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -73,11 +73,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/meter.rb
-- lib/meter/backend.rb
-- lib/meter/backends.rb
+- lib/meter/backends/base.rb
+- lib/meter/backends/datadog.rb
+- lib/meter/backends/json_log.rb
+- lib/meter/backends/statsd.rb
+- lib/meter/backends/udp.rb
 - lib/meter/configuration.rb
 - lib/meter/configure.rb
+- lib/meter/mdc.rb
+- lib/meter/metric/base.rb
+- lib/meter/metric/counter.rb
+- lib/meter/metric/gauge.rb
+- lib/meter/metric/histogram.rb
+- lib/meter/metric/timing.rb
+- lib/meter/rails/middleware.rb
+- lib/meter/rails/railtie.rb
 - lib/meter/version.rb
 homepage: https://github.com/bukowskis/meter
 licenses:

data/lib/meter/backend.rb

@@ -1,57 +0,0 @@
-require 'json'
-require 'socket'
-
-module Meter
-  class Backend
-
-    attr_reader :host, :port
-
-    def initialize(host = '127.0.0.1', port = 8125)
-      @host, @port = host, port
-
-      @socket = UDPSocket.new
-    end
-
-    def increment(stat, options = {})
-      send_stats stat, 1, :c, options
-    end
-
-    def gauge(stat, value, options = {})
-      send_stats stat, value, :g, options
-    end
-
-    def histogram(stat, value, options = {})
-      send_stats stat, value, :h, options
-    end
-
-    def log(stat, data = {})
-      data = { environment: ::Meter.config.environment, Timestamp: Time.now.strftime("%FT%H:%M:%S%:z") }.merge data
-      data.merge! app: ::Meter.config.namespace, host: ::Meter.config.hostname, statname: stat
-      ::Meter.config.logger.debug { "Logging #{log_file} - #{data}"}
-      log_file.open('a') { |f| f.puts(JSON.dump data) }
-    end
-
-    private
-
-    def log_file
-      ::Meter.config.log_dir.join('application.json.log')
-    end
-
-    # See https://github.com/DataDog/dogstatsd-ruby/blob/master/lib/statsd.rb
-    def send_stats(stat, delta, type, options = {})
-      sample_rate = options[:sample_rate] || 1
-      return unless sample_rate == 1 or rand < sample_rate
-      stat = stat.to_s.gsub('::', '.').tr(':|@', '_')
-      rate = "|@#{sample_rate}" unless sample_rate == 1
-      app_tag = ["app:#{::Meter.config.namespace}"]
-      tags = "|##{(Array(options[:tags]) + app_tag).join(",")}"
-      send_to_socket "#{stat}:#{delta}|#{type}#{rate}#{tags}"
-    end
-
-    def send_to_socket(message)
-      ::Meter.config.logger.debug { "UDP #{self.host}:#{self.port} - #{message}" }
-      @socket.send message, 0, self.host, self.port
-    end
-
-  end
-end

data/lib/meter/backends.rb

@@ -1,16 +0,0 @@
-require 'meter/backend'
-require 'ostruct'
-
-module Meter
-
-  # Holds the currently known backends.
-  #
-  def self.backends
-    @backends ||= ::OpenStruct.new(
-    datadog: ::Meter::Backend.new('127.0.0.1', 8125),
-    counter: ::Meter::Backend.new('127.0.0.1', 3333),
-    heka:    ::Meter::Backend.new('127.0.0.1', 8128),
-  )
-  end
-
-end