failbot 0.9.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 535bea1efe92287487fb8eca35fa79362b5a3467
-  data.tar.gz: 6e95a3258b3778cb4c832201431685fed770051f
+  metadata.gz: 43be75d2d64074d5158ec207574a66a0b432d4b1
+  data.tar.gz: 87df59cc018eda249fa17c6c95588bf5bc96c569
 SHA512:
-  metadata.gz: 837e0d280e169632d08e79fb3f5703278f622a43fc7dbc3c36dec172d7fe8b46f90fa92d9634c8e2289186f1c7e0ccc218cae974931798c0f5002d833654e6a2
-  data.tar.gz: 75dd783805b131deda512d0234fa08a517e9482751aac30b2cdc5c05ad142430bde3531f6f749c2da451c089f815b24a3502122e9a1acd1ef527dc4ad190b77d
+  metadata.gz: 49262b3d84f1b2004ce2cac34030da256f8418fa323cd06c940427cc012d9d724a69bfc7a27ac8777f8d286cec225077296f38f9d2b190270ac313e0150bdc27
+  data.tar.gz: c2843b60c8df18431bbf0cf88d52d8b783d301b3ead6475b9e1d5d4add90517593ad1ac56a78d3f752d0d42221fa0db53fcf458479cbe86c8aac09014cdc61bc

data/lib/failbot.rb

@@ -2,6 +2,7 @@ require 'yaml'
 require 'digest/md5'
 require 'logger'
 require 'socket'
+require "time"
 require "uri"
 
 require 'failbot/version'
@@ -11,13 +12,9 @@ require "failbot/compat"
 # exception logger du jour. Keeps the main app from failing or lagging if
 # the exception logger service is down or slow.
 module Failbot
-  # The failbot relay server.
-  autoload :Server,   'failbot/server'
-
   # Interface for posting exception data to haystack.
   autoload :Haystack, 'failbot/haystack'
 
-  autoload :BERTBackend,   'failbot/bert_backend'
   autoload :FileBackend,   'failbot/file_backend'
   autoload :HerokuBackend, 'failbot/heroku_backend'
   autoload :HTTPBackend,   'failbot/http_backend'
@@ -27,10 +24,18 @@ module Failbot
   # prevent recursive calls to Failbot.report!
   attr_accessor :already_reporting
 
+  # see failbot/exit_hook.rb for more on these
+  @failbot_loaded = true
+  @auto_install_hook = false
+
+  # This must be required before any of the method definitions below so that
+  # stubbed methods are replaced properly.
+  require 'failbot/exit_hook'
+
   # Public: Setup the backend for reporting exceptions.
   def setup(settings={}, default_context={})
     deprecated_settings = %w[
-      backend host port haystack workers service_logs
+      backend host port haystack
       raise_errors
     ]
 
@@ -48,8 +53,6 @@ module Failbot
 
     self.backend =
       case (name = settings["FAILBOT_BACKEND"])
-      when "bert"
-        Failbot::BERTBackend.new(URI(settings["FAILBOT_BACKEND_BERT_URL"]))
       when "memory"
         Failbot::MemoryBackend.new
       when "file"
@@ -62,7 +65,8 @@ module Failbot
         raise ArgumentError, "Unknown backend: #{name.inspect}"
       end
 
-    @raise_errors = !settings["FAILBOT_RAISE"].to_s.empty?
+    @raise_errors  = !settings["FAILBOT_RAISE"].to_s.empty?
+    @report_errors = settings["FAILBOT_REPORT"] != "0"
   end
 
   # Bring in deprecated methods
@@ -126,6 +130,7 @@ module Failbot
   end
 
   def report!(e, other = {})
+    return unless @report_errors
     data = squash_context(exception_info(e), other)
 
     if already_reporting
@@ -171,7 +176,9 @@ module Failbot
         value = (value.call rescue nil) if value.kind_of?(Proc)
         merged[key.to_s] =
           case value
-          when String, Numeric, true, false
+          when Numeric
+            value
+          when String, true, false
             value.to_s
           else
             value.inspect
@@ -216,33 +223,6 @@ module Failbot
     res
   end
 
-  # Installs an at_exit hook to report exceptions that raise all the way out of
-  # the stack and halt the interpreter. This is useful for catching boot time
-  # errors as well and even signal kills.
-  #
-  # To use, call this method very early during the program's boot to cover as
-  # much code as possible:
-  #
-  #   require 'failbot'
-  #   Failbot.install_unhandled_exception_hook!
-  #
-  # Returns true when the hook was installed, nil when the hook had previously
-  # been installed by another component.
-  def install_unhandled_exception_hook!
-    # only install the hook once, even when called from multiple locations
-    return if @unhandled_exception_hook_installed
-
-    # the $! is set when the interpreter is exiting due to an exception
-    at_exit do
-      boom = $!
-      if boom && !@raise_errors && !boom.is_a?(SystemExit)
-        report(boom, 'argv' => ([$0]+ARGV).join(" "), 'halting' => true)
-      end
-    end
-
-    @unhandled_exception_hook_installed = true
-  end
-
   def logger
     @logger ||= Logger.new($stderr)
   end
@@ -256,4 +236,12 @@ module Failbot
   end
 
   extend self
+
+  # If the library was lazy loaded due to failbot/exit_hook.rb and a delayed
+  # config is set, configure the library now.
+  if @delayed_settings
+    setup(@delayed_settings, @delayed_default_context)
+    @delayed_settings = nil
+    @delayed_default_context = nil
+  end
 end

data/lib/failbot/compat.rb

@@ -40,9 +40,6 @@ module Failbot
     # memory - Dummy backend that simply save exceptions in memory. Typically
     #          used in testing environments.
     #
-    # bert   - The BERT-RPC backend relays exceptions using the bert library.
-    #          See <https://github.com/mojombo/bert> for details.
-    #
     # heroku - In-process posting for outside of vpn apps
     #
     # file   - Append JSON-encoded exceptions to a file.
@@ -77,6 +74,23 @@ module Failbot
       @raise_errors = v
     end
 
+    def report_errors?
+      warn "#{caller[0]} Failbot.report_errors? is deprecated and will be " \
+        "removed in subsequent releases."
+
+      if @report_errors.nil?
+        config['report_errors']
+      else
+        @report_errors
+      end
+    end
+
+    def report_errors=(v)
+      warn "#{caller[0]} Failbot.report_errors= is deprecated and will be " \
+        "removed in subsequent releases."
+      @report_errors = v
+    end
+
     # Load and initialize the exception reporting backend as specified by
     # the 'backend' configuration option.
     #
@@ -90,9 +104,6 @@ module Failbot
       warn "#{caller[0]} Failbot.backend! is deprecated and will be " \
         "removed in subsequent releases."
       case backend_name
-      when 'bert'
-        url = URI("bertrpc://#{config["host"]}:#{config["port"]}")
-        Failbot::BERTBackend.new(url)
       when 'memory'
         Failbot::MemoryBackend.new
       when 'file'
@@ -128,14 +139,6 @@ module Failbot
       backend.report(data)
     end
 
-    def service
-      warn "#{caller[0]} Failbot.service is deprecated and will be " \
-        "removed in subsequent releases."
-      @service ||= BERTRPC::Service.new(config['host'], config['port'])
-    end
-
-    alias svc service
-
     def fail
       warn "#{caller[0]} Failbot.fail is deprecated and will be " \
         "removed in subsequent releases."

data/lib/failbot/exit_hook.rb

@@ -1,16 +1,86 @@
 # This file exists so that the unhandled exception hook may easily be injected
-# into programs that don't register it themselves. To use, set RUBYOPT or pass
-# an -r argument to ruby:
+# into programs that don't register it themselves. It also provides a
+# lightweight failbot interface that doesn't bring in any other libraries until
+# a report is made, which is useful for environments where boot time is
+# important.
 #
-# With RUBYOPT:
+# To use, set RUBYOPT or pass an -r argument to ruby:
 #
 #   RUBYOPT=rfailbot/exit_hook some-program.rb
 #
-# With ruby -r:
+# Or:
 #
 #   ruby -rfailbot/exit_hook some-program.rb
 #
-# Note: it may be necessary to also require rubygems w/ RUBYOPT or -r before
-# requiring failbot/exit_hook.
-require 'failbot'
-Failbot.install_unhandled_exception_hook!
+# Your program can also require this library instead of 'failbot' to minimize
+# the amount of up-front processing required and automatically install the exit
+# hook.
+#
+#   require 'failbot/exit_hook'
+#
+# The 'failbot' lib is loaded in full the first time an actual report is made.
+module Failbot
+  # Config hash sent to setup method. We store this off so we have it when we
+  # need to actually load stuff.
+  @delayed_settings = nil
+  @delayed_default_context = nil
+
+  # Have we loaded the whole failbot lib yet?
+  @failbot_loaded = false if !defined?(@failbot_loaded)
+
+  # Has the unhandled exception hook been installed yet?
+  @unhandled_exception_hook_installed = false
+
+  # Should we automatically install the exit hook? This is true when this
+  # library is required directly, false when the main 'failbot' library is
+  # required directly.
+  @auto_install_hook = true if !defined?(@auto_install_hook)
+
+  # Installs an at_exit hook to report exceptions that raise all the way out of
+  # the stack and halt the interpreter. This is useful for catching boot time
+  # errors as well and even signal kills.
+  #
+  # To use, call this method very early during the program's boot to cover as
+  # much code as possible:
+  #
+  #   require 'failbot'
+  #   Failbot.install_unhandled_exception_hook!
+  #
+  # Returns true when the hook was installed, nil when the hook had previously
+  # been installed by another component.
+  def install_unhandled_exception_hook!
+    # only install the hook once, even when called from multiple locations
+    return if @unhandled_exception_hook_installed
+
+    # the $! is set when the interpreter is exiting due to an exception
+    at_exit do
+      boom = $!
+      if boom && !@raise_errors && !boom.is_a?(SystemExit)
+        report(boom, 'argv' => ([$0]+ARGV).join(" "), 'halting' => true)
+      end
+    end
+
+    @unhandled_exception_hook_installed = true
+  end
+
+  # Shim into Failbot.setup and store config information off for the first time
+  # a real method is invoked.
+  def setup(settings = {}, default_context = {})
+    @delayed_settings = settings.dup
+    @delayed_default_context = default_context.dup
+  end
+
+  # Tap into any other method invocation on the Failbot module (especially report)
+  # and lazy load and configure everything the first time.
+  def method_missing(method, *args, &block)
+    return super if @failbot_loaded
+    require 'failbot'
+    send(method, *args, &block)
+  end
+
+  extend self
+
+  # If failbot/exit_hook was required directly, without the main lib, install
+  # the exit hook automatically.
+  install_unhandled_exception_hook! if @auto_install_hook
+end

data/lib/failbot/failbot.yml

@@ -3,32 +3,29 @@ development:
   host: localhost
   port: 6668
   haystack: http://haystack.dev/_needles
-  workers: 1
-  service_log: /tmp/failbot.log
   raise_errors: true
+  report_errors: false
 
 test:
   backend: memory
   host: localhost
   port: 6666
   haystack: http://haystack.dev/_needles
-  workers: 0
   raise_errors: true
+  report_errors: false
 
 production:
   backend: json
   host: localhost
   port: 6668
   haystack: https://haystack.githubapp.com/_needles
-  workers: 2
-  service_log: /data/github/current/log/failbot.log
   raise_errors: false
+  report_errors: true
 
 staging:
   backend: json
   host: localhost
   port: 6668
   haystack: https://haystack.githubapp.com/_needles
-  workers: 1
-  service_log: /data/github/current/log/failbot.log
   raise_errors: false
+  report_errors: true

data/lib/failbot/json_backend.rb

@@ -1,15 +1,23 @@
-require 'json'
+require 'yajl'
 
 module Failbot
   class JSONBackend
     def initialize(host, port)
+      if host.to_s.empty?
+        raise ArgumentError, "FAILBOT_BACKEND_JSON_HOST setting required."
+      end
+      if port.to_s.empty?
+        raise ArgumentError, "FAILBOT_BACKEND_JSON_PORT setting required."
+      end
+
       @host = host
       @port = port
     end
 
     def report(data)
       @socket = TCPSocket.new @host, @port
-      @socket.send(data.to_json, 0)
+      payload = Yajl.dump(data)
+      @socket.send(payload, 0)
       @socket.close
     end
 

data/lib/failbot/version.rb

@@ -1,3 +1,3 @@
 module Failbot
-  VERSION = "0.9.6"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,88 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 1.0.0
 platform: ruby
 authors:
-- '@rtomayko'
-- '@atmos'
-- '@sr'
+- "@rtomayko"
+- "@atmos"
+- "@sr"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: bertrpc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-description: '...'
+description: "..."
 email:
 - github+failbot@lists.github.com
-executables:
-- failbot
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/failbot.rb
-- lib/failbot/bert_backend.rb
 - lib/failbot/compat.rb
 - lib/failbot/exit_hook.rb
 - lib/failbot/failbot.yml
 - lib/failbot/file_backend.rb
-- lib/failbot/handler.rb
 - lib/failbot/haystack.rb
 - lib/failbot/heroku_backend.rb
 - lib/failbot/http_backend.rb
@@ -90,9 +73,7 @@ files:
 - lib/failbot/memory_backend.rb
 - lib/failbot/middleware.rb
 - lib/failbot/resque_failure_backend.rb
-- lib/failbot/server.rb
 - lib/failbot/version.rb
-- bin/failbot
 homepage: http://github.com/github/failbot#readme
 licenses: []
 metadata: {}
@@ -102,17 +83,17 @@ 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: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Deliver exceptions to Haystack

data/bin/failbot

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-require 'failbot'
-Failbot::Server.new(port=ARGV.shift, tmp=ARGV.shift).exec!
-
-# vim:ft=ruby

data/lib/failbot/bert_backend.rb

@@ -1,17 +0,0 @@
-require 'bertrpc'
-
-module Failbot
-  class BERTBackend
-    def initialize(url)
-      @service = BERTRPC::Service.new(url.host, url.port)
-    end
-
-    def report(data)
-      @service.cast.failbot.report(data)
-    end
-
-    def reports
-      raise NotImplementedError
-    end
-  end
-end

data/lib/failbot/handler.rb

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-require 'time'
-require 'failbot'
-
-# Reopen stderr/stdout on the logfile if enabled.
-if log_file = Failbot::config['service_log']
-  $stderr.reopen(log_file, 'ab')
-  $stdout.reopen($stderr)
-  [$stderr, $stdout].each { |fd| fd.sync = true }
-end
-warn "failbot handler #$$ starting in #{Failbot::environment} at #{Time.now.iso8601}"
-
-require 'ernie'
-require 'failbot/haystack'
-
-# The Ernie handler implementation responsible for delivering exception reports
-# to the exception backend. The report method is made available as a BERT-RPC
-# service.
-module Failbot::Handler
-  def report(data)
-    Failbot::Haystack.send_data(data)
-    true
-  end
-end
-
-Ernie.expose(:failbot, Failbot::Handler)
-
-# vim:ft=ruby

data/lib/failbot/server.rb

@@ -1,53 +0,0 @@
-require 'failbot'
-require 'tmpdir'
-
-module Failbot
-  # Interface for starting the exception relay server. This class constructs a
-  # temporary config file for ernie and starts the erlang server process.
-  class Server
-    def initialize(port=nil, tmpdir=nil)
-      @port = (port || 6666).to_i
-      @tmp = tmpdir || Dir.tmpdir
-    end
-
-    attr_reader :port
-    attr_reader :tmp
-
-    def workers
-      Failbot.config['workers'] || 1
-    end
-
-    def handler_file
-      File.expand_path('../handler.rb', __FILE__)
-    end
-
-    def pid_file
-      "#{@tmp}/failbot.#{port}.pid"
-    end
-
-    def configure
-      write_config
-      config_file
-    end
-
-    def config_file
-      "#{@tmp}/ernie.failbot.#{Failbot.environment}.cfg"
-    end
-
-    def write_config
-      File.open(config_file, 'wb') do |io|
-        io.write((<<-ERLANG).gsub(/^ {10}/, ''))
-          [{module, failbot},
-           {type, external},
-           {command, "ruby #{handler_file}"},
-           {count, #{workers}}].
-        ERLANG
-      end
-    end
-
-    def exec!
-      configure
-      exec "ernie", "-p", port.to_s, "-P", pid_file, "-d", "-c", config_file
-    end
-  end
-end