rigor_logger 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kyle Conarro
+
+MIT License
+
+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,122 @@
+# RigorLogger
+
+Wrapper to send metrics and events to DataDog
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rigor_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rigor_logger
+
+## Usage
+
+### Configuration
+Configure your API key to send to DataDog. For Rails, this could go in ```config/initializers/rigor_logger.rb```
+```ruby
+RigorLogger.config.merge! :api_key      => 'my-datadog-apikey', # required
+                          # hostname tag (Socket.gethostname default)
+                          :host         => 'hostname',          
+                          # the server running dogstatsd (localhost default)
+                          :server_host  => 'myserver.com',      
+                          # the port for dogstatsd server (8125 default)
+                          :server_port  => 1234,
+                          # an environment tag ('development' default)
+                          :environment  => Rails.env,
+                          # an app tag (nil default)
+                          :app          => 'my.app.com',
+                          # what tags to include by default
+                          :default_tags => [:environment, :host, :app]
+```
+
+### Metrics
+```ruby
+# create a metric
+metric = RigorLogger::Metric.new('namespace.my_cool_metric')
+
+# send it to DataDog
+metric.increment
+
+# or use convenience method
+RigorLogger::Metric.increment('namespace.my_cool_metric')
+```
+
+__Metric types__
+
+```ruby
+# increment a counter
+RigorLogger::Metric.increment('name')
+
+# update state
+RigorLogger::Metric.gauge('name', 123)
+
+# track distributions
+RigorLogger::Metric.histogram('name', 123)
+
+# add to a set
+RigorLogger::Metric.set('name', 123)
+
+# time a block of code
+RigorLogger::Metric.time('name') { puts 'time this code block!' }
+```
+__Default Options__
+
+By default, metrics are sent with host and environment tags. These can be passed as options as well.
+```ruby
+options = {
+    :host        => 'some_hostname',    # defaults to Socket.gethostname
+    :environment => 'staging'           # defaults to 'development'
+}
+```
+
+__Additional Options__
+```ruby
+metric_options = {
+    :tags           => ['my_tag'],          # tags for reporting dimensions
+    :sample_rate    => 0.5,                 # only send data half the time
+}
+```
+
+### Events
+__[DataDog API docs](http://docs.datadoghq.com/api/#events)__
+```ruby
+# create an event
+event = RigorLogger::Event.new('my_event')
+
+# send it to DataDog
+event.submit
+
+# or use convenience method
+RigorLogger::Event.submit('my_event')
+```
+
+__Default Options__
+
+By default, events are sent with host and environment tags. These can be passed as options as well.
+```ruby
+options = {
+    :host        => 'some_hostname',    # defaults to Socket.gethostname
+    :environment => 'staging'           # defaults to 'development'
+}
+
+RigorLogger::Event.new 'my_event', options
+```
+__Additional Options__
+```ruby
+event_options = {
+    :msg_title      => 'My Event Title',    # default: ''
+    :date_happened  => 1.day.ago,           # default: now
+    :priority       => 'normal',            # 'normal' or 'low' - default 'normal'
+    :tags           => ['my_tag'],          # tags for reporting dimensions
+    :alert_type     => 'info',              # 'info', 'warning', 'success', or 'error'
+    :aggregation_key => 'some_key',         # string to use for aggregation
+    :source_type_name => 'event_source'     # event type: nagios, hudson, jenkins, user, my apps, feed, chef, puppet, git, bitbucket, fabric, capistrano
+}
+```

data/Rakefile

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

data/lib/rigor_logger.rb

@@ -0,0 +1,23 @@
+require "rigor_logger/version"
+require 'rigor_logger/base'
+require 'rigor_logger/event'
+require 'rigor_logger/metric'
+
+module RigorLogger
+  @config = {
+    :api_key      => nil,
+    :host         => Socket.gethostname,
+    :environment  => 'development',
+    :server_host  => 'localhost',
+    :app          => nil,
+    :server_port  => 8125,
+    :default_tags => [:environment, :host]
+  }
+
+  class << self
+    attr_accessor :config
+  end
+
+  class ConfigurationError < Exception
+  end
+end

data/lib/rigor_logger/base.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'statsd'
+require 'dogapi'
+
+module RigorLogger
+
+  class Base
+    attr_reader :environment, :host, :name, :options
+
+    def initialize name, options={}
+      raise(ConfigurationError, 'Please provide an API key!') unless RigorLogger.config[:api_key]
+      @host        = options[:host] || RigorLogger.config[:host]
+      @environment = options[:environment] || RigorLogger.config[:environment]
+      @name        = name
+      @options     = set_options(options)
+    end
+
+    protected
+
+    def set_tags opts
+      t = opts[:tags] ? opts[:tags].concat(default_tags) : default_tags
+      {:tags => t}
+    end
+
+    def default_tags
+      RigorLogger.config[:default_tags].map {|tag| "#{tag}:#{self.send(tag)}"}
+    end
+
+    def set_options options
+      options.merge(set_tags(options))
+    end
+  end
+
+end

data/lib/rigor_logger/event.rb

@@ -0,0 +1,22 @@
+module RigorLogger
+  
+  class Event < Base
+
+    # convenience methods
+    def self.submit name, options={}
+      new(name, options).submit
+    end
+    
+    attr_reader :name, :options, :client
+    
+    def initialize name, options={}
+      @client = Dogapi::Client.new(RigorLogger.config[:api_key])
+      super
+    end
+
+    def submit
+      @client.emit_event @name, @options
+    end
+  end
+
+end

data/lib/rigor_logger/metric.rb

@@ -0,0 +1,58 @@
+module RigorLogger
+  
+  class Metric < Base
+
+    # convenience methods
+    def self.increment name, options={}
+      new(name, options).increment
+    end
+
+    def self.gauge name, value, options={}
+      new(name, options.merge(:value => value)).gauge
+    end
+
+    def self.histogram name, value, options={}
+      new(name, options.merge(:value => value)).histogram
+    end
+
+    def self.set name, value, options={}
+      new(name, options.merge(:value => value)).set
+    end
+
+    def self.time name, options={}, &block
+      new(name, options).time &block
+    end
+
+    attr_reader :name, :value, :options, :client, :server_host, :server_port
+
+    def initialize name, options={}
+      @server_host = options[:server_host] || RigorLogger.config[:server_host]
+      @server_port = options[:server_port] || RigorLogger.config[:server_port]
+      @client      = Statsd.new(@server_host, @server_port)
+      @value       = options[:value]
+      super
+    end
+
+    def increment
+      @client.increment @name, @options
+    end
+
+    def gauge
+      @client.gauge @name, @value, @options
+    end
+
+    def histogram
+      @client.histogram @name, @value, @options
+    end
+
+    def set
+      @client.set @name, @value, @options
+    end
+
+    def time &block
+      raise(LocalJumpError, 'no block given') unless block_given?
+      @client.time @name, @options, &block
+    end
+  end
+
+end

data/lib/rigor_logger/version.rb

@@ -0,0 +1,3 @@
+module RigorLogger
+  VERSION = "0.0.1"
+end

data/rigor_logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rigor_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rigor_logger"
+  spec.version       = RigorLogger::VERSION
+  spec.authors       = ["Kyle Conarro"]
+  spec.email         = ["kyle.conarro@rigor.com"]
+  spec.description   = %q{Metrics and Events wrapper for DataDog}
+  spec.summary       = %q{Wrapper to send metrics and events to DataDog}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "dogstatsd-ruby"
+  spec.add_runtime_dependency "dogapi"
+end

data/spec/base_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe RigorLogger::Base do
+  
+  describe 'using defaults' do
+    it 'should require an api key' do
+      expect { RigorLogger::Base.new 'test'}.to raise_error RigorLogger::ConfigurationError
+      RigorLogger.config[:api_key] = 'my_key'
+      expect { RigorLogger::Base.new 'test' }.to_not raise_error RigorLogger::ConfigurationError
+    end
+
+    it 'should require a name' do
+      expect { RigorLogger::Base.new }.to raise_error ArgumentError
+      expect { RigorLogger::Base.new 'test'}.to_not raise_error ArgumentError
+      RigorLogger::Base.new('test').name.should eql('test')
+    end
+
+    it 'should have a default environment with tag' do
+      logger = RigorLogger::Base.new('test')
+      logger.environment.should eql('development')
+      logger.options[:tags].include?('environment:development').should be_true
+    end
+
+    it 'should have a default host with tag' do
+      logger = RigorLogger::Base.new('test')
+      logger.host.should eql(Socket.gethostname)
+      logger.options[:tags].include?("host:#{Socket.gethostname}").should be_true
+    end
+  end
+
+  describe 'overriding defaults' do
+    it 'should use options for environment' do
+      logger = RigorLogger::Base.new('test', :environment => 'lala-land')
+      logger.environment.should eql('lala-land')
+      logger.options[:tags].include?('environment:lala-land').should be_true
+    end
+
+    it 'should use options for host' do
+      logger = RigorLogger::Base.new('test', :host => 'my_host')
+      logger.host.should eql('my_host')
+      logger.options[:tags].include?("host:my_host").should be_true
+    end
+
+    it 'should have configurable defaults' do
+      defaults = RigorLogger.config.dup
+      overrides = {
+        :api_key => 'some_other_key',
+        :host => 'different_host',
+        :environment => 'staging',
+        :server_host => 'statsd.com',
+        :server_port => 12345,
+        :default_tags => [:host]
+      }
+
+      defaults.each do |option, default_value|
+        default_value.should_not eql(RigorLogger.config.merge(overrides)[option])
+      end
+    end
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe RigorLogger::Event do
+  
+  let(:logger) { RigorLogger::Event.new('test') }
+
+  describe 'using defaults' do
+    it 'should have base attributes' do
+      logger.name.should eql('test')
+      logger.options.should be_a(Hash)
+    end
+
+    it 'should have an event client' do
+      logger.client.should_not be_nil
+      logger.client.should be_an_instance_of(Dogapi::Client)
+    end
+  end
+
+  describe '#submit' do
+    it 'should submit events using the client' do
+      Dogapi::Client.any_instance.stub(:emit_event).and_return('submitted!')
+      logger.submit.should eql('submitted!')
+    end
+
+    it 'should submit conveniently' do
+      Dogapi::Client.any_instance.stub(:emit_event).and_return('submitted!')
+      RigorLogger::Event.submit('test.event').should eql('submitted!')
+    end
+  end
+
+end

data/spec/metric_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe RigorLogger::Metric do
+  
+  let(:logger) { RigorLogger::Metric.new('test') }
+
+  describe 'using defaults' do
+    it 'should have base attributes' do
+      logger.name.should eql('test')
+      logger.options.should be_a(Hash)
+    end
+
+    it 'should have a metric client' do
+      logger.client.should_not be_nil
+      logger.client.should be_an_instance_of(Statsd)
+    end
+
+    it 'should have a default metric server' do
+      logger.server_host.should eql('localhost')
+      logger.server_port.should == 8125
+    end
+  end
+
+  describe '#increment' do
+    before { Statsd.any_instance.stub(:increment).and_return('incremented!') }
+    
+    it 'should increment a counter' do
+      logger.increment.should eql('incremented!')
+    end
+
+    it 'should increment conveniently' do
+      RigorLogger::Metric.increment('test.event').should eql('incremented!')
+    end
+  end
+
+  describe '#gauge' do
+    before { Statsd.any_instance.stub(:gauge).and_return('gauged!') }
+
+    it 'should require a value' do
+      expect { RigorLogger::Metric.gauge 'test' }.to raise_error(ArgumentError)
+      expect { RigorLogger::Metric.gauge 'test', :value => 123 }.to_not raise_error
+    end
+
+    it 'should gauge a metric' do
+      logger.gauge.should eql('gauged!')
+    end
+
+    it 'should gauge conveniently' do
+      RigorLogger::Metric.gauge('test.event', 123).should eql('gauged!')
+    end
+  end
+
+  describe '#histogram' do
+    before { Statsd.any_instance.stub(:histogram).and_return('histogrammed!') }
+
+    it 'should require a value' do
+      expect { RigorLogger::Metric.histogram 'test' }.to raise_error(ArgumentError)
+      expect { RigorLogger::Metric.histogram 'test', :value => 123 }.to_not raise_error
+    end
+
+    it 'should histogram a metric' do
+      logger.histogram.should eql('histogrammed!')
+    end
+
+    it 'should histogram conveniently' do
+      RigorLogger::Metric.histogram('test.event', 123).should eql('histogrammed!')
+    end
+  end
+
+  describe '#set' do
+    before { Statsd.any_instance.stub(:set).and_return('set!') }
+
+    it 'should require a value' do
+      expect { RigorLogger::Metric.set 'test' }.to raise_error(ArgumentError)
+      expect { RigorLogger::Metric.set 'test', :value => 123 }.to_not raise_error
+    end
+
+    it 'should set a metric' do
+      logger.set.should eql('set!')
+    end
+
+    it 'should set conveniently' do
+      RigorLogger::Metric.set('test.event', 123).should eql('set!')
+    end
+  end
+
+  describe '#time' do
+    before { Statsd.any_instance.stub(:time).and_return('timed!') }
+
+    it 'should require a block' do
+      expect { RigorLogger::Metric.time 'test' }.to raise_error(LocalJumpError)
+      expect { RigorLogger::Metric.time('test') { a = 'hi' } }.to_not raise_error
+    end
+
+    it 'should time a block' do
+      logger.time { a = 'hi' }.should eql('timed!')
+    end
+
+    it 'should time conveniently' do
+      RigorLogger::Metric.time('test.event') { a = 'hi' }.should eql('timed!')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rigor_logger'
+require 'bundler/setup'

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: rigor_logger
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kyle Conarro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-11-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: dogstatsd-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: dogapi
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: Metrics and Events wrapper for DataDog
+email: 
+- kyle.conarro@rigor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rigor_logger.rb
+- lib/rigor_logger/base.rb
+- lib/rigor_logger/event.rb
+- lib/rigor_logger/metric.rb
+- lib/rigor_logger/version.rb
+- rigor_logger.gemspec
+- spec/base_spec.rb
+- spec/event_spec.rb
+- spec/metric_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Wrapper to send metrics and events to DataDog
+test_files: 
+- spec/base_spec.rb
+- spec/event_spec.rb
+- spec/metric_spec.rb
+- spec/spec_helper.rb
+has_rdoc: