seismograph 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcdd15888db5f139a1cfd3e35140216b00d4748e
-  data.tar.gz: 561e7a7f023d1c47e9bf9859616f1212421a6d22
+  metadata.gz: 56e91905b4b222e1e0c31c603a79f30d74abe237
+  data.tar.gz: dd10317f3aeb103d6d1816f0321cfe52d5ef0480
 SHA512:
-  metadata.gz: cdbb33b6d578858b6328f890330c14c8c4ebb922ab54a395b0c22cc6ec5677a35ebef25c820cb3549be73d5c9326253783d2bae677a662c52fc769763683c0d8
-  data.tar.gz: b323d6c2382053fadb042856312ab3ece32f2de1722f892bf6f679e5475386d8771ee0e6b16a8a237441e5e9546f08fc482341f96c7b71dce0ad5f4b3b7aca84
+  metadata.gz: a692a017eff498426e72e92d616c27b8631fa30e89133f29c2476c8219874faccc7dc5536e354c353d6772a1ce4638daf872a7039920876eb190709cf6f9a91b
+  data.tar.gz: 471321f5a40efa733ccf3b3175bffa77ea65819cef7ba84107d407034cde76f76b7ef6ef1cb2d317ed0ff547d1f1e81d455c5cd436e5ae410e6905de3c92f2ff

data/README.md

@@ -10,15 +10,20 @@ Add this line to your application's Gemfile:
 gem 'seismograph'
 ```
 
+If not using bundler, be sure to require the gem:
+
+```ruby
+require 'seismograph'
+```
+
 ## Usage
 
 Configure your statsd server:
 
 ```ruby
-require 'seismograph'
-
 Seismograph.config do |config|
-  config.app_name    = 'cabbagepult'
+  config.app_name    = 'cabbagepult'  # optional
+  config.env         = 'staging'      # optional, defaults to `RAILS_ENV` or `RACK_ENV`
   config.statsd_host = ENV.fetch('STATSD_HOST')
   config.statsd_port = ENV.fetch('STATSD_PORT')
 end
@@ -43,7 +48,25 @@ def create
 end
 ```
 
-#### Benchmarking:
+### Counting:
+
+Counting is useful for tracking simple quantities or events.  It accepts a numeric value (default
+is 1) and an optional block.  In addition to counting, this method will also track success or
+failure (via incrementing) depending on whether an error is raised.
+
+```ruby
+sensor.count('signup', 2)
+
+sensor.count('signup') do
+  User.create!(attributes)
+end
+```
+
+### Benchmarking:
+
+Benchmarking is useful for tracking how long an operation takes.  In addition to tracking the
+timing, this method will also track success or failure (via incrementing) depending on whether an
+error is raised.
 
 ```ruby
 def create
@@ -54,7 +77,20 @@ def create
 end
 ```
 
-#### Logging events:
+### Incrementing/Decrementing:
+
+Simple incrementing and decrementing can be performed on a stat.  Both methods accept a numeric
+value (default is 1).
+
+```ruby
+sensor.increment('memberships')
+sensor.decrement('memberships', 2)
+```
+
+### Logging events:
+
+Logging can be used for tracking critical events.  Valid log methods are `info`, `warning`,
+`error`, and `success`.
 
 ```ruby
 task :deploy do
@@ -67,8 +103,6 @@ task :deploy do
 
   # "warning" and "success" are the remaining type alert type possibilities
 end
-
-
 ```
 
 ## Contributing

data/lib/seismograph/gateway.rb

@@ -3,7 +3,7 @@ require 'statsd'
 module Seismograph
   module Gateway
     class << self
-      [:histogram, :increment, :time, :event].each do |method|
+      [:histogram, :increment, :decrement, :time, :event].each do |method|
         define_method(method) do |*args, &block|
           client.send(method, *args, &block)
         end

data/lib/seismograph/sensor.rb

@@ -19,24 +19,33 @@ module Seismograph
       Gateway.increment(stat(description), gateway_params(params))
     end
 
-    def benchmark(description, params = {})
-      Gateway.time(stat(description), gateway_params(params)) do
-        yield
+    def decrement(description, params = {})
+      Gateway.decrement(stat(description), gateway_params(params))
+    end
+
+    def benchmark(description, params = {}, &block)
+      with_success_and_failure(description, params) do
+        Gateway.time(stat(description), gateway_params(params), &block)
       end
     end
 
     private
 
-    def track(description, amount, params = {}, &block)
-      begin
-        block.call if block_given?
+    def track(description, amount, params = {})
+      with_success_and_failure(description, params) do
+        yield 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 with_success_and_failure(description, params)
+      yield
+      increment("#{description}.success", gateway_params(params))
+    rescue StandardError => e
+      increment("#{description}.failure", gateway_params(params))
+      raise e
+    end
+
     def stat(description)
       "#{namespace}.#{description}"
     end

data/lib/seismograph/version.rb

@@ -1,3 +1,3 @@
 module Seismograph
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seismograph
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Brandon Croft
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby