module Airbrake

Retrieves configured notifiers.

@example

Airbrake[:my_notifier].notify('oops')

@return [Airbrake::Notifier, nil] @since v1.8.0

# File lib/airbrake-ruby.rb, line 99
def [](notifier_name)
  @notifiers[notifier_name]
end

Runs a callback before {.notify} or {.notify_sync} kicks in. This is useful if you want to ignore specific notices or filter the data the notice contains.

@example Ignore all notices

Airbrake.add_filter(&:ignore!)

@example Ignore based on some condition

Airbrake.add_filter do |notice|
  notice.ignore! if notice[:error_class] == 'StandardError'
end

@example Ignore with help of a class

class MyFilter
  def call(notice)
    # ...
  end
end

Airbrake.add_filter(MyFilter.new)

@param [#call] filter The filter object @yield [notice] The notice to filter @yieldparam [Airbrake::Notice] @yieldreturn [void] @return [void] @note Once a filter was added, there's no way to delete it

# File lib/airbrake-ruby.rb, line 220
def add_filter(filter = nil, &block)
  @notifiers[:default].add_filter(filter, &block)
end

Builds an Airbrake notice. This is useful, if you want to add or modify a value only for a specific notice. When you're done modifying the notice, send it with {.notify} or {.notify_sync}.

@example

notice = airbrake.build_notice('App crashed!')
notice[:params][:username] = user.name
airbrake.notify_sync(notice)

@param [Exception] exception The exception on top of which the notice

should be built

@param [Hash] params The additional params attached to the notice @return [Airbrake::Notice] the notice built with help of the given

arguments

# File lib/airbrake-ruby.rb, line 239
def build_notice(exception, params = {})
  @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.

@example

Airbrake.close
Airbrake.notify('App crashed!') #=> raises Airbrake::Error

@return [void]

# File lib/airbrake-ruby.rb, line 253
def close
  @notifiers[:default].close
end

Configures a new notifier with the given name. If the name is not given, configures the default notifier.

@example Configuring the default notifier

Airbrake.configure do |c|
  c.project_id = 113743
  c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
end

@example Configuring a named notifier

# Configure a new Airbrake instance and
# assign +:my_other_project+ as its name.
Airbrake.configure(:my_other_project) do |c|
  c.project_id = 224854
  c.project_key = '91ac5e4a37496026c6837f63276ed2b6'
end

@param [Symbol] notifier_name the name to be associated with the notifier @yield [config] The configuration object @yieldparam config [Airbrake::Config] @return [void] @raise [Airbrake::Error] when trying to reconfigure already

existing notifier

@note There's no way to reconfigure a notifier @note There's no way to read config values outside of this library

# File lib/airbrake-ruby.rb, line 129
def configure(notifier_name = :default)
  yield config = Airbrake::Config.new

  if @notifiers.key?(notifier_name)
    raise Airbrake::Error,
          "the '#{notifier_name}' notifier was already configured"
  else
    @notifiers[notifier_name] = Notifier.new(config)
  end
end

@return [Boolean] true if the notifier was configured, false otherwise @since 2.3.0

# File lib/airbrake-ruby.rb, line 143
def configured?
  @notifiers[:default].configured?
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 @return [void]

# File lib/airbrake-ruby.rb, line 268
def create_deploy(deploy_params)
  @notifiers[:default].create_deploy(deploy_params)
end

Sends an exception to Airbrake asynchronously.

@example Sending an exception

Airbrake.notify(RuntimeError.new('Oops!'))

@example Sending a string

# Converted to RuntimeError.new('Oops!') internally
Airbrake.notify('Oops!')

@example Sending a Notice

notice = airbrake.build_notice(RuntimeError.new('Oops!'))
airbrake.notify(notice)

@param [Exception, String, Airbrake::Notice] exception The exception to be

sent to Airbrake

@param [Hash] params The additional payload to be sent to Airbrake. Can

contain any values. The provided values will be displayed in the Params
tab in your project's dashboard

@yield [notice] The notice to filter @yieldparam [Airbrake::Notice] @yieldreturn [void] @return [Airbrake::Promise] @see .notify_sync

# File lib/airbrake-ruby.rb, line 169
def notify(exception, params = {}, &block)
  @notifiers[:default].notify(exception, params, &block)
end

Sends an exception to Airbrake synchronously.

@example

Airbrake.notify_sync('App crashed!')
#=> {"id"=>"123", "url"=>"https://airbrake.io/locate/321"}

@param [Exception, String, Airbrake::Notice] exception The exception to be

sent to Airbrake

@param [Hash] params The additional payload to be sent to Airbrake. Can

contain any values. The provided values will be displayed in the Params
tab in your project's dashboard

@yield [notice] The notice to filter @yieldparam [Airbrake::Notice] @yieldreturn [void] @return [Hash{String=>String}] the reponse from the server @see .notify

# File lib/airbrake-ruby.rb, line 190
def notify_sync(exception, params = {}, &block)
  @notifiers[:default].notify_sync(exception, params, &block)
end