sentry-raven 1.1.0 → 1.2.0

data/lib/raven/configuration.rb

@@ -100,6 +100,9 @@ module Raven
     # Deprecated accessor
     attr_accessor :catch_debugged_exceptions
 
+    # Turns on ActiveSupport breadcrumbs integration
+    attr_accessor :rails_activesupport_breadcrumbs
+
     # Provide a configurable callback to determine event capture
     attr_accessor :should_capture
 
@@ -109,6 +112,9 @@ module Raven
     # Sanitize values that look like credit card numbers
     attr_accessor :sanitize_credit_cards
 
+    # Logger 'progname's to exclude from breadcrumbs
+    attr_accessor :exclude_loggers
+
     IGNORE_DEFAULT = [
       'AbstractController::ActionNotFound',
       'ActionController::InvalidAuthenticityToken',
@@ -137,16 +143,18 @@ module Raven
       self.processors = DEFAULT_PROCESSORS.dup
       self.ssl_verification = true
       self.encoding = 'gzip'
-      self.timeout = 1
+      self.timeout = 2
       self.open_timeout = 1
       self.proxy = nil
       self.tags = {}
       self.async = false
       self.rails_report_rescued_exceptions = true
+      self.rails_activesupport_breadcrumbs = false
       self.transport_failure_callback = false
       self.sanitize_fields = []
       self.sanitize_credit_cards = true
       self.environments = []
+      self.exclude_loggers = []
 
       self.release = detect_release
 

data/lib/raven/event.rb

@@ -31,6 +31,7 @@ module Raven
     def initialize(init = {})
       @configuration = Raven.configuration
       @interfaces    = {}
+      @breadcrumbs   = Raven.breadcrumbs
       @context       = Raven.context
       @id            = generate_event_id
       @project       = nil
@@ -224,6 +225,7 @@ module Raven
       data[:extra] = @extra if @extra
       data[:tags] = @tags if @tags
       data[:user] = @user if @user
+      data[:breadcrumbs] = @breadcrumbs.to_hash unless @breadcrumbs.empty?
       data[:checksum] = @checksum if @checksum
       @interfaces.each_pair do |name, int_data|
         data[name.to_sym] = int_data.to_hash

data/lib/raven/instance.rb

@@ -0,0 +1,223 @@
+require 'raven/base'
+require 'English'
+
+module Raven
+  # A copy of Raven's base module class methods, minus some of the integration
+  # and global hooks since it's meant to be used explicitly. Useful for
+  # sending errors to multiple sentry projects in a large application.
+  #
+  # @example
+  #   class Foo
+  #     def initialize
+  #       @other_raven = Raven::Instance.new
+  #       @other_raven.configure do |config|
+  #         config.server = 'http://...'
+  #       end
+  #     end
+  #
+  #     def foo
+  #       # ...
+  #     rescue => e
+  #       @other_raven.capture_exception(e)
+  #     end
+  #   end
+  class Instance
+    # The client object is responsible for delivering formatted data to the
+    # Sentry server. Must respond to #send. See Raven::Client.
+    attr_writer :client
+
+    # A Raven configuration object. Must act like a hash and return sensible
+    # values for all Raven configuration options. See Raven::Configuration.
+    attr_writer :configuration
+
+    def initialize(context = nil)
+      @context = @explicit_context = context
+    end
+
+    def context
+      if @explicit_context
+        @context ||= Context.new
+      else
+        Context.current
+      end
+    end
+
+    def logger
+      @logger ||= Logger.new
+    end
+
+    # The configuration object.
+    # @see Raven.configure
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # The client object is responsible for delivering formatted data to the
+    # Sentry server.
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    # Tell the log that the client is good to go
+    def report_status
+      return if client.configuration.silence_ready
+      if client.configuration.send_in_current_environment?
+        logger.info "Raven #{VERSION} ready to catch errors"
+      else
+        logger.info "Raven #{VERSION} configured not to send errors."
+      end
+    end
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   Raven.configure do |config|
+    #     config.server = 'http://...'
+    #   end
+    def configure
+      yield(configuration) if block_given?
+
+      self.client = Client.new(configuration)
+      report_status
+      client
+    end
+
+    # Send an event to the configured Sentry server
+    #
+    # @example
+    #   evt = Raven::Event.new(:message => "An error")
+    #   Raven.send_event(evt)
+    def send_event(event)
+      client.send_event(event)
+    end
+
+    # Capture and process any exceptions from the given block.
+    #
+    # @example
+    #   Raven.capture do
+    #     MyApp.run
+    #   end
+    def capture(options = {})
+      if block_given?
+        begin
+          yield
+        rescue Error
+          raise # Don't capture Raven errors
+        rescue Exception => e
+          capture_type(e, options)
+          raise
+        end
+      else
+        install_at_exit_hook(options)
+      end
+    end
+
+    def capture_type(obj, options = {})
+      return false unless should_capture?(obj)
+      message_or_exc = obj.is_a?(String) ? "message" : "exception"
+      if (evt = Event.send("from_" + message_or_exc, obj, options))
+        yield evt if block_given?
+        if configuration.async?
+          configuration.async.call(evt)
+        else
+          send_event(evt)
+        end
+        Thread.current["sentry_#{object_id}_last_event_id".to_sym] = evt.id
+        evt
+      end
+    end
+
+    def last_event_id
+      Thread.current["sentry_#{object_id}_last_event_id".to_sym]
+    end
+
+    def should_capture?(message_or_exc)
+      if configuration.should_capture
+        configuration.should_capture.call(*[message_or_exc])
+      else
+        true
+      end
+    end
+
+    # Provides extra context to the exception prior to it being handled by
+    # Raven. An exception can have multiple annotations, which are merged
+    # together.
+    #
+    # The options (annotation) is treated the same as the ``options``
+    # parameter to ``capture_exception`` or ``Event.from_exception``, and
+    # can contain the same ``:user``, ``:tags``, etc. options as these
+    # methods.
+    #
+    # These will be merged with the ``options`` parameter to
+    # ``Event.from_exception`` at the top of execution.
+    #
+    # @example
+    #   begin
+    #     raise "Hello"
+    #   rescue => exc
+    #     Raven.annotate_exception(exc, :user => { 'id' => 1,
+    #                              'email' => 'foo@example.com' })
+    #   end
+    def annotate_exception(exc, options = {})
+      notes = (exc.instance_variable_defined?(:@__raven_context) && exc.instance_variable_get(:@__raven_context)) || {}
+      notes.merge!(options)
+      exc.instance_variable_set(:@__raven_context, notes)
+      exc
+    end
+
+    # Bind user context. Merges with existing context (if any).
+    #
+    # It is recommending that you send at least the ``id`` and ``email``
+    # values. All other values are arbitrary.
+    #
+    # @example
+    #   Raven.user_context('id' => 1, 'email' => 'foo@example.com')
+    def user_context(options = nil)
+      context.user = options || {}
+    end
+
+    # Bind tags context. Merges with existing context (if any).
+    #
+    # Tags are key / value pairs which generally represent things like
+    # application version, environment, role, and server names.
+    #
+    # @example
+    #   Raven.tags_context('my_custom_tag' => 'tag_value')
+    def tags_context(options = nil)
+      context.tags.merge!(options || {})
+    end
+
+    # Bind extra context. Merges with existing context (if any).
+    #
+    # Extra context shows up as Additional Data within Sentry, and is
+    # completely arbitrary.
+    #
+    # @example
+    #   Raven.extra_context('my_custom_data' => 'value')
+    def extra_context(options = nil)
+      context.extra.merge!(options || {})
+    end
+
+    def rack_context(env)
+      env = nil if env.empty?
+
+      context.rack_env = env
+    end
+
+    def breadcrumbs
+      BreadcrumbBuffer.current
+    end
+
+    private
+
+    def install_at_exit_hook(options)
+      at_exit do
+        exception = $ERROR_INFO
+        if exception
+          logger.debug "Caught a post-mortem exception: #{exception.inspect}"
+          capture_type(exception, options)
+        end
+      end
+    end
+  end
+end

data/lib/raven/integrations/rack.rb

@@ -43,6 +43,7 @@ module Raven
     def call(env)
       # clear context at the beginning of the request to ensure a clean slate
       Context.clear!
+      BreadcrumbBuffer.clear!
 
       # store the current environment in our local context for arbitrary
       # callers

data/lib/raven/integrations/rails.rb

@@ -13,26 +13,37 @@ module Raven
       ActiveSupport.on_load :action_controller do
         include Raven::Rails::ControllerMethods
         if ::Rails::VERSION::STRING >= "4.0.0"
-          Raven.rails_safely_prepend("StreamingReporter", :to => ActionController::Live)
+          Raven.safely_prepend(
+            "StreamingReporter",
+            :from => Raven::Rails::Overrides,
+            :to => ActionController::Live
+          )
         end
       end
     end
 
     initializer 'raven.action_view' do
       ActiveSupport.on_load :action_view do
-        Raven.rails_safely_prepend("StreamingReporter", :to => ActionView::StreamingTemplateRenderer::Body)
+        Raven.safely_prepend(
+          "StreamingReporter",
+          :from => Raven::Rails::Overrides,
+          :to => ActionView::StreamingTemplateRenderer::Body
+        )
       end
     end
 
-    config.before_initialize do
+    config.after_initialize do
       Raven.configure do |config|
         config.logger ||= ::Rails.logger
         config.project_root ||= ::Rails.root
-        config.release = config.detect_release # if project_root has changed, need to re-check
+        config.release ||= config.detect_release # if project_root has changed, need to re-check
+      end
+
+      if Raven.configuration.rails_activesupport_breadcrumbs
+        require 'raven/breadcrumbs/activesupport'
+        Raven::ActiveSupportBreadcrumbs.inject
       end
-    end
 
-    config.after_initialize do
       if Raven.configuration.rails_report_rescued_exceptions
         require 'raven/integrations/rails/overrides/debug_exceptions_catcher'
         if defined?(::ActionDispatch::DebugExceptions)
@@ -40,7 +51,12 @@ module Raven
         elsif defined?(::ActionDispatch::ShowExceptions)
           exceptions_class = ::ActionDispatch::ShowExceptions
         end
-        Raven.rails_safely_prepend("DebugExceptionsCatcher", :to => exceptions_class)
+
+        Raven.safely_prepend(
+          "DebugExceptionsCatcher",
+          :from => Raven::Rails::Overrides,
+          :to => exceptions_class
+        )
       end
     end
 

data/lib/raven/logger.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
+require 'logger'
+
 module Raven
   class Logger
     LOG_PREFIX = "** [Raven] ".freeze
 
+    LEVELS = {
+      :debug => ::Logger::DEBUG,
+      :info => ::Logger::INFO,
+      :warn => ::Logger::WARN,
+      :error => ::Logger::ERROR,
+      :fatal => ::Logger::FATAL
+    }.freeze
+
     [
       :fatal,
       :error,
@@ -16,7 +26,7 @@ module Raven
         logger = Raven.configuration[:logger]
         logger = ::Logger.new(STDOUT) if logger.nil?
 
-        logger.send(level, "#{LOG_PREFIX}#{msg}") if logger
+        logger.add(LEVELS[level], "#{LOG_PREFIX}#{msg}", "sentry") if logger
       end
     end
   end

data/lib/raven/processor/sanitizedata.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'json'
+
 module Raven
   class Processor::SanitizeData < Processor
     STRING_MASK = '********'.freeze
@@ -72,8 +73,8 @@ module Raven
 
     def parse_json_or_nil(string)
       begin
-        OkJson.decode(string)
-      rescue Raven::OkJson::Error, NoMethodError
+        JSON.parse(string)
+      rescue JSON::ParserError, NoMethodError
         nil
       end
     end

data/lib/raven/transports/http.rb

@@ -18,13 +18,11 @@ module Raven
         project_id = configuration[:project_id]
         path = configuration[:path] + "/"
 
-        response = conn.post "#{path}api/#{project_id}/store/" do |req|
+        conn.post "#{path}api/#{project_id}/store/" do |req|
           req.headers['Content-Type'] = options[:content_type]
           req.headers['X-Sentry-Auth'] = auth_header
           req.body = data
         end
-        Raven.logger.warn "Error from Sentry server (#{response.status}): #{response.body}" unless response.status == 200
-        response
       end
 
       private
@@ -42,6 +40,7 @@ module Raven
           :url => configuration[:server],
           :ssl => ssl_configuration
         ) do |builder|
+          builder.response :raise_error
           builder.adapter(*adapter)
         end
 

data/lib/raven/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 module Raven
-  VERSION = "1.1.0".freeze
+  # Freezing this constant breaks in 1.9.x
+  VERSION = "1.2.0" # rubocop:disable Style/MutableConstant
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.10.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.10.x
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +48,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.41.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +86,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  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'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  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'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -149,12 +127,16 @@ files:
 - lib/raven.rb
 - lib/raven/backtrace.rb
 - lib/raven/base.rb
+- lib/raven/breadcrumbs.rb
+- lib/raven/breadcrumbs/activesupport.rb
+- lib/raven/breadcrumbs/logger.rb
 - lib/raven/cli.rb
 - lib/raven/client.rb
 - lib/raven/configuration.rb
 - lib/raven/context.rb
 - lib/raven/error.rb
 - lib/raven/event.rb
+- lib/raven/instance.rb
 - lib/raven/integrations/delayed_job.rb
 - lib/raven/integrations/rack.rb
 - lib/raven/integrations/rails.rb
@@ -174,7 +156,6 @@ files:
 - lib/raven/interfaces/stack_trace.rb
 - lib/raven/linecache.rb
 - lib/raven/logger.rb
-- lib/raven/okjson.rb
 - lib/raven/processor.rb
 - lib/raven/processor/cookies.rb
 - lib/raven/processor/post_data.rb
@@ -214,4 +195,3 @@ signing_key:
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger
 test_files: []
-has_rdoc: true