Module: ErrorStalker::Plugin

Defined in:

lib/error_stalker/plugin.rb

Overview

The ErrorStalker server supports third-party plugins that add functionality to the server.

Plugins should inherit from ErrorStalker::Plugin::Base. This base plugin provides functions that can be overridden in its children. Currently, a few hooks are provided for plugins to override:

ErrorStalker::Plugin::Base.new

Called when the server starts. This

method can be overridden to do things
like add extra routes to the server
or initialize any data structures
that the plugin needs to keep track
of. Take a look at
ErrorStalker::Plugin::LighthouseReporter
for a good example of how this method
can be hooked to provide additional
functionality.

ErrorStalker::Plugin::Base#exception_links

Called when rendering

exception details. This
function should return an
array of [link_text,
link_href] pairs that
will be used to link to
additional routes that
the plugin might add.

ErrorStalker::Plugin::Base#after_create

Called when a new exception

is
reported. ErrorStalker::Plugin::EmailSender
has a good example of this
being used.

After creating a plugin, it can be added to the server in the server configuration file or manually added using the ErrorStalker::Server#plugins attribute.

Defined Under Namespace

Classes: Base, EmailSender, LighthouseReporter