Module: Bugwatch

Defined in:
lib/bugwatch.rb,
lib/bugwatch/railtie.rb,
lib/bugwatch/version.rb,
lib/bugwatch/db_tracker.rb,
lib/bugwatch/middleware.rb,
lib/bugwatch/notification.rb,
lib/bugwatch/user_context.rb,
lib/bugwatch/configuration.rb,
lib/bugwatch/error_builder.rb,
lib/bugwatch/report_builder.rb,
lib/bugwatch/db_query_buffer.rb,
lib/bugwatch/db_query_sender.rb,
lib/bugwatch/feedback_helper.rb,
lib/bugwatch/feedback_sender.rb,
lib/bugwatch/error_subscriber.rb,
lib/bugwatch/backtrace_cleaner.rb,
lib/bugwatch/active_job_handler.rb,
lib/bugwatch/transaction_buffer.rb,
lib/bugwatch/transaction_sender.rb,
lib/bugwatch/breadcrumb_collector.rb

Defined Under Namespace

Modules: BreadcrumbCollector, ControllerMethods, DbTracker, FeedbackHelper, UserContext Classes: ActiveJobHandler, BacktraceCleaner, Configuration, DbQueryBuffer, DbQuerySender, ErrorBuilder, ErrorSubscriber, FeedbackSender, Middleware, Notification, Railtie, ReportBuilder, TransactionBuffer, TransactionSender

Constant Summary collapse

VERSION = 
"0.7.1"

Class Method Summary collapse

Class Method Details

.check_in(slug) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/bugwatch.rb', line 68

def check_in(slug)
  return unless configuration.api_key
  return unless configuration.endpoint

  Thread.new do
    uri = URI.parse("#{configuration.endpoint.chomp("/")}/api/v1/monitors/#{slug}/check_in")

    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl       = uri.scheme == "https"
    http.open_timeout  = 3
    http.read_timeout  = 3
    http.write_timeout = 3

    request = Net::HTTP::Post.new(uri.path)
    request["X-Api-Key"]       = configuration.api_key
    request["X-BugWatch-Ruby"] = Bugwatch::VERSION

    http.request(request)
  rescue StandardError
    # Fire-and-forget: never affect the host app
  end
end

.configuration ⇒ Object 



26
27
28
 
# File 'lib/bugwatch.rb', line 26

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



30
31
32
 
# File 'lib/bugwatch.rb', line 30

def configure
  yield configuration
end

.db_query_buffer ⇒ Object 



138
139
140
 
# File 'lib/bugwatch.rb', line 138

def db_query_buffer
  @db_query_buffer ||= DbQueryBuffer.new(config: configuration)
end

.leave_breadcrumb(message, type: "manual", metadata: {}) ⇒ Object 



64
65
66
 
# File 'lib/bugwatch.rb', line 64

def leave_breadcrumb(message, type: "manual", metadata: {})
  BreadcrumbCollector.add(message, type: type, metadata: metadata)
end

.notify(exception, context: {}) ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'lib/bugwatch.rb', line 34

def notify(exception, context: {})
  return if configuration.ignore?(exception)
  return unless configuration.notify_for_release_stage?

  payload = ErrorBuilder.new(exception).build
  payload.merge!(context)
  Notification.new(payload).deliver
end

.report(title, category: "other", severity: "warning", tags: {}) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/bugwatch.rb', line 43

def report(title, category: "other", severity: "warning", tags: {})
  return unless configuration.notify_for_release_stage?
  return if title.to_s.strip.empty?

  payload = ReportBuilder.new(title, category: category, severity: severity, tags: tags).build
  Notification.new(payload).deliver
end

.send_feedback(message, email: nil, name: nil, url: nil, issue_id: nil, metadata: {}) ⇒ Object 



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

def send_feedback(message, email: nil, name: nil, url: nil, issue_id: nil, metadata: {})
  return if message.to_s.strip.empty?

  FeedbackSender.new(
    message: message, email: email, name: name,
    url: url, issue_id: issue_id, metadata: metadata
  ).deliver
end

.set_user(id: nil, email: nil, name: nil, **custom) ⇒ Object 



60
61
62
 
# File 'lib/bugwatch.rb', line 60

def set_user(id: nil, email: nil, name: nil, **custom)
  UserContext.set(id: id, email: email, name: name, **custom)
end

.skip_tracking? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/bugwatch.rb', line 130

def skip_tracking?
  Thread.current[:bugwatch_skip_tracking] == true
end

.track_deploy(version:, environment: nil, description: nil, deployed_by: nil) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/bugwatch.rb', line 91

def track_deploy(version:, environment: nil, description: nil, deployed_by: nil)
  return unless configuration.api_key
  return unless configuration.endpoint

  env = environment || configuration.release_stage

  Thread.new do
    uri = URI.parse("#{configuration.endpoint.chomp("/")}/api/v1/deploys")

    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl       = uri.scheme == "https"
    http.open_timeout  = 3
    http.read_timeout  = 3
    http.write_timeout = 3

    request = Net::HTTP::Post.new(uri.path)
    request["Content-Type"]    = "application/json"
    request["X-Api-Key"]       = configuration.api_key
    request["X-BugWatch-Ruby"] = Bugwatch::VERSION

    payload = { version: version, environment: env, deployed_at: Time.now.iso8601 }
    payload[:description] = description if description
    payload[:deployed_by] = deployed_by if deployed_by

    request.body = JSON.generate(payload)

    http.request(request)
  rescue StandardError
    # Fire-and-forget: never affect the host app
  end
end

.transaction_buffer ⇒ Object 



134
135
136
 
# File 'lib/bugwatch.rb', line 134

def transaction_buffer
  @transaction_buffer ||= TransactionBuffer.new(config: configuration)
end

.without_tracking ⇒ Object 



123
124
125
126
127
128
 
# File 'lib/bugwatch.rb', line 123

def without_tracking
  Thread.current[:bugwatch_skip_tracking] = true
  yield
ensure
  Thread.current[:bugwatch_skip_tracking] = false
end