sentry-raven 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d53252f2dcacc37eaa626b7b91c244349ae8032
-  data.tar.gz: 16db0fcdac70b75df576a2296cefb9abb29cf661
+  metadata.gz: 7d602b648b5c1c87ce074dc68be686aeca0b6752
+  data.tar.gz: c6c6219649f4e8ab1f2c015f3ce6eac40ee51a39
 SHA512:
-  metadata.gz: b1a5d740487dca1c2b6c4a0e67d0c4d2e6292a4a7d32fe3751ca7413e4819c576ada5b0111acf7112f917c682f0e9d718b8b9e941adc7d24500b4f37bedf30ad
-  data.tar.gz: 8c8dc7a2c659c85ec8f00f2becf1f744312f775891cad58058114631af2374c2c95c45aa8bead8d0c14aee30549b0842d3c579ed322231ec0db8b61cf91766d6
+  metadata.gz: eed297ddb38d1321c24c5abde706eb899d185de9fb3d3650679201e4cabe45a6594623ef9117e3df9c68ad857952d1a23701f66ab7af6ced344718a6cf798dcc
+  data.tar.gz: 1143923e646e592a227a86fdbe962d93abe366c381bda6b23dff9dbd5b1b1cfef42ef8c00e4682babdaa3752e8338c9cae2960dd6d7ee6718eae9e9f3c89fde4

data/README.md

@@ -7,7 +7,7 @@ A client and integration layer for the [Sentry](https://github.com/getsentry/sen
 
 ## Requirements
 
-We test on Ruby 1.9, 2.2 and 2.3 at the latest patchlevel/teeny version. Our Rails integration works with Rails 4.2+. JRuby support is experimental - check TravisCI to see if the build is passing or failing.
+We test on Ruby 1.9, 2.2 and 2.3 at the latest patchlevel/teeny version. We also support JRuby 1.7 and 9.0. Our Rails integration works with Rails 4.2+.
 
 ## Getting Started
 
@@ -57,6 +57,89 @@ rescue ZeroDivisionError => exception
 end
 ```
 
+### More configuration
+
+You're all set - but there's a few more settings you may want to know about too!
+
+#### DSN
+
+While we advise that you set your Sentry DSN through the `SENTRY_DSN` environment
+variable, there are two other configuration settings for controlling Raven:
+
+```ruby
+# DSN can be configured as a config setting instead.
+# Place in config/initializers or similar.
+Raven.configure do |config|
+  config.dsn = 'your_dsn'
+end
+```
+
+And, while not necessary if using `SENTRY_DSN`, you can also provide an `environments`
+setting. Raven will only capture events when `RACK_ENV` or `RAILS_ENV` matches
+an environment in the list.
+
+```ruby
+Raven.configure do |config|
+  config.environments = %w[staging production]
+end
+```
+
+#### async
+
+When an error or message occurs, the notification is immediately sent to Sentry. Raven can be configured to send asynchronously:
+
+```ruby
+config.async = lambda { |event|
+  Thread.new { Raven.send_event(event) }
+}
+```
+
+Using a thread to send events will be adequate for truly parallel Ruby platforms such as JRuby, though the benefit on MRI/CRuby will be limited. If the async callback raises an exception, Raven will attempt to send synchronously.
+
+We recommend creating a background job, using your background job processor, that will send Sentry notifications in the background. Rather than enqueuing an entire Raven::Event object, we recommend providing the Hash representation of an event as a job argument. Here’s an example for ActiveJob:
+
+```ruby
+config.async = lambda { |event|
+  SentryJob.perform_later(event.to_hash)
+}
+class SentryJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(event)
+    Raven.send_event(event)
+  end
+end
+```
+
+#### transport_failure_callback
+
+If Raven fails to send an event to Sentry for any reason (either the Sentry server has returned a 4XX or 5XX response), this Proc or lambda will be called.
+
+```ruby
+config.transport_failure_callback = lambda { |event|
+  AdminMailer.email_admins("Oh god, it's on fire!", event).deliver_later
+}
+```
+
+#### Context
+
+Much of the usefulness of Sentry comes from additional context data with the events. Raven makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events.
+
+There are three primary methods for providing request context:
+
+```ruby
+# bind the logged in user
+Raven.user_context email: 'foo@example.com'
+
+# tag the request with something interesting
+Raven.tags_context interesting: 'yes'
+
+# provide a bit of additional context
+Raven.extra_context happiness: 'very'
+```
+
+For more information, see [Context](https://docs.sentry.io/clients/ruby/context/).
+
 ## More Information
 
 * [Documentation](https://docs.getsentry.com/hosted/clients/ruby/)

data/lib/raven/base.rb

@@ -92,8 +92,9 @@ module Raven
     end
 
     def sys_command(command)
-      result = `#{command}` rescue nil
-      result.strip if result != "" && result
+      result = `#{command} 2>&1` rescue nil
+      return if result.nil? || result.empty? || $CHILD_STATUS.exitstatus != 0
+      result.strip
     end
   end
 end

data/lib/raven/cli.rb

@@ -23,8 +23,6 @@ module Raven
         Raven.configuration.current_environment = env_name
       end
 
-      Raven.configuration.verify!
-
       Raven.logger.debug "Sending a test event:"
       Raven.logger.debug ""
 

data/lib/raven/client.rb

@@ -32,7 +32,7 @@ module Raven
         return
       end
 
-      Raven.logger.debug "Sending event #{event[:event_id]} to Sentry"
+      configuration.logger.debug "Sending event #{event[:event_id]} to Sentry"
 
       content_type, encoded_data = encode(event)
 
@@ -97,12 +97,12 @@ module Raven
     def failed_send(e, event)
       @state.failure
       if e # exception was raised
-        Raven.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message})"
-        e.backtrace[0..10].each { |line| Raven.logger.error(line) }
+        configuration.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message})"
+        e.backtrace[0..10].each { |line| configuration.logger.error(line) }
       else
-        Raven.logger.error "Not sending event due to previous failure(s)."
+        configuration.logger.error "Not sending event due to previous failure(s)."
       end
-      Raven.logger.error("Failed to submit event: #{get_log_message(event)}")
+      configuration.logger.error("Failed to submit event: #{get_log_message(event)}")
       configuration.transport_failure_callback.call(event) if configuration.transport_failure_callback
     end
   end

data/lib/raven/configuration.rb

@@ -38,6 +38,11 @@ module Raven
     # The Faraday adapter to be used. Will default to Net::HTTP when not set.
     attr_accessor :http_adapter
 
+    # You may provide your own LineCache for matching paths with source files.
+    # This may be useful if you need to get source code from places other than
+    # the disk. See Raven::LineCache for the required interface you must implement.
+    attr_accessor :linecache
+
     # Logger used by Raven. In Rails, this is the Rails logger, otherwise
     # Raven provides its own Raven::Logger.
     attr_accessor :logger
@@ -138,6 +143,9 @@ module Raven
     # E.g. lambda { |event| Thread.new { MyJobProcessor.send_email(event) } }
     attr_reader :transport_failure_callback
 
+    # Errors object - an Array that contains error messages. See #
+    attr_reader :errors
+
     IGNORE_DEFAULT = [
       'AbstractController::ActionNotFound',
       'ActionController::InvalidAuthenticityToken',
@@ -160,6 +168,8 @@ module Raven
       Raven::Processor::HTTPHeaders
     ].freeze
 
+    LOG_PREFIX = "** [Raven] ".freeze
+
     def initialize
       self.async = false
       self.context_lines = 3
@@ -168,6 +178,8 @@ module Raven
       self.environments = []
       self.exclude_loggers = []
       self.excluded_exceptions = IGNORE_DEFAULT.dup
+      self.linecache = ::Raven::LineCache.new
+      self.logger = ::Raven::Logger.new(STDOUT)
       self.open_timeout = 1
       self.processors = DEFAULT_PROCESSORS.dup
       self.proxy = nil
@@ -248,17 +260,21 @@ module Raven
     end
 
     def capture_allowed?(message_or_exc = nil)
-      capture_in_current_environment? &&
-        capture_allowed_by_callback?(message_or_exc)
+      @errors = []
+      @errors = valid? +
+                capture_in_current_environment? +
+                capture_allowed_by_callback?(message_or_exc)
+      if @errors.any?
+        false
+      else
+        true
+      end
     end
-
     # If we cannot capture, we cannot send.
     alias sending_allowed? capture_allowed?
 
-    def verify!
-      %w(server public_key secret_key project_id).each do |key|
-        raise(Error, "No #{key} specified") unless public_send key
-      end
+    def error_messages
+      errors.join(", ")
     end
 
     def project_root=(root_dir)
@@ -283,7 +299,7 @@ module Raven
         hash = JSON.parse(sys_dyno_info)
         hash && hash["release"] && hash["release"]["commit"]
       rescue JSON::JSONError
-        Raven.logger.error "Cannot parse Heroku JSON: #{sys_dyno_info}"
+        logger.error "Cannot parse Heroku JSON: #{sys_dyno_info}"
       end
     end
 
@@ -299,12 +315,23 @@ module Raven
     end
 
     def capture_in_current_environment?
-      !!server && (environments.empty? || environments.include?(current_environment))
+      if environments.any? && !environments.include?(current_environment)
+        ["Not configured to send/capture in environment '#{current_environment}'"]
+      else
+        []
+      end
     end
 
     def capture_allowed_by_callback?(message_or_exc)
-      return true if !should_capture || message_or_exc.nil?
-      should_capture.call(*[message_or_exc])
+      return [] if !should_capture || message_or_exc.nil? || should_capture.call(*[message_or_exc])
+      ["should_capture returned false"]
+    end
+
+    def valid?
+      err = %w(server host path public_key secret_key project_id).map do |key|
+        "No #{key} specified" unless public_send(key)
+      end
+      err.compact
     end
 
     # Try to resolve the hostname to an FQDN, but fall back to whatever

data/lib/raven/event.rb

@@ -26,13 +26,14 @@ module Raven
     attr_accessor :id, :timestamp, :time_spent, :level, :logger,
                   :culprit, :server_name, :release, :modules, :extra, :tags,
                   :context, :configuration, :checksum, :fingerprint, :environment,
-                  :server_os, :runtime, :breadcrumbs, :user, :backtrace
+                  :server_os, :runtime, :breadcrumbs, :user, :backtrace, :linecache
 
     def initialize(init = {})
-      @configuration = Raven.configuration
+      @configuration = init[:configuration] || Raven.configuration
       @interfaces    = {}
-      @breadcrumbs   = Raven.breadcrumbs
-      @context       = Raven.context
+      @breadcrumbs   = init[:breadcrumbs] || Raven.breadcrumbs
+      @context       = init[:context] || Raven.context
+      @linecache     = @configuration.linecache
       @id            = SecureRandom.uuid.delete("-")
       @timestamp     = Time.now.utc
       @time_spent    = nil
@@ -95,11 +96,11 @@ module Raven
         configuration = options[:configuration] || Raven.configuration
         if exc.is_a?(Raven::Error)
           # Try to prevent error reporting loops
-          Raven.logger.info "Refusing to capture Raven error: #{exc.inspect}"
+          configuration.logger.info "Refusing to capture Raven error: #{exc.inspect}"
           return nil
         end
         if configuration[:excluded_exceptions].any? { |x| get_exception_class(x) === exc }
-          Raven.logger.info "User excluded error: #{exc.inspect}"
+          configuration.logger.info "User excluded error: #{exc.inspect}"
           return nil
         end
 
@@ -213,10 +214,6 @@ module Raven
 
         evt.culprit = evt.get_culprit(int.frames)
       end
-
-      # Because linecache can go to hell
-      def _source_lines(_path, _from, _to)
-      end
     end
 
     def list_gem_specs
@@ -270,11 +267,7 @@ module Raven
     end
 
     def get_file_context(filename, lineno, context)
-      return nil, nil, nil unless Raven::LineCache.valid_file?(filename)
-      lines = Array.new(2 * context + 1) do |i|
-        Raven::LineCache.getline(filename, lineno - context + i)
-      end
-      [lines[0..(context - 1)], lines[context], lines[(context + 1)..-1]]
+      linecache.get_file_context(filename, lineno, context)
     end
 
     def get_culprit(frames)

data/lib/raven/instance.rb

@@ -19,16 +19,15 @@ module Raven
   #     end
   #   end
   class Instance
-    # The client object is responsible for delivering formatted data to the
-    # Sentry server. Must respond to #send. See Raven::Client.
+    # 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
+    # See Raven::Configuration.
+    attr_accessor :configuration
 
-    def initialize(context = nil)
+    def initialize(context = nil, config = nil)
       @context = @explicit_context = context
+      self.configuration = config || Configuration.new
     end
 
     def context
@@ -40,13 +39,7 @@ module Raven
     end
 
     def logger
-      @logger ||= Logger.new
-    end
-
-    # The configuration object.
-    # @see Raven.configure
-    def configuration
-      @configuration ||= Configuration.new
+      configuration.logger
     end
 
     # The client object is responsible for delivering formatted data to the
@@ -61,7 +54,7 @@ module Raven
       if configuration.capture_allowed?
         logger.info "Raven #{VERSION} ready to catch errors"
       else
-        logger.info "Raven #{VERSION} configured not to capture errors."
+        logger.info "Raven #{VERSION} configured not to capture errors: #{configuration.error_messages}"
       end
     end
 
@@ -111,11 +104,13 @@ module Raven
 
     def capture_type(obj, options = {})
       unless configuration.capture_allowed?(obj)
-        Raven.logger.debug("#{obj} excluded from capture due to environment or should_capture callback")
+        logger.debug("#{obj} excluded from capture: #{configuration.error_messages}")
         return false
       end
 
       message_or_exc = obj.is_a?(String) ? "message" : "exception"
+      options[:configuration] = configuration
+      options[:context] = context
       if (evt = Event.send("from_" + message_or_exc, obj, options))
         yield evt if block_given?
         if configuration.async?
@@ -124,7 +119,7 @@ module Raven
             # processors (esp ActiveJob) may not like weird types in the event hash
             configuration.async.call(evt.to_json_compatible)
           rescue => ex
-            Raven.logger.error("async event sending failed: #{ex.message}")
+            logger.error("async event sending failed: #{ex.message}")
             send_event(evt)
           end
         else
@@ -135,6 +130,9 @@ module Raven
       end
     end
 
+    alias capture_message capture_type
+    alias capture_exception capture_type
+
     def last_event_id
       Thread.current["sentry_#{object_id}_last_event_id".to_sym]
     end

data/lib/raven/integrations/rack-timeout.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Style/FileName
 # We need to do this because of the way integration loading works
 require "rack/timeout/base"
 

data/lib/raven/linecache.rb

@@ -1,27 +1,41 @@
 module Raven
   class LineCache
-    class << self
-      CACHE = {} # rubocop:disable Style/MutableConstant
+    def initialize
+      @cache = {}
+    end
 
-      def valid_file?(path)
-        lines = getlines(path)
-        !lines.nil?
+    # Any linecache you provide to Raven must implement this method.
+    # Returns an Array of Strings representing the lines in the source
+    # file. The number of lines retrieved is (2 * context) + 1, the middle
+    # line should be the line requested by lineno. See specs for more information.
+    def get_file_context(filename, lineno, context)
+      return nil, nil, nil unless valid_path?(filename)
+      lines = Array.new(2 * context + 1) do |i|
+        getline(filename, lineno - context + i)
       end
+      [lines[0..(context - 1)], lines[context], lines[(context + 1)..-1]]
+    end
 
-      def getlines(path)
-        CACHE[path] ||= begin
-          IO.readlines(path)
-        rescue
-          nil
-        end
-      end
+    private
 
-      def getline(path, n)
-        return nil if n < 1
-        lines = getlines(path)
-        return nil if lines.nil?
-        lines[n - 1]
+    def valid_path?(path)
+      lines = getlines(path)
+      !lines.nil?
+    end
+
+    def getlines(path)
+      @cache[path] ||= begin
+        IO.readlines(path)
+      rescue
+        nil
       end
     end
+
+    def getline(path, n)
+      return nil if n < 1
+      lines = getlines(path)
+      return nil if lines.nil?
+      lines[n - 1]
+    end
   end
 end

data/lib/raven/logger.rb

@@ -2,25 +2,16 @@
 require 'logger'
 
 module Raven
-  class Logger
+  class Logger < ::Logger
     LOG_PREFIX = "** [Raven] ".freeze
+    PROGNAME   = "sentry".freeze
 
-    [
-      :fatal,
-      :error,
-      :warn,
-      :info,
-      :debug
-    ].each do |level|
-      define_method level do |*args, &block|
-        logger = Raven.configuration[:logger]
-        logger = ::Logger.new(STDOUT) if logger.nil?
-        return unless logger
-
-        msg = args[0] # Block-level default args is a 1.9 feature
-        msg ||= block.call if block
-
-        logger.send(level, "sentry") { "#{LOG_PREFIX}#{msg}" }
+    def initialize(*)
+      super
+      original_formatter = ::Logger::Formatter.new
+      @default_formatter = proc do |severity, datetime, _progname, msg|
+        msg = "#{LOG_PREFIX}#{msg}"
+        original_formatter.call(severity, datetime, PROGNAME, msg)
       end
     end
   end

data/lib/raven/processor/sanitizedata.rb

@@ -15,6 +15,7 @@ module Raven
     end
 
     def process(value)
+      return value if value.frozen?
       value.each_with_object(value) { |(k, v), memo| memo[k] = sanitize(k, v) }
     end
 

data/lib/raven/transports.rb

@@ -12,12 +12,6 @@ module Raven
       def send_event # (auth_header, data, options = {})
         raise NotImplementedError, 'Abstract method not implemented'
       end
-
-      protected
-
-      def verify_configuration
-        configuration.verify!
-      end
     end
   end
 end

data/lib/raven/transports/http.rb

@@ -15,6 +15,10 @@ module Raven
       end
 
       def send_event(auth_header, data, options = {})
+        unless configuration.sending_allowed?
+          logger.debug("Event not sent: #{configuration.error_messages}")
+        end
+
         project_id = configuration[:project_id]
         path = configuration[:path] + "/"
 
@@ -24,15 +28,15 @@ module Raven
           req.body = data
         end
       rescue Faraday::ClientError => ex
-        raise Raven::Error, ex.message
+        error_info = ex.message
+        error_info += " Error in headers is: #{ex.response[:headers]['x-sentry-error']}" if ex.response[:headers]['x-sentry-error']
+        raise Raven::Error, error_info
       end
 
       private
 
       def set_conn
-        verify_configuration
-
-        Raven.logger.debug "Raven HTTP Transport connecting to #{configuration.server}"
+        configuration.logger.debug "Raven HTTP Transport connecting to #{configuration.server}"
 
         ssl_configuration = configuration.ssl || {}
         ssl_configuration[:verify] = configuration.ssl_verification

data/lib/raven/utils/deep_merge.rb

@@ -1,3 +1,4 @@
+# rubocop:disable all
 module Raven
   module Utils
     # ported from ActiveSupport
@@ -26,3 +27,4 @@ module Raven
     end
   end
 end
+# rubocop:enable all

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Raven
   # Freezing this constant breaks in 1.9.x
-  VERSION = "2.1.4" # rubocop:disable Style/MutableConstant
+  VERSION = "2.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: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: 0.7.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.x
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.7.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.x
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement