Module: Blazer

Defined in:
lib/blazer.rb,
lib/blazer/engine.rb,
lib/blazer/version.rb,
lib/blazer/data_source.rb,
app/models/blazer/audit.rb,
app/models/blazer/check.rb,
app/models/blazer/query.rb,
app/models/blazer/dashboard.rb,
app/models/blazer/connection.rb,
app/helpers/blazer/base_helper.rb,
app/mailers/blazer/check_mailer.rb,
app/models/blazer/dashboard_query.rb,
app/controllers/blazer/base_controller.rb,
lib/generators/blazer/install_generator.rb,
app/controllers/blazer/checks_controller.rb,
app/controllers/blazer/queries_controller.rb,
app/controllers/blazer/dashboards_controller.rb

Defined Under Namespace

Modules: BaseHelper, Generators Classes: Audit, BaseController, Check, CheckMailer, ChecksController, Connection, Dashboard, DashboardQuery, DashboardsController, DataSource, Engine, Error, QueriesController, Query, TimeoutNotSupported

Constant Summary collapse

TIMEOUT_MESSAGE = 
"Query timed out :("
TIMEOUT_ERRORS = 
[
  "canceling statement due to statement timeout", # postgres
  "cancelled on user's request", # redshift
  "canceled on user's request", # redshift
  "system requested abort", # redshift
  "maximum statement execution time exceeded" # mysql
]
BELONGS_TO_OPTIONAL = 
{}
VERSION = 
"1.4.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.audit ⇒ Object

Returns the value of attribute audit.



14
15
16
 
# File 'lib/blazer.rb', line 14

def audit
  @audit
end

.before_action ⇒ Object

Returns the value of attribute before_action.



19
20
21
 
# File 'lib/blazer.rb', line 19

def before_action
  @before_action
end

.cache ⇒ Object

Returns the value of attribute cache.



21
22
23
 
# File 'lib/blazer.rb', line 21

def cache
  @cache
end

.check_schedules ⇒ Object

Returns the value of attribute check_schedules.



23
24
25
 
# File 'lib/blazer.rb', line 23

def check_schedules
  @check_schedules
end

.from_email ⇒ Object

Returns the value of attribute from_email.



20
21
22
 
# File 'lib/blazer.rb', line 20

def from_email
  @from_email
end

.time_zone ⇒ Object

Returns the value of attribute time_zone.



15
16
17
 
# File 'lib/blazer.rb', line 15

def time_zone
  @time_zone
end

.transform_statement ⇒ Object

Returns the value of attribute transform_statement.



22
23
24
 
# File 'lib/blazer.rb', line 22

def transform_statement
  @transform_statement
end

.user_class ⇒ Object

Returns the value of attribute user_class.



17
18
19
 
# File 'lib/blazer.rb', line 17

def user_class
  @user_class
end

.user_method ⇒ Object

Returns the value of attribute user_method.



18
19
20
 
# File 'lib/blazer.rb', line 18

def user_method
  @user_method
end

.user_name ⇒ Object

Returns the value of attribute user_name.



16
17
18
 
# File 'lib/blazer.rb', line 16

def user_name
  @user_name
end

Class Method Details

.data_sources ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/blazer.rb', line 55

def self.data_sources
  @data_sources ||= begin
    ds = Hash[
      settings["data_sources"].map do |id, s|
        [id, Blazer::DataSource.new(id, s)]
      end
    ]
    ds.default = ds.values.first
    ds
  end
end

.run_check(check) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/blazer.rb', line 75

def self.run_check(check)
  rows = nil
  error = nil
  tries = 1

  ActiveSupport::Notifications.instrument("run_check.blazer", check_id: check.id, query_id: check.query.id, state_was: check.state) do |instrument|
    # try 3 times on timeout errors
    data_source = data_sources[check.query.data_source]
    statement = check.query.statement
    Blazer.transform_statement.call(data_source, statement) if Blazer.transform_statement

    while tries <= 3
      columns, rows, error, cached_at = data_source.run_statement(statement, refresh_cache: true)
      if error == Blazer::TIMEOUT_MESSAGE
        Rails.logger.info "[blazer timeout] query=#{check.query.name}"
        tries += 1
        sleep(10)
      elsif error.to_s.start_with?("PG::ConnectionBad")
        data_sources[check.query.data_source].reconnect
        Rails.logger.info "[blazer reconnect] query=#{check.query.name}"
        tries += 1
        sleep(10)
      else
        break
      end
    end
    check.update_state(rows, error)
    # TODO use proper logfmt
    Rails.logger.info "[blazer check] query=#{check.query.name} state=#{check.state} rows=#{rows.try(:size)} error=#{error}"

    instrument[:statement] = statement
    instrument[:data_source] = data_source
    instrument[:state] = check.state
    instrument[:rows] = rows.try(:size)
    instrument[:error] = error
    instrument[:tries] = tries
  end
end

.run_checks(schedule: nil) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/blazer.rb', line 67

def self.run_checks(schedule: nil)
  checks = Blazer::Check.includes(:query)
  checks = checks.where(schedule: schedule) if schedule
  checks.find_each do |check|
    Safely.safely { run_check(check) }
  end
end

.send_failing_checks ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/blazer.rb', line 114

def self.send_failing_checks
  emails = {}
  Blazer::Check.includes(:query).where(state: ["failing", "error", "timed out", "disabled"]).find_each do |check|
    check.split_emails.each do |email|
      (emails[email] ||= []) << check
    end
  end

  emails.each do |email, checks|
    Blazer::CheckMailer.failing_checks(email, checks).deliver_later
  end
end

.settings ⇒ Object 



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/blazer.rb', line 44

def self.settings
  @settings ||= begin
    path = Rails.root.join("config", "blazer.yml").to_s
    if File.exist?(path)
      YAML.load(ERB.new(File.read(path)).result)
    else
      {}
    end
  end
end