airbrake-ruby 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef793e3a5a123860495003999ff322f5272a0eb1
-  data.tar.gz: 8d7e363516e3db624ca4944b4857e1e53038faa5
+  metadata.gz: d9434113b46be898d421f70cba2eb683fc5fdc1a
+  data.tar.gz: d9f06c9d709dbc0c11c5210d52b7f2d3ca030e27
 SHA512:
-  metadata.gz: f33dab2de0022cd34ee28b3d08746e5136f577af9148fcbbdfb5cf08dbde0f6224e122e8a371b6b145d131fe39d5bcd5fb99bc7a98cdbaef59d5b131c27f2666
-  data.tar.gz: 8119742353a0f1596cff32c453f100d4c3af846bde52183875fc00dadee96ae93d648dce2480d1ae7b6752ca78a92d62e441dbeb4082ced542cc32d2c795943c
+  metadata.gz: 10d9a2fef303a9b785e33ee7300c2b26773edb4f617ffede7fbf3b0185ca2bed955d4f865db344079a15b1bb83f7cc8306f866250bcb7c68b4d7201db7762a68
+  data.tar.gz: d1a63fa071431c4333c657d8843bebb684919d68983b5abf476e6a3208cc18894a272a6a64a7adf9520e9ee01eca87b25f2d7cc0f0837464b280018a1cd44213

data/lib/airbrake-ruby.rb

@@ -14,6 +14,7 @@ require 'airbrake-ruby/sync_sender'
 require 'airbrake-ruby/async_sender'
 require 'airbrake-ruby/response'
 require 'airbrake-ruby/nested_exception'
+require 'airbrake-ruby/ignorable'
 require 'airbrake-ruby/notice'
 require 'airbrake-ruby/backtrace'
 require 'airbrake-ruby/truncator'
@@ -30,11 +31,17 @@ require 'airbrake-ruby/filters/dependency_filter'
 require 'airbrake-ruby/filters/git_revision_filter'
 require 'airbrake-ruby/filters/git_repository_filter'
 require 'airbrake-ruby/filters/git_last_checkout_filter'
+require 'airbrake-ruby/filters/sql_filter'
 require 'airbrake-ruby/filter_chain'
-require 'airbrake-ruby/notifier'
 require 'airbrake-ruby/code_hunk'
 require 'airbrake-ruby/file_cache'
-require 'airbrake-ruby/route_sender'
+require 'airbrake-ruby/hash_keyable'
+require 'airbrake-ruby/performance_notifier'
+require 'airbrake-ruby/notice_notifier'
+require 'airbrake-ruby/deploy_notifier'
+require 'airbrake-ruby/stat'
+require 'airbrake-ruby/time_truncate'
+require 'airbrake-ruby/tdigest'
 
 # This module defines the Airbrake API. The user is meant to interact with
 # Airbrake via its public class methods. Before using the library, you must to
@@ -67,7 +74,7 @@ require 'airbrake-ruby/route_sender'
 #   params = {}
 #   Airbrake[:my_other_project].notify('Oops', params)
 #
-# @see Airbrake::Notifier
+# @see Airbrake::NoticeNotifier
 # @since v1.0.0
 module Airbrake
   # The general error that this library uses when it wants to raise.
@@ -83,11 +90,12 @@ module Airbrake
   # @!macro see_public_api_method
   #   @see Airbrake.$0
 
-  # NilNotifier is a no-op notifier, which mimics +Airbrake::Notifier+ and
-  # serves only for the purpose of making the library API easier to use.
+  # NilNoticeNotifier is a no-op notice notifier, which mimics
+  # +Airbrake::NoticeNotifier+ and serves only the purpose of making the library
+  # API easier to use.
   #
-  # @since 2.1.0
-  class NilNotifier
+  # @since v2.1.0
+  class NilNoticeNotifier
     # @macro see_public_api_method
     def notify(_exception, _params = {}, &block); end
 
@@ -106,9 +114,6 @@ module Airbrake
     # @macro see_public_api_method
     def close; end
 
-    # @macro see_public_api_method
-    def create_deploy(_deploy_params); end
-
     # @macro see_public_api_method
     def configured?
       false
@@ -116,15 +121,61 @@ module Airbrake
 
     # @macro see_public_api_method
     def merge_context(_context); end
+  end
 
-    # @macro see_public_api_method
-    def notify_request(_request_info); end
+  # @deprecated Use {Airbrake::NoticeNotifier} instead
+  Notifier = NoticeNotifier
+  deprecate_constant(:Notifier) if respond_to?(:deprecate_constant)
+
+  # @deprecated Use {Airbrake::NilNoticeNotifier} instead
+  NilNotifier = NilNoticeNotifier
+  deprecate_constant(:NilNotifier) if respond_to?(:deprecate_constant)
+
+  # NilPerformanceNotifier is a no-op notifier, which mimics
+  # {Airbrake::PerformanceNotifier} and serves only the purpose of making the
+  # library API easier to use.
+  #
+  # @since v3.2.0
+  class NilPerformanceNotifier
+    # @see Airbrake.notify_request
+    # @see Airbrake.notify_query
+    def notify(_performance_info); end
+
+    # @see Airbrake.notify_request
+    # @see Airbrake.notify_query
+    def add_filter(_filter = nil, &_block); end
+
+    # @see Airbrake.notify_request
+    # @see Airbrake.notify_query
+    def delete_filter(_filter_class); end
+  end
+
+  # NilDeployNotifier is a no-op notifier, which mimics
+  # {Airbrake::DeployNotifier} and serves only the purpose of making the library
+  # API easier to use.
+  #
+  # @since v3.2.0
+  class NilDeployNotifier
+    # @see Airbrake.create_deploy
+    def notify(_deploy_info); end
   end
 
-  # A Hash that holds all notifiers. The keys of the Hash are notifier
-  # names, the values are Airbrake::Notifier instances. If a notifier is not
-  # assigned to the hash, then it returns a null object (NilNotifier).
-  @notifiers = Hash.new(NilNotifier.new)
+  # A Hash that holds all notice notifiers. The keys of the Hash are notifier
+  # names, the values are {Airbrake::NoticeNotifier} instances. If a notifier is
+  # not assigned to the hash, then it returns a null object (NilNoticeNotifier).
+  @notice_notifiers = Hash.new(NilNoticeNotifier.new)
+
+  # A Hash that holds all performance notifiers. The keys of the Hash are
+  # notifier names, the values are {Airbrake::PerformanceNotifier} instances. If
+  # a notifier is not assigned to the hash, then it returns a null object
+  # (NilPerformanceNotifier).
+  @performance_notifiers = Hash.new(NilPerformanceNotifier.new)
+
+  # A Hash that holds all deploy notifiers. The keys of the Hash are notifier
+  # names, the values are {Airbrake::DeployNotifier} instances. If a deploy
+  # notifier is not assigned to the hash, then it returns a null object
+  # (NilDeployNotifier).
+  @deploy_notifiers = Hash.new(NilDeployNotifier.new)
 
   class << self
     # Retrieves configured notifiers.
@@ -132,11 +183,23 @@ module Airbrake
     # @example
     #   Airbrake[:my_notifier].notify('oops')
     #
-    # @param [Symbol] notifier_name the name of the notifier you want to use
-    # @return [Airbrake::Notifier, NilClass]
+    # @param [Symbol] notifier_name the name of the notice notifier you want to
+    #   use
+    # @return [Airbrake::NoticeNotifier, NilClass]
     # @since v1.8.0
     def [](notifier_name)
-      @notifiers[notifier_name]
+      @notice_notifiers[notifier_name]
+    end
+
+    # @return [Hash{Symbol=>Array<Object>}] a Hash with all configured notifiers
+    #   (notice, performance, deploy)
+    # @since v3.2.0
+    def notifiers
+      {
+        notice: @notice_notifiers,
+        performance: @performance_notifiers,
+        deploy: @deploy_notifiers
+      }
     end
 
     # Configures a new +notifier+ with the given name. If the name is not given,
@@ -162,23 +225,29 @@ module Airbrake
     # @return [void]
     # @raise [Airbrake::Error] when trying to reconfigure already
     #   existing notifier
+    # @raise [Airbrake::Error] when either +project_id+ or +project_key+
+    #   is missing (or both)
     # @note There's no way to reconfigure a notifier
     # @note There's no way to read config values outside of this library
     def configure(notifier_name = :default)
       yield config = Airbrake::Config.new
 
-      if @notifiers.key?(notifier_name)
+      if @notice_notifiers.key?(notifier_name)
         raise Airbrake::Error,
               "the '#{notifier_name}' notifier was already configured"
-      else
-        @notifiers[notifier_name] = Notifier.new(config)
       end
+
+      raise Airbrake::Error, config.validation_error_message unless config.valid?
+
+      @notice_notifiers[notifier_name] = NoticeNotifier.new(config)
+      @performance_notifiers[notifier_name] = PerformanceNotifier.new(config)
+      @deploy_notifiers[notifier_name] = DeployNotifier.new(config)
     end
 
     # @return [Boolean] true if the notifier was configured, false otherwise
-    # @since 2.3.0
+    # @since v2.3.0
     def configured?
-      @notifiers[:default].configured?
+      @notice_notifiers[:default].configured?
     end
 
     # Sends an exception to Airbrake asynchronously.
@@ -203,7 +272,7 @@ module Airbrake
     # @return [Airbrake::Promise]
     # @see .notify_sync
     def notify(exception, params = {}, &block)
-      @notifiers[:default].notify(exception, params, &block)
+      @notice_notifiers[:default].notify(exception, params, &block)
     end
 
     # Sends an exception to Airbrake synchronously.
@@ -223,7 +292,7 @@ module Airbrake
     # @return [Hash{String=>String}] the reponse from the server
     # @see .notify
     def notify_sync(exception, params = {}, &block)
-      @notifiers[:default].notify_sync(exception, params, &block)
+      @notice_notifiers[:default].notify_sync(exception, params, &block)
     end
 
     # Runs a callback before {.notify} or {.notify_sync} kicks in. This is
@@ -251,7 +320,7 @@ module Airbrake
     # @yieldreturn [void]
     # @return [void]
     def add_filter(filter = nil, &block)
-      @notifiers[:default].add_filter(filter, &block)
+      @notice_notifiers[:default].add_filter(filter, &block)
     end
 
     # Deletes a filter added via {Airbrake#add_filter}.
@@ -268,7 +337,7 @@ module Airbrake
     # @since v3.1.0
     # @note This method cannot delete filters assigned via the Proc form.
     def delete_filter(filter_class)
-      @notifiers[:default].delete_filter(filter_class)
+      @notice_notifiers[:default].delete_filter(filter_class)
     end
 
     # Builds an Airbrake notice. This is useful, if you want to add or modify a
@@ -286,12 +355,12 @@ module Airbrake
     # @return [Airbrake::Notice] the notice built with help of the given
     #   arguments
     def build_notice(exception, params = {})
-      @notifiers[:default].build_notice(exception, params)
+      @notice_notifiers[:default].build_notice(exception, params)
     end
 
-    # Makes the notifier a no-op, which means you cannot use the {.notify} and
-    # {.notify_sync} methods anymore. It also stops the notifier's worker
-    # threads.
+    # Makes the notice notifier a no-op, which means you cannot use the
+    # {.notify} and {.notify_sync} methods anymore. It also stops the notice
+    # notifier's worker threads.
     #
     # @example
     #   Airbrake.close
@@ -299,21 +368,21 @@ module Airbrake
     #
     # @return [void]
     def close
-      @notifiers[:default].close
+      @notice_notifiers[:default].close
     end
 
     # Pings the Airbrake Deploy API endpoint about the occurred deploy. This
     # method is used by the airbrake gem for various integrations.
     #
-    # @param [Hash{Symbol=>String}] deploy_params The params for the API
-    # @option deploy_params [Symbol] :environment
-    # @option deploy_params [Symbol] :username
-    # @option deploy_params [Symbol] :repository
-    # @option deploy_params [Symbol] :revision
-    # @option deploy_params [Symbol] :version
+    # @param [Hash{Symbol=>String}] deploy_info The params for the API
+    # @option deploy_info [Symbol] :environment
+    # @option deploy_info [Symbol] :username
+    # @option deploy_info [Symbol] :repository
+    # @option deploy_info [Symbol] :revision
+    # @option deploy_info [Symbol] :version
     # @return [void]
-    def create_deploy(deploy_params)
-      @notifiers[:default].create_deploy(deploy_params)
+    def create_deploy(deploy_info)
+      @deploy_notifiers[:default].notify(deploy_info)
     end
 
     # Merges +context+ with the current context.
@@ -361,7 +430,7 @@ module Airbrake
     # @param [Hash{Symbol=>Object}] context
     # @return [void]
     def merge_context(context)
-      @notifiers[:default].merge_context(context)
+      @notice_notifiers[:default].merge_context(context)
     end
 
     # Increments request statistics of a certain +route+ that was invoked on
@@ -388,8 +457,93 @@ module Airbrake
     # @option request_info [Time] :end_time When the request ended (optional)
     # @return [void]
     # @since v3.0.0
+    # @see Airbrake::PerformanceNotifier#notify
     def notify_request(request_info)
-      @notifiers[:default].notify_request(request_info)
+      @performance_notifiers[:default].notify(Request.new(request_info))
+    end
+
+    # Increments SQL statistics of a certain +query+ that was invoked on
+    # +start_time+ and finished on +end_time+. When +method+ and +route+ are
+    # provided, the query is grouped by these parameters.
+    #
+    # After a certain amount of time (n seconds) the aggregated query
+    # information will be sent to Airbrake.
+    #
+    # @example
+    #   Airbrake.notify_query(
+    #     method: 'GET',
+    #     route: '/things',
+    #     query: 'SELECT * FROM things',
+    #     start_time: timestamp,
+    #     end_time: Time.now
+    #   )
+    #
+    # @param [Hash{Symbol=>Object}] query_info
+    # @option request_info [String] :method The HTTP method that triggered this
+    #   SQL query (optional)
+    # @option request_info [String] :route The route that triggered this SQL
+    #    query (optional)
+    # @option request_info [String] :query The query that was executed
+    # @option request_info [Date] :start_time When the query started executing
+    # @option request_info [Time] :end_time When the query finished (optional)
+    # @return [void]
+    # @since v3.2.0
+    # @see Airbrake::PerformanceNotifier#notify
+    def notify_query(query_info)
+      @performance_notifiers[:default].notify(Query.new(query_info))
+    end
+
+    # Runs a callback before {.notify_request} or {.notify_query} kicks in. This
+    # is useful if you want to ignore specific resources or filter the data the
+    # resource contains.
+    #
+    # @example Ignore all resources
+    #   Airbrake.add_performance_filter(&:ignore!)
+    # @example Filter sensitive data
+    #   Airbrake.add_performance_filter do |resource|
+    #     case resource
+    #     when Airbrake::Query
+    #       resource.route = '[Filtered]'
+    #     when Airbrake::Request
+    #       resource.query = '[Filtered]'
+    #     end
+    #   end
+    # @example Filter with help of a class
+    #   class MyFilter
+    #     def call(resource)
+    #       # ...
+    #     end
+    #   end
+    #
+    #   Airbrake.add_performance_filter(MyFilter.new)
+    #
+    # @param [#call] filter The filter object
+    # @yield [resource] The resource to filter
+    # @yieldparam [Airbrake::Query, Airbrake::Request]
+    # @yieldreturn [void]
+    # @return [void]
+    # @since v3.2.0
+    # @see Airbrake::PerformanceNotifier#add_filter
+    def add_performance_filter(filter = nil, &block)
+      @performance_notifiers[:default].add_filter(filter, &block)
+    end
+
+    # Deletes a filter added via {Airbrake#add_performance_filter}.
+    #
+    # @example
+    #   # Add a MyFilter filter (we pass an instance here).
+    #   Airbrake.add_performance_filter(MyFilter.new)
+    #
+    #   # Delete the filter (we pass class name here).
+    #   Airbrake.delete_performance_filter(MyFilter)
+    #
+    # @param [Class] filter_class The class of the filter you want to delete
+    # @return [void]
+    # @since v3.2.0
+    # @note This method cannot delete filters assigned via the Proc form.
+    # @see Airbrake::PerformanceNotifier#delete_filter
+    def delete_performance_filter(filter_class)
+      @performance_notifiers[:default].delete_filter(filter_class)
     end
   end
 end

data/lib/airbrake-ruby/config.rb

@@ -2,7 +2,7 @@ module Airbrake
   # Represents the Airbrake config. A config contains all the options that you
   # can use to configure an Airbrake instance.
   #
-  # @api private
+  # @api public
   # @since v1.0.0
   class Config
     # @return [Integer] the project identificator. This value *must* be set.
@@ -68,13 +68,13 @@ module Airbrake
     # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
-    # @since 1.2.0
+    # @since v1.2.0
     attr_accessor :blacklist_keys
 
     # @return [Array<String, Symbol, Regexp>] the keys, which shouldn't be
     #   filtered
     # @api public
-    # @since 1.2.0
+    # @since v1.2.0
     attr_accessor :whitelist_keys
 
     # @return [Boolean] true if the library should attach code hunks to each
@@ -83,17 +83,17 @@ module Airbrake
     # @since v2.5.0
     attr_accessor :code_hunks
 
-    # @return [Boolean] true if the library should send route stats information
-    #   to Airbrake, false otherwise
+    # @return [Boolean] true if the library should send performance stats
+    #   information to Airbrake (routes, SQL queries), false otherwise
     # @api public
-    # @since v3.0.0
-    attr_accessor :route_stats
+    # @since v3.2.0
+    attr_accessor :performance_stats
 
     # @return [Integer] how many seconds to wait before sending collected route
     #   stats
     # @api public
-    # @since v3.0.0
-    attr_accessor :route_stats_flush_period
+    # @since v3.2.0
+    attr_accessor :performance_stats_flush_period
 
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
@@ -126,8 +126,8 @@ module Airbrake
       )
 
       self.versions = {}
-      self.route_stats = false
-      self.route_stats_flush_period = 15
+      self.performance_stats = false
+      self.performance_stats_flush_period = 15
 
       merge(user_config)
     end
@@ -195,6 +195,38 @@ module Airbrake
       end
     end
 
+    def route_stats
+      logger.warn(
+        "#{LOG_LABEL} the 'route_stats' option is deprecated. " \
+        "Use 'performance_stats' instead"
+      )
+      @performance_stats
+    end
+
+    def route_stats=(value)
+      logger.warn(
+        "#{LOG_LABEL} the 'route_stats' option is deprecated. " \
+        "Use 'performance_stats_flush_period' instead"
+      )
+      @performance_stats = value
+    end
+
+    def route_stats_flush_period
+      logger.warn(
+        "#{LOG_LABEL} the 'route_stats_flush_period' option is deprecated. " \
+        "Use 'performance_stats_flush_period' instead"
+      )
+      @performance_stats_flush_period
+    end
+
+    def route_stats_flush_period=(value)
+      logger.warn(
+        "#{LOG_LABEL} the 'route_stats_flush_period' option is deprecated. " \
+        "Use 'performance_stats' instead"
+      )
+      @performance_stats_flush_period = value
+    end
+
     private
 
     def set_option(option, value)