blazer.rb 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. require "csv"
  2. require "yaml"
  3. require "chartkick"
  4. require "blazer/version"
  5. require "blazer/data_source"
  6. require "blazer/engine"
  7. require "safely/core"
  8. module Blazer
  9. class Error < StandardError; end
  10. class TimeoutNotSupported < Error; end
  11. class << self
  12. attr_accessor :audit
  13. attr_reader :time_zone
  14. attr_accessor :user_name
  15. attr_accessor :user_class
  16. attr_accessor :user_method
  17. attr_accessor :before_action
  18. attr_accessor :from_email
  19. attr_accessor :cache
  20. attr_accessor :transform_statement
  21. attr_accessor :check_schedules
  22. attr_accessor :anomaly_checks
  23. end
  24. self.audit = true
  25. self.user_name = :name
  26. self.check_schedules = ["5 minutes", "1 hour", "1 day"]
  27. self.anomaly_checks = false
  28. TIMEOUT_MESSAGE = "Query timed out :("
  29. TIMEOUT_ERRORS = [
  30. "canceling statement due to statement timeout", # postgres
  31. "canceling statement due to conflict with recovery", # postgres
  32. "cancelled on user's request", # redshift
  33. "canceled on user's request", # redshift
  34. "system requested abort", # redshift
  35. "maximum statement execution time exceeded" # mysql
  36. ]
  37. BELONGS_TO_OPTIONAL = {}
  38. BELONGS_TO_OPTIONAL[:optional] = true if Rails::VERSION::MAJOR >= 5
  39. def self.time_zone=(time_zone)
  40. @time_zone = time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone[time_zone.to_s]
  41. end
  42. def self.settings
  43. @settings ||= begin
  44. path = Rails.root.join("config", "blazer.yml").to_s
  45. if File.exist?(path)
  46. YAML.load(ERB.new(File.read(path)).result)
  47. else
  48. {}
  49. end
  50. end
  51. end
  52. def self.data_sources
  53. @data_sources ||= begin
  54. ds = Hash[
  55. settings["data_sources"].map do |id, s|
  56. [id, Blazer::DataSource.new(id, s)]
  57. end
  58. ]
  59. ds.default = ds.values.first
  60. ds
  61. end
  62. end
  63. def self.run_checks(schedule: nil)
  64. checks = Blazer::Check.includes(:query)
  65. checks = checks.where(schedule: schedule) if schedule
  66. checks.find_each do |check|
  67. next if check.state == "disabled"
  68. Safely.safely { run_check(check) }
  69. end
  70. end
  71. def self.run_check(check)
  72. rows = nil
  73. error = nil
  74. tries = 1
  75. ActiveSupport::Notifications.instrument("run_check.blazer", check_id: check.id, query_id: check.query.id, state_was: check.state) do |instrument|
  76. # try 3 times on timeout errors
  77. data_source = data_sources[check.query.data_source]
  78. statement = check.query.statement
  79. Blazer.transform_statement.call(data_source, statement) if Blazer.transform_statement
  80. while tries <= 3
  81. columns, rows, error, cached_at = data_source.run_statement(statement, refresh_cache: true, check: check, query: check.query)
  82. if error == Blazer::TIMEOUT_MESSAGE
  83. Rails.logger.info "[blazer timeout] query=#{check.query.name}"
  84. tries += 1
  85. sleep(10)
  86. elsif error.to_s.start_with?("PG::ConnectionBad")
  87. data_source.reconnect
  88. Rails.logger.info "[blazer reconnect] query=#{check.query.name}"
  89. tries += 1
  90. sleep(10)
  91. else
  92. break
  93. end
  94. end
  95. check.update_state(columns, rows, error, data_source)
  96. # TODO use proper logfmt
  97. Rails.logger.info "[blazer check] query=#{check.query.name} state=#{check.state} rows=#{rows.try(:size)} error=#{error}"
  98. instrument[:statement] = statement
  99. instrument[:data_source] = data_source
  100. instrument[:state] = check.state
  101. instrument[:rows] = rows.try(:size)
  102. instrument[:error] = error
  103. instrument[:tries] = tries
  104. end
  105. end
  106. def self.send_failing_checks
  107. emails = {}
  108. Blazer::Check.includes(:query).where(state: ["failing", "error", "timed out", "disabled"]).find_each do |check|
  109. check.split_emails.each do |email|
  110. (emails[email] ||= []) << check
  111. end
  112. end
  113. emails.each do |email, checks|
  114. Blazer::CheckMailer.failing_checks(email, checks).deliver_later
  115. end
  116. end
  117. def self.column_types(columns, rows, boom = {})
  118. columns.each_with_index.map do |k, i|
  119. v = (rows.find { |r| r[i] } || {})[i]
  120. if boom[k]
  121. "string"
  122. elsif v.is_a?(Numeric)
  123. "numeric"
  124. elsif v.is_a?(Time) || v.is_a?(Date)
  125. "time"
  126. elsif v.nil?
  127. nil
  128. else
  129. "string"
  130. end
  131. end
  132. end
  133. def self.chart_type(column_types)
  134. if column_types.compact.size >= 2 && column_types.compact == ["time"] + (column_types.compact.size - 1).times.map { "numeric" }
  135. "line"
  136. elsif column_types == ["time", "string", "numeric"]
  137. "line2"
  138. elsif column_types.compact.size >= 2 && column_types == ["string"] + (column_types.compact.size - 1).times.map { "numeric" }
  139. "bar"
  140. end
  141. end
  142. def self.detect_anomaly(columns, rows, data_source)
  143. anomaly = nil
  144. message = nil
  145. if rows.empty?
  146. message = "No data"
  147. else
  148. boom = self.boom(columns, rows, data_source)
  149. chart_type = self.chart_type(column_types(columns, rows, boom))
  150. if chart_type == "line" || chart_type == "line2"
  151. series = []
  152. if chart_type == "line"
  153. columns[1..-1].each_with_index.each do |k, i|
  154. series << {name: k, data: rows.map{ |r| [r[0], r[i + 1]] }}
  155. end
  156. else
  157. rows.group_by { |r| v = r[1]; (boom[columns[1]] || {})[v.to_s] || v }.each_with_index.map do |(name, v), i|
  158. series << {name: name, data: v.map { |v2| [v2[0], v2[2]] }}
  159. end
  160. end
  161. current_series = nil
  162. begin
  163. anomalies = []
  164. series.each do |s|
  165. current_series = s[:name]
  166. anomalies << s[:name] if anomaly?(s[:data])
  167. end
  168. anomaly = anomalies.any?
  169. if anomaly
  170. if anomalies.size == 1
  171. message = "Anomaly detected in #{anomalies.first}"
  172. else
  173. message = "Anomalies detected in #{anomalies.to_sentence}"
  174. end
  175. else
  176. message = "No anomalies detected"
  177. end
  178. rescue => e
  179. message = "#{current_series}: #{e.message}"
  180. end
  181. else
  182. message = "Bad format"
  183. end
  184. end
  185. [anomaly, message]
  186. end
  187. def self.anomaly?(series)
  188. series = series.reject { |v| v[0].nil? }.sort_by { |v| v[0] }
  189. csv_str =
  190. CSV.generate do |csv|
  191. csv << ["timestamp", "count"]
  192. series.each do |row|
  193. csv << row
  194. end
  195. end
  196. timestamps = []
  197. r_script = %x[which Rscript].chomp
  198. raise "R not found" if r_script.empty?
  199. output = %x[#{r_script} --vanilla #{File.expand_path("../blazer/detect_anomalies.R", __FILE__)} #{Shellwords.escape(csv_str)}]
  200. if output.empty?
  201. raise "Unknown R error"
  202. end
  203. rows = CSV.parse(output, headers: true)
  204. error = rows.first && rows.first["x"]
  205. raise error if error
  206. rows.each do |row|
  207. timestamps << Time.parse(row["timestamp"])
  208. end
  209. timestamps.include?(series.last[0].to_time)
  210. end
  211. def self.boom(columns, rows, data_source)
  212. boom = {}
  213. columns.each_with_index do |key, i|
  214. query = data_source.smart_columns[key]
  215. if query
  216. values = rows.map { |r| r[i] }.compact.uniq
  217. columns, rows2, error, cached_at = data_source.run_statement(ActiveRecord::Base.send(:sanitize_sql_array, [query.sub("{value}", "(?)"), values]))
  218. boom[key] = Hash[rows2.map { |k, v| [k.to_s, v] }]
  219. end
  220. end
  221. boom
  222. end
  223. end