honeybadger 1.7.0 → 1.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbb055f81d8f22c73d15a07319416223dc2088e8
+  data.tar.gz: 97d3c1ea643d868e725df494d10710bf353a0cd0
+SHA512:
+  metadata.gz: b59eabe45dd37a73fbc3f5977e1991c84b976b7907d908d6058849d953fca3df3b13c8678e1c1a18fb121854df7d067ec59224e936a9382219fc651bd717c345
+  data.tar.gz: 851867be99923a9b115fde0a06934dae4fe04b4424038c41da5b70cb10e625014298aef0ad9475c891b8482fa44705d8625d7602b13848abb787dad3287b3c4b

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## Honeybadger 1.8.0 ##
+
+* Report memory and load stats
+
+  *Benjamin Curtis*
+
+* Use HONEYBADGER_API_KEY as default value for api_key
+
+  *Benjamin Curtis*
+
+* Prefer notice args to exception attributes
+
+  *Joshua Wood*
+
+* Trim size of notice message to 1k
+
+  *Joshua Wood*
+
+* Make hostname overridable in configuration.
+
+  *Joshua Wood*
+
 ## Honeybadger 1.7.0 ##
 
 * Added a custom grouping option

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeybadger (1.7.0)
+    honeybadger (1.8.0)
       json
 
 GEM

data/MIT-LICENSE

@@ -1,5 +1,6 @@
 Copyright (c) 2007 - 2012, Exceptional DBA Airbrake.io
 Portions Copyright (c) 2012-2013, Honeybadger Industries LLC
+Portions Copyright (c) 2009 Brenton Fletcher (http://i.bloople.net i@bloople.net)
 
 NOTE: All code contained herein that is copyright Exceptional DBA Airbrake.io was available
 under the MIT license (listed below) on or before November 6, 2012. 

data/README.md

@@ -541,6 +541,19 @@ Honeybadger.configure do |config|
 end
 ```
 
+## Setting the hostname
+
+The hostname for the local server is determined by `Socket.gethostname`
+by default, but can be overridden using the `hostname` configuration
+option:
+
+```ruby
+Honeybadger.configure do |config|
+  # ...
+  config.hostname = `hostname`
+end
+```
+
 ## Testing
 
 When you run your tests, you might notice that the Honeybadger service is recording

data/gemfiles/rack.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/gemfiles/rails2.3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/gemfiles/rails3.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/gemfiles/rails3.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/gemfiles/rails3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/gemfiles/rails4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/gemfiles/rake.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/gemfiles/sinatra.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/josh/code/honeybadger-ruby
   specs:
-    honeybadger (1.6.2)
+    honeybadger (1.8.0)
       json
 
 GEM

data/honeybadger.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'honeybadger'
-  s.version           = '1.7.0'
-  s.date              = '2013-06-07'
+  s.version           = '1.8.0'
+  s.date              = '2013-08-14'
 
   s.summary     = 'Error reports you can be happy about.'
   s.description = 'Make managing application errors a more pleasant experience.'
@@ -98,6 +98,7 @@ Gem::Specification.new do |s|
     lib/honeybadger/rake_handler.rb
     lib/honeybadger/sender.rb
     lib/honeybadger/shared_tasks.rb
+    lib/honeybadger/stats.rb
     lib/honeybadger/tasks.rb
     lib/honeybadger_tasks.rb
     lib/rails/generators/honeybadger/honeybadger_generator.rb

data/lib/honeybadger.rb

@@ -9,11 +9,12 @@ require 'honeybadger/backtrace'
 require 'honeybadger/notice'
 require 'honeybadger/rack'
 require 'honeybadger/sender'
+require 'honeybadger/stats'
 
 require 'honeybadger/railtie' if defined?(Rails::Railtie)
 
 module Honeybadger
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
   LOG_PREFIX = "** [Honeybadger] "
 
   HEADERS = {
@@ -129,9 +130,12 @@ module Honeybadger
       result
     end
 
-    def context(hash = {})
-      Thread.current[:honeybadger_context] ||= {}
-      Thread.current[:honeybadger_context].merge!(hash)
+    def context(hash = nil)
+      unless hash.nil?
+        Thread.current[:honeybadger_context] ||= {}
+        Thread.current[:honeybadger_context].merge!(hash)
+      end
+
       self
     end
 

data/lib/honeybadger/configuration.rb

@@ -6,7 +6,7 @@ module Honeybadger
                :params_filters, :project_root, :port, :protocol, :proxy_host, :proxy_pass,
                :proxy_port, :proxy_user, :secure, :use_system_ssl_cert_chain, :framework,
                :user_information, :rescue_rake_exceptions, :source_extract_radius,
-               :send_request_session, :debug, :fingerprint].freeze
+               :send_request_session, :debug, :fingerprint, :hostname].freeze
 
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
@@ -104,6 +104,9 @@ module Honeybadger
     # A Proc object used to generate optional fingerprint
     attr_writer :fingerprint
 
+    # Override the hostname of the local server (optional)
+    attr_accessor :hostname
+
     DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
 
     DEFAULT_BACKTRACE_FILTERS = [
@@ -137,6 +140,7 @@ module Honeybadger
     alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
 
     def initialize
+      @api_key                   = ENV['HONEYBADGER_API_KEY']
       @secure                    = true
       @use_system_ssl_cert_chain = false
       @host                      = 'api.honeybadger.io'
@@ -157,6 +161,7 @@ module Honeybadger
       @source_extract_radius     = 2
       @send_request_session      = true
       @debug                     = false
+      @hostname                  = nil
     end
 
     # Public: Takes a block and adds it to the list of backtrace filters. When

data/lib/honeybadger/notice.rb

@@ -79,6 +79,9 @@ module Honeybadger
     # The host name where this error occurred (if any)
     attr_reader :hostname
 
+    # System stats
+    attr_reader :stats
+
     def initialize(args)
       self.args         = args
       self.exception    = args[:exception]
@@ -105,11 +108,14 @@ module Honeybadger
       self.backtrace        = Backtrace.parse(exception_attribute(:backtrace, caller), :filters => self.backtrace_filters)
       self.fingerprint      = hashed_fingerprint
       self.error_class      = exception_attribute(:error_class) {|exception| exception.class.name }
-      self.error_message    = exception_attribute(:error_message, 'Notification') do |exception|
-        "#{exception.class.name}: #{exception.message}"
+      self.error_message    = trim_size(1024) do
+        exception_attribute(:error_message, 'Notification') do |exception|
+          "#{exception.class.name}: #{exception.message}"
+        end
       end
 
       self.hostname         = local_hostname
+      self.stats            = Stats.all
 
       self.source_extract_radius = args[:source_extract_radius] || 2
       self.source_extract        = extract_source_from_backtrace
@@ -162,7 +168,8 @@ module Honeybadger
         :server => {
           :project_root => project_root,
           :environment_name => environment_name,
-          :hostname => hostname
+          :hostname => hostname,
+          :stats => stats
         }
       }
     end
@@ -223,21 +230,24 @@ module Honeybadger
       :error_message, :backtrace_filters, :parameters, :params_filters,
       :environment_filters, :session_data, :project_root, :url, :ignore,
       :ignore_by_filters, :notifier_name, :notifier_url, :notifier_version,
-      :component, :action, :cgi_data, :environment_name, :hostname, :context,
+      :component, :action, :cgi_data, :environment_name, :hostname, :stats, :context,
       :source_extract, :source_extract_radius, :send_request_session
 
     # Private: Arguments given in the initializer
     attr_accessor :args
 
-    # Private: Gets a property named +attribute+ of an exception, either from an actual
-    # exception or a hash.
+    # Internal: Gets a property named "attribute" of an exception, either from
+    # the #args hash or actual exception (in order of precidence)
     #
-    # If an exception is available, #from_exception will be used. Otherwise,
-    # a key named +attribute+ will be used from the #args.
+    # attribute - A Symbol existing as a key in #args and/or attribute on
+    #             Exception
+    # default   - Default value if no other value is found. (optional)
+    # block     - An optional block which receives an Exception and returns the
+    #             desired value
     #
-    # If no exception or hash key is available, +default+ will be used.
+    # Returns attribute value from args or exception, otherwise default
     def exception_attribute(attribute, default = nil, &block)
-      (exception && from_exception(attribute, &block)) || args[attribute] || default
+      args[attribute] || (exception && from_exception(attribute, &block)) || default
     end
 
     # Private: Gets a property named +attribute+ from an exception.
@@ -324,7 +334,7 @@ module Honeybadger
         # ActionView::Template::Error has its own source_extract method.
         # If present, use that instead.
         if exception.respond_to?(:source_extract)
-          Hash[exception_attribute(:source_extract).split("\n").map do |line|
+          Hash[exception.source_extract.split("\n").map do |line|
             parts = line.split(': ')
             [parts[0].strip, parts[1] || '']
           end]
@@ -398,7 +408,30 @@ module Honeybadger
     end
 
     def local_hostname
-      Socket.gethostname
+      args[:hostname] || Socket.gethostname
+    end
+
+    # Internal: Limit size of string to bytes
+    #
+    # input - The String to be trimmed.
+    # bytes - The Integer bytes to trim.
+    # block - An optional block used in place of input.
+    #
+    # Examples
+    #
+    #   trimmed = trim_size("Honeybadger doesn't care", 3)
+    #
+    #   trimmed = trim_size(3) do
+    #     "Honeybadger doesn't care"
+    #   end
+    #
+    # Returns trimmed String
+    def trim_size(*args, &block)
+      input, bytes = args.first, args.last
+      input = yield if block_given?
+      input = input.dup
+      input = input[0...bytes] if input.respond_to?(:size) && input.size > bytes
+      input
     end
   end
 end

data/lib/honeybadger/stats.rb

@@ -0,0 +1,29 @@
+module Honeybadger
+  class Stats
+    HAS_MEM = File.exists?("/proc/meminfo")
+    HAS_LOAD = File.exists?("/proc/loadavg")
+
+    class << self
+      def all
+        { :mem => memory, :load => load }
+      end
+
+      # From https://github.com/bloopletech/webstats/blob/master/server/data_providers/mem_info.rb
+      def memory
+        out = {}
+        if HAS_MEM
+          out[:total], out[:free], out[:buffers], out[:cached] = IO.readlines("/proc/meminfo")[0..4].map { |l| l =~ /^.*?\: +(.*?) kB$/; $1.to_i / 1024.0 }
+          out[:free_total] = out[:free] + out[:buffers] + out[:cached]
+        end
+        out
+      end
+
+      # From https://github.com/bloopletech/webstats/blob/master/server/data_providers/cpu_info.rb
+      def load
+        out = {}
+        out[:one], out[:five], out[:fifteen] = IO.read("/proc/loadavg").split(' ', 4).map(&:to_f) if HAS_LOAD
+        out
+      end
+    end
+  end
+end

data/test/unit/configuration_test.rb

@@ -30,6 +30,7 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_config_default :send_request_session, true
     assert_config_default :debug, false
     assert_config_default :fingerprint, nil
+    assert_config_default :hostname, nil
   end
 
   should "configure async as Proc" do
@@ -110,6 +111,7 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_config_overridable :fingerprint
     assert_config_overridable :send_request_session
     assert_config_overridable :debug
+    assert_config_overridable :hostname
   end
 
   should "have an api key" do
@@ -124,7 +126,8 @@ class ConfigurationTest < Test::Unit::TestCase
      :ignore_by_filters, :ignore_user_agent, :notifier_name, :notifier_url,
      :notifier_version, :params_filters, :project_root, :port, :protocol,
      :proxy_host, :proxy_pass, :proxy_port, :proxy_user, :secure,
-     :source_extract_radius, :async, :send_request_session, :debug, :fingerprint].each do |option|
+     :source_extract_radius, :async, :send_request_session, :debug,
+     :fingerprint, :hostname].each do |option|
        assert_equal config[option], hash[option], "Wrong value for #{option}"
     end
   end

data/test/unit/notice_test.rb

@@ -92,6 +92,11 @@ class NoticeTest < Test::Unit::TestCase
     assert_equal hostname, notice.hostname
   end
 
+  should "override the host name" do
+    notice = build_notice({ :hostname => 'asdf' })
+    assert_equal 'asdf', notice.hostname
+  end
+
   context "custom fingerprint" do
     should "include nil fingerprint when no fingerprint is specified" do
       notice = build_notice
@@ -510,6 +515,21 @@ class NoticeTest < Test::Unit::TestCase
     assert_equal "[possible infinite recursion halted]", notice.parameters[:hash]
   end
 
+  should "trim error message to 1k" do
+    message = 'asdfghjkl'*200
+    e = StandardError.new(message)
+    notice = Honeybadger::Notice.new(:exception => e)
+    assert_operator 1024, :<, message.bytesize
+    assert_equal 1024, notice.error_message.bytesize
+  end
+
+  should "prefer notice args to exception attributes" do
+    e = RuntimeError.new('Not very helpful')
+    notice = Honeybadger::Notice.new(:exception => e, :error_class => 'MyClass', :error_message => 'Something very specific went wrong.')
+    assert_equal 'MyClass', notice.error_class
+    assert_equal 'Something very specific went wrong.', notice.error_message
+  end
+
   def assert_accepts_exception_attribute(attribute, args = {}, &block)
     exception = build_exception
     block ||= lambda { exception.send(attribute) }

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 1.7.0
-  prerelease: 
+  version: 1.8.0
 platform: ruby
 authors:
 - Joshua Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sham_rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,23 +83,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bourne
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,81 +111,71 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Make managing application errors a more pleasant experience.
@@ -271,6 +246,7 @@ files:
 - lib/honeybadger/rake_handler.rb
 - lib/honeybadger/sender.rb
 - lib/honeybadger/shared_tasks.rb
+- lib/honeybadger/stats.rb
 - lib/honeybadger/tasks.rb
 - lib/honeybadger_tasks.rb
 - lib/rails/generators/honeybadger/honeybadger_generator.rb
@@ -292,6 +268,7 @@ files:
 - test/unit/sender_test.rb
 homepage: http://www.honeybadger.io
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
@@ -299,23 +276,18 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2239778721023369939
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 2
 summary: Error reports you can be happy about.