class

Honeybadger::Configuration

Inherits Reference / Object

Constructors

Instance methods

api_key

A Honeybadger API key.

Source
api_key=(api_key : String)

A Honeybadger API key.

Source
development?

Is the current environment considered a development environment?

Source
development_environments

The list of environments considered "development"

Source
development_environments=(development_environments : Array(String))

The list of environments considered "development"

Source
development_environments=(value : String)

Configure development environment list with a string.

Used to set the value from an environment variable. Input is split on commas and striped of leading/trailing whitespace.

config.development_environments = "development, testing, staging"
config.development_environments # => ["development", "testing", "staging"]
Source
endpoint

The API endpoint for sending Honeybadger payloads.

Source
endpoint=(endpoint : Path)

The API endpoint for sending Honeybadger payloads.

Source
endpoint=(path : String) : String

Configures API endpoint with a string.

Used to set the value from an environment variable.

config.endpoint = "http://new_api.honeybadger.io"
config.endpoint # => Path["http://new_api.honeybadger.io"]
Source
environment

The current app environment.

Source
environment=(environment : String | Nil)

The current app environment.

Source
filter_keys

A list of keys whose values are replaced with "[FILTERED]" in sensitive data objects.

Source
filter_keys=(filter_keys : Array(String))

A list of keys whose values are replaced with "[FILTERED]" in sensitive data objects.

Source
hostname

The system or container hostname.

Source
hostname=(hostname : String)

The system or container hostname.

Source
merge_log_context

Merge the log context into the Honeybadger payload before sending errors to the reporting API.

Source
merge_log_context=(merge_log_context : Bool)

Merge the log context into the Honeybadger payload before sending errors to the reporting API.

Source
project_root

The path to the projects source code. Evaluated at compile time.

Source
project_root=(project_root : String)

The path to the projects source code. Evaluated at compile time.

Source
report_data

Explicitly override the development environment check. Nil = check for development environment True = always report data False = never report data

Source
report_data=(report_data : Bool | Nil)

Explicitly override the development environment check. Nil = check for development environment True = always report data False = never report data

Source
report_data=(value : String) : Bool

Configures report_data with a string.

Source
report_data?

Should Honeybadger.cr send data to the honeybadger api?

When report_data is unset, default to development? logic.

Source
revision

The project git revision. Evaluated at compile time.

Source
revision=(revision : String)

The project git revision. Evaluated at compile time.

Source
set_from_env

Reads configuration from honeybadger prefixed environment variables

Source