Module: Blazer

Defined in:
lib/blazer.rb,
lib/blazer/engine.rb,
lib/blazer/result.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/record.rb,
lib/blazer/run_statement.rb,
app/models/blazer/dashboard.rb,
app/models/blazer/connection.rb,
lib/blazer/run_statement_job.rb,
app/helpers/blazer/base_helper.rb,
app/mailers/blazer/check_mailer.rb,
lib/blazer/adapters/sql_adapter.rb,
lib/blazer/adapters/base_adapter.rb,
app/mailers/blazer/slack_notifier.rb,
app/models/blazer/dashboard_query.rb,
lib/blazer/adapters/drill_adapter.rb,
lib/blazer/adapters/druid_adapter.rb,
lib/blazer/adapters/athena_adapter.rb,
lib/blazer/adapters/presto_adapter.rb,
lib/blazer/adapters/mongodb_adapter.rb,
lib/blazer/adapters/bigquery_adapter.rb,
lib/blazer/adapters/cassandra_adapter.rb,
lib/blazer/adapters/snowflake_adapter.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,
lib/blazer/adapters/elasticsearch_adapter.rb,
app/controllers/blazer/dashboards_controller.rb

Defined Under Namespace

Modules: Adapters, BaseHelper, Generators Classes: Audit, BaseController, Check, CheckMailer, ChecksController, Connection, Dashboard, DashboardQuery, DashboardsController, DataSource, Engine, Error, QueriesController, Query, Record, Result, RunStatement, RunStatementJob, SlackNotifier, TimeoutNotSupported

Constant Summary collapse

TIMEOUT_MESSAGE = 
"Query timed out :("
TIMEOUT_ERRORS = 
[
  "canceling statement due to statement timeout", # postgres
  "canceling statement due to conflict with recovery", # 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 = 
"2.0.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.anomaly_checks ⇒ Object

Returns the value of attribute anomaly_checks.



37
38
39
 
# File 'lib/blazer.rb', line 37

def anomaly_checks
  @anomaly_checks
end

.async ⇒ Object

Returns the value of attribute async.



38
39
40
 
# File 'lib/blazer.rb', line 38

def async
  @async
end

.audit ⇒ Object

Returns the value of attribute audit.



27
28
29
 
# File 'lib/blazer.rb', line 27

def audit
  @audit
end

.before_action ⇒ Object

Returns the value of attribute before_action.



32
33
34
 
# File 'lib/blazer.rb', line 32

def before_action
  @before_action
end

.cache ⇒ Object

Returns the value of attribute cache.



34
35
36
 
# File 'lib/blazer.rb', line 34

def cache
  @cache
end

.check_schedules ⇒ Object

Returns the value of attribute check_schedules.



36
37
38
 
# File 'lib/blazer.rb', line 36

def check_schedules
  @check_schedules
end

.from_email ⇒ Object

Returns the value of attribute from_email.



33
34
35
 
# File 'lib/blazer.rb', line 33

def from_email
  @from_email
end

.images ⇒ Object

Returns the value of attribute images.



39
40
41
 
# File 'lib/blazer.rb', line 39

def images
  @images
end

.override_csp ⇒ Object

Returns the value of attribute override_csp.



42
43
44
 
# File 'lib/blazer.rb', line 42

def override_csp
  @override_csp
end

.query_editable ⇒ Object

Returns the value of attribute query_editable.



41
42
43
 
# File 'lib/blazer.rb', line 41

def query_editable
  @query_editable
end

.query_viewable ⇒ Object

Returns the value of attribute query_viewable.



40
41
42
 
# File 'lib/blazer.rb', line 40

def query_viewable
  @query_viewable
end

.slack_webhook_url ⇒ Object

Returns the value of attribute slack_webhook_url.



43
44
45
 
# File 'lib/blazer.rb', line 43

def slack_webhook_url
  @slack_webhook_url
end

.time_zone ⇒ Object

Returns the value of attribute time_zone.



28
29
30
 
# File 'lib/blazer.rb', line 28

def time_zone
  @time_zone
end

.transform_statement ⇒ Object

Returns the value of attribute transform_statement.



35
36
37
 
# File 'lib/blazer.rb', line 35

def transform_statement
  @transform_statement
end

.user_class ⇒ Object 



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

def self.user_class
  if !defined?(@user_class)
    @user_class = settings.key?("user_class") ? settings["user_class"] : (User.name rescue nil)
  end
  @user_class
end

.user_method ⇒ Object 



76
77
78
79
80
81
82
83
84
 
# File 'lib/blazer.rb', line 76

def self.user_method
  if !defined?(@user_method)
    @user_method = settings["user_method"]
    if user_class
      @user_method ||= "current_#{user_class.to_s.downcase.singularize}"
    end
  end
  @user_method
end

.user_name ⇒ Object

Returns the value of attribute user_name.



29
30
31
 
# File 'lib/blazer.rb', line 29

def user_name
  @user_name
end

Class Method Details

.adapters ⇒ Object 



205
206
207
 
# File 'lib/blazer.rb', line 205

def self.adapters
  @adapters ||= {}
end

.data_sources ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/blazer.rb', line 97

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

    # TODO Blazer 2.0
    # ds2 = Hash.new { |hash, key| raise Blazer::Error, "Unknown data source: #{key}" }
    # ds.each do |k, v|
    #   ds2[k] = v
    # end
    # ds2
  end
end

.extract_vars(statement) ⇒ Object 



116
117
118
119
120
 
# File 'lib/blazer.rb', line 116

def self.extract_vars(statement)
  # strip commented out lines
  # and regex {1} or {1,2}
  statement.gsub(/\-\-.+/, "").gsub(/\/\*.+\*\//m, "").scan(/\{\w*?\}/i).map { |v| v[1...-1] }.reject { |v| /\A\d+(\,\d+)?\z/.match(v) || v.empty? }.uniq
end

.register_adapter(name, adapter) ⇒ Object 



209
210
211
 
# File 'lib/blazer.rb', line 209

def self.register_adapter(name, adapter)
  adapters[name] = adapter
end

.run_check(check) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/blazer.rb', line 131

def self.run_check(check)
  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
      result = data_source.run_statement(statement, refresh_cache: true, check: check, query: check.query)
      if result.timed_out?
        Rails.logger.info "[blazer timeout] query=#{check.query.name}"
        tries += 1
        sleep(10)
      elsif result.error.to_s.start_with?("PG::ConnectionBad")
        data_source.reconnect
        Rails.logger.info "[blazer reconnect] query=#{check.query.name}"
        tries += 1
        sleep(10)
      else
        break
      end
    end

    begin
      check.reload # in case state has changed since job started
      check.update_state(result)
    rescue ActiveRecord::RecordNotFound
      # check deleted
    end

    # TODO use proper logfmt
    Rails.logger.info "[blazer check] query=#{check.query.name} state=#{check.state} rows=#{result.rows.try(:size)} error=#{result.error}"

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

.run_checks(schedule: nil) ⇒ Object 



122
123
124
125
126
127
128
129
 
# File 'lib/blazer.rb', line 122

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

.send_failing_checks ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/blazer.rb', line 175

def self.send_failing_checks
  emails = {}
  slack_channels = {}

  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
    check.split_slack_channels.each do |channel|
      (slack_channels[channel] ||= []) << check
    end
  end

  emails.each do |email, checks|
    Safely.safely do
      Blazer::CheckMailer.failing_checks(email, checks).deliver_now
    end
  end

  slack_channels.each do |channel, checks|
    Safely.safely do
      Blazer::SlackNotifier.failing_checks(channel, checks)
    end
  end
end

.settings ⇒ Object 



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/blazer.rb', line 86

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

.slack? ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/blazer.rb', line 201

def self.slack?
  slack_webhook_url.present?
end