module Honeybadger
Overview
The Honeybadger::AuthenticHandler
is meant to integrate with the Lucky web framework.
It will attempt to fetch a user's ID from the current session, and include it in the error context if available.
Defined in:
framework_handlers/authentic_handler.crhoneybadger.cr
honeybadger/api.cr
honeybadger/configuration.cr
honeybadger/context.cr
honeybadger/dispatch.cr
honeybadger/handler.cr
honeybadger/http_payload.cr
honeybadger/payload.cr
honeybadger/response.cr
Constant Summary
-
VERSION =
"0.2.3"
Class Method Summary
-
.api_key
Alias of
Configuration.api_key
. - .clear : Nil
-
.configuration
The Honeybadger Configuration singleton instance.
-
.configure(api_key : String, *, environment : String | Nil = nil) : Nil
Set the API key to be used for calls to the honeybadger API.
-
.configure(&) : Nil
Configure Honeybadger with a block.
- .context(**args) : Context
-
.endpoint
Alias of
Configuration.endpoint
. -
.hostname
Alias of
Configuration.hostname
. -
.notify(exception : Exception | String, context : Hash | Nil = nil, *, synchronous : Bool = false, error_class : String | Nil = nil) : Nil
Send notifications to the Honeybadger API
-
.project_root
Alias of
Configuration.project_root
. -
.report_data? : Bool
Alias of
Configuration.report_data
-
.revision
Alias of
Configuration.revision
.
Class Method Detail
Set the API key to be used for calls to the honeybadger API.
Call .configure
during an application boot sequence and populate the api key:
honeybadger_api_key = ENV["HONEYBADGER_API_KEY"]? || "00000000"
Honeybadger.configure(api_key: honeybadger_api_key)
Configure Honeybadger with a block.
Honeybadger.configure do |settings|
settings.api_key = "00000"
settings.project_root = "/path/to/project"
end
Send notifications to the Honeybadger API