Class: Honeybadger::Backend::Base Private

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Logging::Helper
Defined in:
lib/honeybadger/backend/base.rb

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

Direct Known Subclasses

Null, Server

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Base

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.

Returns a new instance of Base.


75
76
77
 
# File 'lib/honeybadger/backend/base.rb', line 75

def initialize(config)
  @config = config
end

Instance Method Details

#check_in(id) ⇒ 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.

Does a check in using the input id.

Parameters:

  • id (String) —

    The unique check_in id.

Raises:

  • NotImplementedError


98
99
100
 
# File 'lib/honeybadger/backend/base.rb', line 98

def check_in(id)
  raise NotImplementedError, 'must define #check_in on subclass.'
end

#notify(feature, payload) ⇒ 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.

Process payload for feature.

Examples:

backend.notify(:notices, Notice.new(...))

Parameters:

  • feature (Symbol) —

    The feature name (corresponds to HTTP endpoint). Current options are: `:notices`, `:deploys`, `:ping`.

  • payload (#to_json) —

    The JSON payload to send.

Raises:

  • NotImplementedError


89
90
91
 
# File 'lib/honeybadger/backend/base.rb', line 89

def notify(feature, payload)
  raise NotImplementedError, 'must define #notify on subclass.'
end