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.cr
honeybadger.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

Class Method Detail

def self.api_key #

[View source]
def self.clear : Nil #

[View source]
def self.configuration #

The Honeybadger Configuration singleton instance.


[View source]
def self.configure(api_key : String, *, environment : String | Nil = nil) : Nil #

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)

[View source]
def self.configure(&) : Nil #

Configure Honeybadger with a block.

Honeybadger.configure do |settings|
  settings.api_key = "00000"
  settings.project_root = "/path/to/project"
end

[View source]
def self.context(**args) : Context #

[View source]
def self.endpoint #

[View source]
def self.hostname #

[View source]
def self.notify(exception : Exception | String, context : Hash | Nil = nil, *, synchronous : Bool = false, error_class : String | Nil = nil) : Nil #

Send notifications to the Honeybadger API


[View source]
def self.project_root #

[View source]
def self.report_data? : Bool #

[View source]
def self.revision #

[View source]