meter 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b51363f08ba9926173d4fc3ea17658953d17621
-  data.tar.gz: df0465fd8394b30a9723c8958d171a9976ea1121
+  metadata.gz: 1fea98858b4bdf1096610854053ff2f28532ed90
+  data.tar.gz: b24dab519654d590152ee94dc88f60e671575ffa
 SHA512:
-  metadata.gz: 2bfb300157cea6663debde191fa1ad5e460329764422f6608da0f3e12de7195273fa7a7a8b9848610fc0d6fc8ac9914859caa2b3e4a63ac03415195020d27812
-  data.tar.gz: 94945415dfd1ad008a7d89a1ea5b53ff29316333feabccc4211d1f4292d5f2ff8bcb2d1145f51d5ad074119e5ae48318173308bed89dbe50f5b50af72d498eb5
+  metadata.gz: 842d05e7398a50393fa7c3ee6252ef07e08ef37eda3757129d32d4b6972ffe4486b362dd881483e04d6728075d00d28a441d3d69fa1ff12cbc4401861e9af5e1
+  data.tar.gz: 2c57251afb124930882c5d546bb9916354a289cd91ed9499ccc10f27933bdb1914ac5b17f3d3b5a01788f56af9b031a2dfd8f154c45232be1126b6ade2a725bb

data/lib/meter/backend.rb

@@ -1,216 +1,56 @@
+require 'json'
 require 'socket'
-require 'pathname'
-
-
-# Copy and paste from https://github.com/DataDog/dogstatsd-ruby/blob/master/lib/statsd.rb
-# Changes:
-# - The class is renamed to "Backend"
-# - the logger class method points to meter's logger
 
 module Meter
-  # = Statsd: A DogStatsd client (https://www.datadoghq.com)
-  #
-  # @example Set up a global Statsd client for a server on localhost:8125
-  #   require 'statsd'
-  #   $statsd = Statsd.new 'localhost', 8125
-  # @example Send some stats
-  #   $statsd.increment 'page.views'
-  #   $statsd.timing 'page.load', 320
-  #   $statsd.gauge 'users.online', 100
-  # @example Use {#time} to time the execution of a block
-  #   $statsd.time('account.activate') { @account.activate! }
-  # @example Create a namespaced statsd client and increment 'account.activate'
-  #   statsd = Statsd.new('localhost').tap{|sd| sd.namespace = 'account'}
-  #   statsd.increment 'activate'
   class Backend
-    # A namespace to prepend to all statsd calls.
-    attr_reader :namespace
-
-    # A String describing the environment, useful to distinguish staging/production
-    attr_reader :environment
-
-    attr_reader :log_dir
-
-    # StatsD host. Defaults to 127.0.0.1.
-    attr_accessor :host
 
-    # StatsD port. Defaults to 8125.
-    attr_accessor :port
-
-    def self.logger
-      Meter.config.logger
-    end
-
-    # Return the current version of the library.
-    def self.VERSION
-      "1.1.0"
-    end
+    attr_reader :host, :port
 
-    # @param [String] host your statsd host
-    # @param [Integer] port your statsd port
     def initialize(host = '127.0.0.1', port = 8125)
-      self.host, self.port = host, port
+      @host, @port = host, port
       @prefix = nil
       @socket = UDPSocket.new
     end
 
-    def namespace=(namespace) #:nodoc:
-      @namespace = namespace
-      @prefix = "#{namespace}." if @namespace
-    end
-
-    def environment=(new_environment)
-      @environment = new_environment.to_s
-    end
-
-    def host=(host) #:nodoc:
-      @host = host || '127.0.0.1'
-    end
-
-    def port=(port) #:nodoc:
-      @port = port || 8125
-    end
-
-    def log_dir=(log_dir)
-      @log_dir = Pathname.new log_dir
+    def increment(stat, options = {})
+      send_stats stat, 1, :c, options
     end
 
-    # Sends an increment (count = 1) for the given stat to the statsd server.
-    #
-    # @param [String] stat stat name
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    # @see #count
-    def increment(stat, opts={})
-      count stat, 1, opts
+    def gauge(stat, value, options = {})
+      send_stats stat, value, :g, options
     end
 
-    # Sends a decrement (count = -1) for the given stat to the statsd server.
-    #
-    # @param [String] stat stat name
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    # @see #count
-    def decrement(stat, opts={})
-      count stat, -1, opts
-    end
-
-    # Sends an arbitrary count for the given stat to the statsd server.
-    #
-    # @param [String] stat stat name
-    # @param [Integer] count count
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    def count(stat, count, opts={})
-      send_stats stat, count, :c, opts
-    end
-
-    # Sends an arbitary gauge value for the given stat to the statsd server.
-    #
-    # This is useful for recording things like available disk space,
-    # memory usage, and the like, which have different semantics than
-    # counters.
-    #
-    # @param [String] stat stat name.
-    # @param [Numeric] gauge value.
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    # @example Report the current user count:
-    #   $statsd.gauge('user.count', User.count)
-    def gauge(stat, value, opts={})
-      send_stats stat, value, :g, opts
-    end
-
-    # Sends a value to be tracked as a histogram to the statsd server.
-    #
-    # @param [String] stat stat name.
-    # @param [Numeric] histogram value.
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    # @example Report the current user count:
-    #   $statsd.histogram('user.count', User.count)
-    def histogram(stat, value, opts={})
-      send_stats stat, value, :h, opts
-    end
-
-    # Sends a timing (in ms) for the given stat to the statsd server. The
-    # sample_rate determines what percentage of the time this report is sent. The
-    # statsd server then uses the sample_rate to correctly track the average
-    # timing for the stat.
-    #
-    # @param [String] stat stat name
-    # @param [Integer] ms timing in milliseconds
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    def timing(stat, ms, opts={})
-      send_stats stat, ms, :ms, opts
-    end
-
-    # Reports execution time of the provided block using {#timing}.
-    #
-    # @param [String] stat stat name
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    # @yield The operation to be timed
-    # @see #timing
-    # @example Report the time (in ms) taken to activate an account
-    #   $statsd.time('account.activate') { @account.activate! }
-    def time(stat, opts={})
-      start = Time.now
-      result = yield
-      timing(stat, ((Time.now - start) * 1000).round, opts)
-      result
-    end
-    # Sends a value to be tracked as a set to the statsd server.
-    #
-    # @param [String] stat stat name.
-    # @param [Numeric] set value.
-    # @param [Hash] opts the options to create the metric with
-    # @option opts [Numeric] :sample_rate sample rate, 1 for always
-    # @option opts [Array<String>] :tags An array of tags
-    # @example Record a unique visitory by id:
-    #   $statsd.set('visitors.uniques', User.id)
-    def set(stat, value, opts={})
-      send_stats stat, value, :s, opts
+    def histogram(stat, value, options = {})
+      send_stats stat, value, :h, options
     end
 
     def log(stat, data = {})
-      data = { environment: environment }.merge data
-      data.merge! app: namespace, statname: stat
-      File.open(log_dir.join('application.json.log'), 'a') {|f| f.puts(data.to_json) }
-    end
-
-    def increment_and_log(stat, data = {})
-      increment stat
-      log stat, data
+      data = { environment: ::Meter.config.environment, Timestamp: Time.now }.merge data
+      data.merge! app: ::Meter.config.namespace, statname: stat
+      ::Meter.config.logger.debug { "Logging #{log_file} - #{data}"}
+      log_file.open('a') { |f| f.puts(JSON.dump data) }
     end
 
     private
 
-    def send_stats(stat, delta, type, opts={})
-      sample_rate = opts[:sample_rate] || 1
-      if sample_rate == 1 or rand < sample_rate
-        # Replace Ruby module scoping with '.' and reserved chars (: | @) with underscores.
-        stat = stat.to_s.gsub('::', '.').tr(':|@', '_')
-        rate = "|@#{sample_rate}" unless sample_rate == 1
-        tags = "|##{opts[:tags].join(",")}" if opts[:tags]
-        send_to_socket "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
-      end
+    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
+      tags = "|##{Array(options[:tags]).join(",")}" if options[:tags]
+      send_to_socket "#{@prefix}#{stat}:#{delta}|#{type}#{rate}#{tags}"
     end
 
     def send_to_socket(message)
-      self.class.logger.debug { "Statsd: #{message}" } if self.class.logger
-      @socket.send(message, 0, @host, @port)
-    rescue => boom
-      self.class.logger.error { "boom Statsd: #{boom.class} #{boom}" } if self.class.logger
-      nil
+      ::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

@@ -0,0 +1,16 @@
+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

data/lib/meter/configuration.rb

@@ -5,164 +5,59 @@ require 'meter/backend'
 module Meter
   class Configuration
 
-    attr_accessor :logger, :tags
-    attr_reader :primary_backend, :secondary_backend, :counter_backend, :meter_backend
+    attr_reader :options
 
-    def initialize(options={})
-      @logger = options[:logger] || default_logger
-
-      @primary_backend = Backend.new
-      @primary_backend.host = options[:primary_host] || default_host
-      @primary_backend.port = options[:primary_port] || default_port
-      @primary_backend.namespace = options[:namespace] || default_namespace
-      @primary_backend.environment = options[:environment] || default_environment
-
-      @secondary_backend = Backend.new
-      @secondary_backend.host = options[:secondary_host] || ENV['METER_SECONDARY_HOST'] || default_host
-      @secondary_backend.port = options[:secondary_port] || default_secondary_port
-      @secondary_backend.namespace = options[:namespace] || default_namespace
-      @secondary_backend.environment = options[:environment] || default_environment
-
-      @counter_backend = Backend.new
-      @counter_backend.host = options[:counter_host] || default_host
-      @counter_backend.port = options[:counter_port] || default_counter_port
-      @counter_backend.namespace = options[:namespace] || default_namespace
-      @counter_backend.environment = options[:environment] || default_environment
-
-      @meter_backend = Backend.new
-      @meter_backend.host = options[:meter_host] || default_host
-      @meter_backend.port = options[:meter_port] || default_meter_port
-      @meter_backend.namespace = options[:namespace] || default_namespace
-      @meter_backend.environment = options[:environment] || default_environment
-      @meter_backend.log_dir = options[:meter_log_dir] || default_meter_log_dir
-
-      @tags = options[:tags] || {}
+    def initialize(options = {})
+      @options = options
     end
 
-    def namespace=(new_namespace)
-      primary_backend.namespace = new_namespace
-      secondary_backend.namespace = new_namespace
-      counter_backend.namespace = new_namespace
-      meter_backend.namespace = new_namespace
-    end
-
-    def environment=(new_environment)
-      primary_backend.environment = new_environment
-      secondary_backend.environment = new_environment
-      counter_backend.environment = new_environment
-      meter_backend.environment = new_environment
+    def logger
+      @logger ||= options[:logger] || default_logger
     end
+    attr_writer :logger
 
     def namespace
-      primary_backend.namespace
-    end
-
-    def primary_host
-      primary_backend.host
-    end
-
-    def primary_port
-      primary_backend.port
-    end
-
-    def secondary_host
-      secondary_backend.host
-    end
-
-    def secondary_port
-      secondary_backend.port
-    end
-
-    def secondary_host
-      secondary_backend.host
-    end
-
-    def secondary_port
-      secondary_backend.port
-    end
-
-    def primary_host=(new_host)
-      primary_backend.host = new_host
+      @namespace ||= options[:namespace] || default_namespace
     end
+    attr_writer :namespace
 
-    def primary_port=(new_port)
-      primary_backend.port = new_port
+    def environment
+      @environment ||= options[:environment] || default_environment
     end
+    attr_writer :environment
 
-    def secondary_host=(new_host)
-      secondary_backend.host = new_host
+    def log_dir
+      @log_dir ||= (::Pathname.new(options[:log_dir]) if options[:log_dir]) || default_log_dir
     end
 
-    def secondary_port=(new_port)
-      secondary_backend.port = new_port
+    def log_dir=(new_dir)
+      @log_dir = Pathname.new new_dir
     end
 
     private
 
     def default_logger
-      if defined?(Rails)
-        Rails.logger
-      else
-        Logger.new(STDOUT)
-      end
-    end
-
-    def default_host
-      '127.0.0.1'
-    end
-
-    def default_port
-      8125
-    end
-
-    def default_secondary_port
-      8127
-    end
-
-    def default_counter_port
-      3333
-    end
-
-    def default_meter_port
-      8128
+      return ::Rails.logger if defined?(::Rails)
+      ::Logger.new STDOUT
     end
 
     def default_namespace
-      nil
+      :meter
     end
 
     def default_environment
-      return Rails.env if defined?(Rails)
+      return ::Rails.env if defined?(::Rails)
       return ENV['RACK_ENV'] if ENV['RACK_ENV'].to_s != ''
       return ENV['NODE_CHEF_ENVIRONMENT'] if ENV['NODE_CHEF_ENVIRONMENT'].to_s != ''
       'unknown'
     end
 
-    def default_meter_log_dir
-      return Rails.root.join('log') if defined?(Rails)
-      Pathname.pwd
+    def default_log_dir
+      return ::Rails.root.join('log') if defined?(::Rails)
+      log_subdir = ::Pathname.pwd.join('log')
+      return log_subdir if log_subdir.directory?
+      Pathname.new '/dev/null'
     end
 
   end
 end
-
-module Meter
-
-  # Public: Returns the the configuration instance.
-  #
-  def self.config
-    @config ||= Configuration.new
-  end
-
-  # Public: Yields the configuration instance.
-  #
-  def self.configure(&block)
-    yield config
-  end
-
-  # Public: Reset the configuration (useful for testing).
-  #
-  def self.reset!
-    @config = nil
-  end
-end

data/lib/meter/configure.rb

@@ -0,0 +1,17 @@
+require 'meter/configuration'
+
+module Meter
+
+  # Public: Lazy-loads and returns the the configuration instance.
+  #
+  def self.config
+    @config ||= ::Meter::Configuration.new
+  end
+
+  # Public: Yields the configuration instance.
+  #
+  def self.configure(&block)
+    yield config
+  end
+
+end

data/lib/meter/version.rb

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

data/lib/meter.rb

@@ -1,59 +1,36 @@
-require 'json'
-require 'meter/configuration'
+require 'meter/backends'
+require 'meter/configure'
 
-# A generic wrapper for Statsd-like gauges and counters.
-#
 module Meter
-  extend self
 
-  def increment(key, options = {})
+  def self.increment(key, options = {})
     id = options.delete(:id)
-    primary.increment key, options
-    if id
-      counter.increment "#{key}.#{id}", options
-    end
-  end
-
-  def count(key, delta, options = {})
-    id = options.delete(:id)
-    primary.count key, delta, options
-    if id
-      counter.count "#{key}.#{id}", delta, options
-    end
-  end
-
-  def gauge(key, value, options = {})
-    primary.gauge key, value, options
-  end
+    backends.datadog.increment key, options
+    backends.counter.increment("#{key}.#{id}", options) if id
 
-  def histogram(key, value, options = {})
-    primary.histogram key, value, options
+  rescue => exception
+    ::Meter.config.logger.error exception.inspect
   end
 
-  def log(key, data)
-    meter.log(key, data)
-  end
+  def self.gauge(key, value, options = {})
+    backends.datadog.gauge key, value, options
 
-  def increment_and_log(key, data)
-    meter.increment_and_log(key, data)
+  rescue => exception
+    ::Meter.config.logger.error exception.inspect
   end
 
-  private
+  def self.histogram(key, value, options = {})
+    backends.datadog.histogram key, value, options
 
-  def primary
-    config.primary_backend
+  rescue => exception
+    ::Meter.config.logger.error exception.inspect
   end
 
-  def secondary
-    config.secondary_backend
-  end
-
-  def counter
-    config.counter_backend
-  end
+  def self.log(key, data)
+    backends.heka.log key, data
 
-  def meter
-    config.meter_backend
+  rescue => exception
+    ::Meter.config.logger.error exception.inspect
   end
 
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: meter
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - bukowskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-28 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: trouble
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A generic abstraction layer for fire and forgetting measurements via
   UDP.
 email: 
@@ -61,7 +89,9 @@ extra_rdoc_files: []
 files:
 - lib/meter.rb
 - lib/meter/backend.rb
+- lib/meter/backends.rb
 - lib/meter/configuration.rb
+- lib/meter/configure.rb
 - lib/meter/version.rb
 homepage: https://github.com/bukowskis/meter
 licenses: