Module: Bellman

Includes:
ActiveSupport::Configurable
Defined in:
lib/bellman/bellman.rb,
lib/bellman/version.rb,
lib/bellman/handlers/sentry.rb,
lib/bellman/handlers/handler.rb,
lib/bellman/handlers/base_handler.rb,
lib/bellman/handlers/rails_logger.rb

Overview

Bellman

Unified way to take all of the log messages and direct them to the right place.

By default all messages will be logged using the Rails standard logger and any message with severity of :error or :fatal will also be sent to Sentry.

For historical details on a bellman/town crier see:

https://en.wikipedia.org/wiki/Town_crier

Defined Under Namespace

Modules: Handlers

Constant Summary collapse

VERSION = 
'0.1.2'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/bellman/bellman.rb', line 18

def self.configure
  # Set the defaults
  config.severities = %i[debug info warn error fatal].freeze
  config.default_severity = :error
  config.on_unknown_severity = :raise
  config.handlers = [
    {
      id: :log,
      class: Bellman::Handlers::RailsLogger,
      severities: %i[debug info warn error fatal]
    },
    {
      id: :sentry,
      class: Bellman::Handlers::Sentry,
      severities: %i[error fatal]
    }
  ]

  super

  # Create an instance of the handler that can be used
  @handler = Handlers::Handler.new
end

.handle(error, severity: nil, trace_id: nil, objects: nil, data: nil, include_backtrace: false, handlers: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



51
52
53
54
55
56
57
58
59
 
# File 'lib/bellman/bellman.rb', line 51

def self.handle(
  error, severity: nil, trace_id: nil, objects: nil, data: nil,
  include_backtrace: false, handlers: nil
)
  @handler.handle(
    error, severity:, trace_id:, objects:, data:, include_backtrace:,
           handlers:
  )
end

.handler(id: nil) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/bellman/bellman.rb', line 42

def self.handler(id: nil)
  if id.nil?
    @handler
  else
    @handler.handlers.find { |hndlr| hndlr[:id] == id.to_sym }
  end
end