Module: Airbrake::Ignorable Private

Included in:
Notice, PerformanceBreakdown, Query, Queue, Request
Defined in:
lib/airbrake-ruby/ignorable.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Ignorable contains methods that allow the includee to be ignored.

Examples:

class A
  include Airbrake::Ignorable
end

a = A.new
a.ignore!
a.ignored? #=> true

Since:

  • v3.2.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#ignored ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • v3.2.0



16
17
18
 
# File 'lib/airbrake-ruby/ignorable.rb', line 16

def ignored
  @ignored
end

Instance Method Details

#ignore! ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Ignores an instance. Ignored instances must never reach the Airbrake dashboard.

See Also:

Since:

  • v3.2.0



29
30
31
 
# File 'lib/airbrake-ruby/ignorable.rb', line 29

def ignore!
  self.ignored = true
end

#ignored? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks whether the instance was ignored.

Returns:

  • (Boolean)

See Also:

Since:

  • v3.2.0



21
22
23
 
# File 'lib/airbrake-ruby/ignorable.rb', line 21

def ignored?
  !!ignored
end