wat_catcher 0.10.8 → 0.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 070f613f1ee147040280aa28a22e2fcfb989f5d7
-  data.tar.gz: eb7f3a5b2bc60730da99376d3b03277317488d44
+  metadata.gz: 712be060f30a0d18b0801b6dfdcfff48fe5bde00
+  data.tar.gz: df3885aed59be97cb8136995ee4558baf571d704
 SHA512:
-  metadata.gz: c06265056133d54901ef3a8be4e6fe68658be835ae079006b770113bd363a069b009b9e252385376ca1e7c1802df99e2f9cbcec68e839ad94a15ae0d0d230267
-  data.tar.gz: 07462e84a3dc28252f4fa13473c9a20596a82d3ec7d3256611cb508bd2eb6c0831b7f6ad321180b4cc1abe20f66082df7274f641a478b1990ce413331dd693a7
+  metadata.gz: 79380328041b6d62094cf628aec75d91a937914cf10b4f9eb387b5ecc735041f411e856579db6f1abc1277761840972e7e941d2549d484874188d226c72a8985
+  data.tar.gz: 9e9f68302a48c01e6082ffb2011f788f47c906ff237cdbbecfed4b288f9c47897d8ddc86ad92771276b0115cca3a75f0426f752e5f66ffc309713f2e29d0cf43

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    wat_catcher (0.10.8)
+    wat_catcher (0.10.9)
       coffee-rails
       httpclient
       rails (>= 4.2.0)
+      statsd-ruby
 
 GEM
   remote: https://rubygems.org/
@@ -76,7 +77,7 @@ GEM
       guard (>= 2.1.0)
       guard-compat (~> 1.1)
     guard-compat (1.2.1)
-    httpclient (2.8.2.4)
+    httpclient (2.8.3)
     i18n (0.7.0)
     jasmine (2.4.0)
       jasmine-core (~> 2.4)
@@ -173,6 +174,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.3.11)
+    statsd-ruby (1.3.0)
     thor (0.19.4)
     thread_safe (0.3.5)
     tzinfo (1.2.2)

data/README.md

@@ -66,6 +66,32 @@ YourApp::Application.configure do
 end
 ```
 
+#### Adding Telemetry
+In `config/wat_catcher.yml`:
+
+```yml
+production: &default
+  statsd_host: statsd.service.consul
+  statsd_port: 9125
+  metrics_disabled: false # defaults to true
+```
+
+Alternatively, this can be configured in `config/application.rb` or environment file (e.g. `config/environments/production.rb`).
+```ruby
+module YourApp
+  class Application < Rails::Application
+    WatCatcher.configuration.statsd_host = "statsd.service.consul"
+    WatCatcher.configuration.statsd_port = 9125
+    WatCatcher.configuration.metrics_disabled = false
+  end
+end
+```
+
+```ruby
+YourApp::Application.configure do
+  WatCatcher.configuration.metrics_disabled = false
+end
+```
 
 ### Mount the engine in your app for javascript errors
 To get around cross-origin issues, an engine was created that accepts POSTs of client exceptions and puts a sidekiq

data/lib/wat_catcher.rb

@@ -1,5 +1,7 @@
+require 'statsd'
 require "wat_catcher/version"
 
+require "wat_catcher/metrics"
 require "wat_catcher/report"
 require "wat_catcher/poster"
 require "wat_catcher/wattle_helper"

data/lib/wat_catcher/metrics.rb

@@ -0,0 +1,29 @@
+module WatCatcher
+  class Metrics
+    attr_writer :host, :port
+
+    def host
+      @host ||= 'localhost'
+    end
+
+    def port
+      @port ||= 9125
+    end
+
+    def client
+      ::Statsd.new @host, @port
+    end
+
+    def increment(metric, sample_rate=1)
+      client.increment metric, sample_rate
+    end
+
+    def decrement(metric, sample_rate=1)
+      client.increment metric, sample_rate
+    end
+
+    def set(metric, value, sample_rate=1)
+      client.set metric, value, sample_rate
+    end
+  end
+end

data/lib/wat_catcher/report.rb

@@ -9,6 +9,7 @@ module WatCatcher
       self.user = user
       send_report
       log_report
+      instrument_report unless metrics_disabled?
     end
 
     def send_report
@@ -21,6 +22,38 @@ module WatCatcher
       Rails.logger.error( "WatCatcher::error: " + base_description.tap {|x| x.delete(:rails_root) }.to_json )
     end
 
+    def metrics_disabled?
+      WatCatcher.configuration.metrics_disabled = true if WatCatcher.configuration.metrics_disabled.nil?
+      WatCatcher.configuration.metrics_disabled
+    end
+
+    def metrics_reporter
+      @reporter ||= ::WatCatcher::Metrics.new
+      @reporter.host = WatCatcher.configuration.statsd_host
+      @reporter.port = WatCatcher.configuration.statsd_port
+
+      @reporter
+    end
+
+    def metrics_namespace
+      "#{base_description[:app_name]}.#{base_description[:app_env]}".downcase
+    end
+
+    def instrument_report
+      return if WatCatcher.configuration.disabled
+
+      # increment graphite counter, ':' is used to seperate metric from metric value -- therefore, replace ':' with '_'
+      #   e.g. kairos.staging.exceptions.NoMethodError.frequency is count of `NoMethodError`s during sample period (60s)
+      #
+      # for application-aggregated
+      metrics_reporter.increment "#{metrics_namespace}.wat.#{exception_description[:error_class].gsub ':', '_'}.frequency"
+      # for server-aggregated
+      metrics_reporter.increment "#{metrics_namespace}.#{base_description[:hostname]}.wat.#{exception_description[:error_class].gsub ':', '_'}.frequency"
+
+      # emit an event that an exception was raised
+      metrics_reporter.set "#{metrics_namespace}.#{base_description[:hostname]}.wat.#{base_description[:error_class]}.occurance", base_description[:captured_at]
+    end
+
     def params
       { wat: base_description
         .merge(user_description)

data/lib/wat_catcher/version.rb

@@ -1,3 +1,3 @@
 module WatCatcher
-  VERSION = "0.10.8"
+  VERSION = "0.10.9"
 end

data/wat_catcher.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency     'coffee-rails'
   spec.add_runtime_dependency     'rails', '>= 4.2.0'
   spec.add_runtime_dependency     'httpclient'
+  spec.add_runtime_dependency     'statsd-ruby'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wat_catcher
 version: !ruby/object:Gem::Version
-  version: 0.10.8
+  version: 0.10.9
 platform: ruby
 authors:
 - Chris Constantine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  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'
 description: Catch your wats
 email:
 - cconstan@gmail.com
@@ -186,6 +200,7 @@ files:
 - config/routes.rb
 - lib/wat_catcher.rb
 - lib/wat_catcher/engine.rb
+- lib/wat_catcher/metrics.rb
 - lib/wat_catcher/poster.rb
 - lib/wat_catcher/rack_middleware.rb
 - lib/wat_catcher/railtie.rb