seismograph 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8985d0e21554d6c00633a9cb03a2f46a97679a10
+  data.tar.gz: dc9d5c64bcc0d864a64c995b89de37421046f5bb
+SHA512:
+  metadata.gz: 6e707ac8b165d80eb3113304b557869155ebbd3c6cb53b13eebf58e12fa3547c98849c6578c0720739b132220b69392db25b7842f00a90763df737cc3f920bc2
+  data.tar.gz: 3aa9ea075f8f466fc844c99f15ab2bcfcdd2a644863900de392fe4defd1a6b4564fb3927b17e19ce0e7a8b59b1315bd0e6b778734be519b8204eb155772e78d6

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+*.gem

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1 @@
+Proprietary

data/README.md

@@ -0,0 +1,80 @@
+# Seismograph
+
+A helper library for writing metrics and events to (http://datadoghq.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seismograph'
+```
+
+## Usage
+
+Configure your statsd server:
+
+```ruby
+require 'seismograph'
+
+Seismograph.config do |config|
+  config.app_name    = 'cabbagepult'
+  config.statsd_host = ENV.fetch('STATSD_HOST')
+  config.statsd_port = ENV.fetch('STATSD_PORT')
+end
+```
+
+After creating a sensor that designates a metric namespace, you can write values to it:
+
+```ruby
+require 'seismograph'
+
+def sensor
+  @_sensor ||= Seismograph::Sensor.new('account')
+end
+
+def create
+  users_to_create = [user1, user_2]
+
+  sensor.count('signup', users_to_create.size) do
+    # If an error is raised, the 'account.signup.failure' metric will be incremented instead
+    User.create!(users_to_create)
+  end
+end
+```
+
+#### Benchmarking:
+
+```ruby
+def create
+  sensor.benchmark('signup') do
+    # Timing will be written for the account.signup metric
+    User.create!(params)
+  end
+end
+```
+
+#### Logging events:
+
+```ruby
+task :deploy do
+  begin
+    deploy!
+    Seismograph::Log.info('App Deployed')
+  rescue StandardError => e
+    Seismograph::Log.error('Deployment failed!', description: e.message)
+  end
+
+  # "warning" and "success" are the remaining type alert type possibilities
+end
+
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/circle.yml

@@ -0,0 +1,3 @@
+dependencies:
+  pre:
+    - gem install bundler -v 1.10.6

data/lib/seismograph/configuration.rb

@@ -0,0 +1,40 @@
+module Seismograph
+  class Configuration
+    attr_writer :statsd_host
+    attr_writer :statsd_port
+    attr_writer :app_name
+    attr_writer :env
+
+    def statsd_host=(host)
+      @statsd_host = host
+    end
+
+    def statsd_port=(port)
+      @statsd_port = port.to_s
+    end
+
+    def app_name=(name)
+      @app_name = name
+    end
+
+    def env=(env)
+      @env = env
+    end
+
+    def statsd_host
+      @statsd_host || fail('No statsd_host configured')
+    end
+
+    def statsd_port
+      @statsd_port || fail('No statsd_port configured')
+    end
+
+    def app_name
+      @app_name || fail('No app_name configured')
+    end
+
+    def env
+      @env || ENV['RAILS_ENV'] || ENV['RACK_ENV']
+    end
+  end
+end

data/lib/seismograph/gateway.rb

@@ -0,0 +1,28 @@
+require 'statsd'
+
+module Seismograph
+  module Gateway
+    class << self
+      [:histogram, :increment, :time, :event].each do |method|
+        define_method(method) do |*args, &block|
+          client.send(method, *args, &block)
+        end
+      end
+
+      private
+
+      def client
+        @client ||= Statsd.new(Seismograph.config.statsd_host,
+                               Seismograph.config.statsd_port,
+                               namespace: namespace)
+      end
+
+      def namespace
+        [
+          Seismograph.config.app_name,
+          Seismograph.config.env
+        ].compact.join('.')
+      end
+    end
+  end
+end

data/lib/seismograph/log.rb

@@ -0,0 +1,26 @@
+module Seismograph
+  module Log
+    class << self
+      [:info, :error, :warning, :success].each do |alert_type|
+        define_method alert_type do |message, params = {}|
+          description = params.delete(:description) || ''
+          log(message, description, params.merge(alert_type: alert_type.to_s))
+        end
+      end
+
+      private
+
+      def log(message, description, params)
+        params[:tags] = Array(params[:tags]) if params.key?(:tags)
+        
+        Gateway.event(
+          message,
+          description,
+          params.merge(
+            source_type_name: Seismograph.config.app_name
+          )
+        )
+      end
+    end
+  end
+end

data/lib/seismograph/sensor.rb

@@ -0,0 +1,45 @@
+require 'seismograph/gateway'
+
+module Seismograph
+  class Sensor
+    attr_reader :namespace
+
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    def count(description, amount, params = {}, &block)
+      track(description, amount, params, &block)
+    end
+
+    def increment(description, params = {})
+      Gateway.increment(stat(description), gateway_params(params))
+    end
+
+    def benchmark(description, params = {})
+      Gateway.time(stat(description), gateway_params(params)) do
+        yield
+      end
+    end
+
+    private
+
+    def track(description, amount, params = {}, &block)
+      begin
+        block.call if block_given?
+        Gateway.histogram(stat(description), amount, gateway_params(params))
+      rescue StandardError => e
+        increment("#{description}.failure", gateway_params(params))
+        raise e
+      end
+    end
+
+    def gateway_params(params)
+      params.key?(:tags) ? { tags: Array(params[:tags]) } : { }
+    end
+
+    def stat(description)
+      "#{namespace}.#{description}"
+    end
+  end
+end

data/lib/seismograph/version.rb

@@ -0,0 +1,3 @@
+module Seismograph
+  VERSION = '0.1.3'
+end

data/lib/seismograph.rb

@@ -0,0 +1,11 @@
+require 'seismograph/configuration'
+require 'seismograph/sensor'
+require 'seismograph/log'
+
+module Seismograph
+  def self.config(&block)
+    @config ||= Configuration.new
+    block.call(@config) if block_given?
+    @config
+  end
+end

data/seismograph.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seismograph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'seismograph'
+  spec.version       = Seismograph::VERSION
+  spec.authors       = ['Brandon Croft', 'Matt Huggins']
+  spec.email         = ['brandon@kapost.com', 'matt.huggins@kapost.com']
+  spec.summary       = %q{Helper library to report stats and events to datadoghq}
+  spec.description   = %q{Wraps dogstatsd-ruby with helpful conventions}
+  spec.homepage      = 'https://github.com/kapost/seismograph'
+  spec.license       = 'Proprietary'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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_runtime_dependency 'dogstatsd-ruby', '~> 1.5'
+
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'bundler', '~> 1.10.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: seismograph
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Brandon Croft
+- Matt Huggins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Wraps dogstatsd-ruby with helpful conventions
+email:
+- brandon@kapost.com
+- matt.huggins@kapost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/seismograph.rb
+- lib/seismograph/configuration.rb
+- lib/seismograph/gateway.rb
+- lib/seismograph/log.rb
+- lib/seismograph/sensor.rb
+- lib/seismograph/version.rb
+- seismograph.gemspec
+homepage: https://github.com/kapost/seismograph
+licenses:
+- Proprietary
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Helper library to report stats and events to datadoghq
+test_files: []