exception_dog 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dba9c5920bdfc277211b1438d705ae428d140ac
+  data.tar.gz: 510cb625d0d1a6c954433786f20c71dd7ca4eaa5
+SHA512:
+  metadata.gz: f93d08ba1f74f37f9953ddd2c1d643fffcccc9e35acc379a50b108573a2a337246bbc75e324b640955ae6b316cff565cc398eedb14df8d1735f244a5515be08e
+  data.tar.gz: 11b0eaa60a752fce420f0223ad185d08eca59ead627b0c8cdebf7255127f070d7b013441313cbddd7bf9361d5145ad362ca1a6052a2f1f23a0ec9822d6480a4e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in exception_dog.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    exception_dog (0.1.0)
+      dogstatsd-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    dogstatsd-ruby (4.0.0)
+    hashdiff (0.3.7)
+    minitest (5.11.3)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    safe_yaml (1.0.4)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  exception_dog!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcus Baguley
+
+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,57 @@
+# ExceptionDog
+
+Exception dog is a simple exception notifier gem that pushes exceptions out to Dotadog as metric events. You can set up rules within datadog to push new occurrences of the events into slack for instance, to have a reasonably good exception service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exception_dog'
+```
+
+## Usage
+
+`exception_dog` can be configured to use the datadog agent or the public cloud API.
+You can configure in an initialiser, for example: in a file `config/initializers/exception_dog.rb`
+
+Agent Configuration Example
+```
+ExceptionDog.configure do |config|
+  config.environment = ENV["RAILS_ENV"]
+  config.notifier = Rails.env.test? ? "ExceptionDog::LogNotifier" : "ExceptionDog::AgentNotifier"
+  config.agent_host = 'localhost'
+  config.agent_port = 8125
+  config.logger = Rails.logger
+  config.service_name = Rails.application.class.parent.name.underscore
+end
+```
+
+Cloud API configuration
+
+```
+ExceptionDog.configure do |config|
+  config.environment = ENV["RAILS_ENV"]
+  config.api_key = ENV["DATA_DOG_API_KEY"]
+  config.notifier = Rails.env.test? ? "ExceptionDog::LogNotifier" : "ExceptionDog::HttpNotifier"
+  config.logger = Rails.logger
+  config.service_name = Rails.application.class.parent.name.underscore
+end
+```
+
+Middleware Configuration
+You can set up a simple middleware to catch and report exceptions for Rack based apps.
+
+```
+require 'exception_dog/integrations/rack'
+Rails.application.config.middleware.insert_after ActionDispatch::ShowExceptions, ExceptionDog::Integrations::Rack
+```
+
+## Running tests
+
+```
+ruby -Ilib -Itest test/*.rb
+```
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exception_dog"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exception_dog.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "exception_dog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_dog"
+  spec.version       = ExceptionDog::VERSION
+  spec.authors       = ["Marcus Baguley"]
+  spec.email         = ["marcus.baguley@gmail.com"]
+
+  spec.summary       = %q{Wrapper for sending exceptions to datadog as events}
+  spec.description   = %q{Wrapper for sending exceptions to datadog as events}
+  spec.homepage      = "https://github.com/marcusbaguley/exception_dog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dogstatsd-ruby"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock"
+end

data/lib/exception_dog/agent_notifier.rb

@@ -0,0 +1,33 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'datadog/statsd'
+
+module ExceptionDog
+  class AgentNotifier
+
+    attr_reader :configuration
+    attr_reader :logger
+
+    OPTS_WHITELIST = [:priority, :tags, :aggregation_key, :source_type_name, :alert_type]
+
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = configuration.logger
+    end
+
+    def notify(title, text, opts)
+      logger.info "ExceptionDog::send_to_agent"
+      @@socket ||= Datadog::Statsd.new(configuration.agent_host, configuration.agent_port, logger: configuration.logger)
+      response = @@socket.event(title, text, opts)
+    end
+
+    def errors
+      @errors  = []
+      @errors << "Invalid host setup" unless configuration.agent_port && configuration.agent_host
+      @errors
+    end
+
+  end
+end
+

data/lib/exception_dog/handler.rb

@@ -0,0 +1,55 @@
+module ExceptionDog
+  class Handler
+    MAX_LINE_LENGTH = 80
+    MAX_TITLE_LENGTH = 100
+    MAX_TEXT_LEGNTH = 4000
+    BACKTRACE_LINES = 7
+    attr_reader :configuration
+    attr_reader :logger
+
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = @configuration.logger
+      @notifier = Object.const_get(@configuration.notifier).new(configuration)
+    end
+
+
+    def notify(exception, data)
+      attach_dd_trace_id(data) if self.class.dd_trace_enabled
+      title = exception.message[0..MAX_TITLE_LENGTH]
+      text = exception_text(exception, data)[0..MAX_TEXT_LEGNTH]
+      opts = {}
+      opts[:priority] ||= 'normal'
+      opts[:tags] = ["environment:#{configuration.environment}", "service:#{configuration.service_name}"] + configuration.tags
+      opts[:aggregation_key] = aggregation_key(exception)
+      opts[:source_type_name] = configuration.source_type_name
+      opts[:alert_type] = 'error'
+      @notifier.notify(title, text, opts)
+    end
+
+    def exception_text(exception, data)
+      detail = [exception.class.name[0..MAX_LINE_LENGTH], exception.message[0..MAX_LINE_LENGTH]]
+      data.each do |key, val|
+        detail << "#{key}: #{val && val.to_s[0..MAX_LINE_LENGTH]}"
+      end
+      (detail + (exception.backtrace || []))[0..BACKTRACE_LINES].compact.join("\n")
+    end
+
+    def aggregation_key(exception)
+      "#{exception.class.name}-#{exception.message}-#{exception.backtrace&.first}".hash.to_s
+    end
+
+    def attach_dd_trace_id(data)
+      data[:trace_id] = self.class.current_trace_id
+    end
+
+    def self.current_trace_id
+      context = Thread.current[:datadog_context]
+      context&.trace_id
+    end
+
+    def self.dd_trace_enabled
+      @dd_trace_enabled ||= Object.const_get('Datadog::Context') rescue false
+    end
+  end
+end

data/lib/exception_dog/http_notifier.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'datadog/statsd'
+
+module ExceptionDog
+  class HttpNotifier
+
+    attr_reader :configuration
+    attr_reader :logger
+
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = configuration.logger
+    end
+
+    def notify(title, text, opts)
+      uri = URI.parse("https://api.datadoghq.com/api/v1/events?api_key=#{configuration.api_key}")
+      logger = configuration.logger
+      header = {'Content-Type': 'application/json'}
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+      request.body = {title: title, text: text}.merge(opts).to_json
+      logger.info "ExceptionDog::send_to_api"
+      begin
+        response = http.request(request)
+        logger.debug response.body if response.respond_to?(:body)
+        logger.debug "ExceptionDog:Response: #{response.inspect}"
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+               Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        logger.error("ExceptionDog::Failed to send to datadog")
+        logger.error(e)
+      end
+    end
+
+    def errors
+      @errors  = []
+      @errors << "Invalid API Key" unless configuration.api_key && configuration.api_key =~ /[0-9a-f]{32}/i
+    end
+  end
+end
+

data/lib/exception_dog/integrations/rack.rb

@@ -0,0 +1,21 @@
+module ExceptionDog::Integrations
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        response = @app.call(env)
+      rescue Exception => raised
+        data = {
+          request_uri: env["REQUEST_URI"],
+          remote_ip: env["HTTP_X_FORWARDED_FOR"] || env["HTTP_FORWARDED_FOR"]
+        }
+        ExceptionDog.notify(raised, data)
+        raise raised
+      end
+      response
+    end
+  end
+end

data/lib/exception_dog/log_notifier.rb

@@ -0,0 +1,32 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'datadog/statsd'
+
+module ExceptionDog
+  class LogNotifier
+
+    attr_reader :configuration
+    attr_reader :logger
+
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = configuration.logger
+    end
+
+    def notify(title, text, opts)
+      logger.info "#{title}, #{text}, #{opts}"
+      @@last_log = [title, text, opts]
+    end
+
+    def self.last_log
+      @@last_log
+    end
+
+    def errors
+      []
+    end
+
+  end
+end
+

data/lib/exception_dog/version.rb

@@ -0,0 +1,3 @@
+module ExceptionDog
+  VERSION = "0.3.2"
+end

data/lib/exception_dog.rb

@@ -0,0 +1,74 @@
+require "rubygems"
+
+require "exception_dog/version"
+require "exception_dog/agent_notifier"
+require "exception_dog/http_notifier"
+require "exception_dog/log_notifier"
+require "exception_dog/handler"
+
+module ExceptionDog
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :app_name
+    attr_accessor :source_type_name
+    attr_accessor :alert_type
+    attr_accessor :environment
+    attr_accessor :logger
+    attr_accessor :service_name
+    attr_accessor :tags
+    attr_accessor :test_mode
+    attr_accessor :agent_host
+    attr_accessor :agent_port
+    attr_accessor :notifier
+    attr_accessor :notifier_instance
+
+    def initialize
+      self.source_type_name = 'my_apps'
+      self.alert_type = 'error'
+      self.environment = 'prod'
+      self.test_mode = false
+      self.agent_host = 'localhost'
+      self.agent_port = 8125
+      self.tags = []
+      self.logger = Logger.new(STDOUT)
+    end
+
+    def errors
+      @errors = []
+      @errors << "No service_name supplied" unless service_name
+      @errors << "No notifier configured" unless notifier
+      @errors
+    end
+
+    def valid?
+      errors.empty?
+    end
+  end
+
+  class << self
+
+    def configuration
+      @configuration
+    end
+
+    def configure
+      @configuration = Configuration.new
+      yield @configuration
+      @configuration.logger ||= Logger.new(STDOUT)
+      if !configuration.valid?
+        @configuration.logger.error "Invalid ExceptionDog config #{configuration.errors.inspect}"
+        @configuration.notifier = "LogNotifier"
+      end
+      @handler = Handler.new(configuration)
+      @configuration
+    end
+
+    def notify(exception, data = {})
+      @handler.notify(exception, data)
+    end
+
+    def default_hostname
+      Socket.gethostname;
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: exception_dog
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Marcus Baguley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Wrapper for sending exceptions to datadog as events
+email:
+- marcus.baguley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exception_dog.gemspec
+- lib/exception_dog.rb
+- lib/exception_dog/agent_notifier.rb
+- lib/exception_dog/handler.rb
+- lib/exception_dog/http_notifier.rb
+- lib/exception_dog/integrations/rack.rb
+- lib/exception_dog/log_notifier.rb
+- lib/exception_dog/version.rb
+homepage: https://github.com/marcusbaguley/exception_dog
+licenses:
+- MIT
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for sending exceptions to datadog as events
+test_files: []