Class: AllStak::Modules::Errors

Inherits:
Object
  • Object
show all
Defined in:
lib/allstak/modules/errors.rb

Overview

Captures exceptions and sends them to AllStak.

Constant Summary collapse

PATH = 
"/ingest/v1/errors".freeze
MAX_BREADCRUMBS = 
50

Instance Method Summary collapse

Constructor Details

#initialize(transport, config, logger) ⇒ Errors

Returns a new instance of Errors.



10
11
12
13
14
15
16
17
 
# File 'lib/allstak/modules/errors.rb', line 10

def initialize(transport, config, logger)
  @transport = transport
  @config = config
  @logger = logger
  @current_user = nil
  @breadcrumbs = []
  @breadcrumb_mutex = Mutex.new
end

Instance Method Details

#add_breadcrumb(type:, message:, level: "info", data: nil) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/allstak/modules/errors.rb', line 27

def add_breadcrumb(type:, message:, level: "info", data: nil)
  @breadcrumb_mutex.synchronize do
    @breadcrumbs.shift if @breadcrumbs.length >= MAX_BREADCRUMBS
    @breadcrumbs << {
      timestamp: Time.now.utc.iso8601(6),
      type: type,
      message: message,
      level: level,
      data: data
    }.compact
  end
end

#capture_error(exception_class, message, stack_trace: nil, level: "error", user: nil, request_context: nil, trace_id: nil, metadata: nil) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/allstak/modules/errors.rb', line 78

def capture_error(exception_class, message, stack_trace: nil, level: "error", user: nil, request_context: nil, trace_id: nil, metadata: nil)
  return nil if @transport.disabled?
  begin
    payload = {
      exceptionClass: exception_class,
      message: message,
      stackTrace: stack_trace,
      level: level,
      environment: @config.environment,
      release: @config.release,
      traceId: trace_id,
      user: (user || @current_user)&.to_h,
      requestContext: request_context&.to_h,
      metadata: metadata
    }.compact
    payload.delete(:user)           if payload[:user]&.empty?
    payload.delete(:requestContext) if payload[:requestContext]&.empty?
    status, _ = @transport.post(PATH, payload)
    status == 202 ? exception_class : nil
  rescue => e
    @logger.debug("[AllStak] capture_error swallowed: #{e.class}: #{e.message}")
    nil
  end
end

#capture_exception(exc, level: "error", user: nil, request_context: nil, trace_id: nil, metadata: nil) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/allstak/modules/errors.rb', line 40

def capture_exception(exc, level: "error", user: nil, request_context: nil, trace_id: nil, metadata: nil)
  return nil if @transport.disabled?
  begin
    crumbs = @breadcrumb_mutex.synchronize do
      next nil if @breadcrumbs.empty?
      out = @breadcrumbs.dup
      @breadcrumbs.clear
      out
    end

    payload = {
      exceptionClass: exc.class.name,
      message: exc.message.to_s.empty? ? exc.class.name : exc.message.to_s,
      stackTrace: extract_frames(exc),
      level: level,
      environment: @config.environment,
      release: @config.release,
      traceId: trace_id,
      user: (user || @current_user)&.to_h,
      requestContext: request_context&.to_h,
      metadata: metadata,
      breadcrumbs: crumbs
    }.compact
    payload.delete(:user)           if payload[:user]&.empty?
    payload.delete(:requestContext) if payload[:requestContext]&.empty?

    status, body = @transport.post(PATH, payload)
    return nil unless status == 202
    parsed = JSON.parse(body) rescue nil
    parsed&.dig("data", "id")
  rescue Transport::AllStakAuthError
    nil
  rescue => e
    @logger.debug("[AllStak] capture_exception swallowed: #{e.class}: #{e.message}")
    nil
  end
end

#clear_user ⇒ Object 



23
24
25
 
# File 'lib/allstak/modules/errors.rb', line 23

def clear_user
  @current_user = nil
end

#set_user(id: nil, email: nil, ip: nil) ⇒ Object 



19
20
21
 
# File 'lib/allstak/modules/errors.rb', line 19

def set_user(id: nil, email: nil, ip: nil)
  @current_user = Models::UserContext.new(id: id, email: email, ip: ip)
end