Class: Interferon::Destinations::Datadog

Inherits:
Object
  • Object
show all
Includes:
Logging
Defined in:
lib/interferon/destinations/datadog.rb

Constant Summary collapse

ALERT_KEY = 
'This alert was created via the alerts framework'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

configure_logger_for, #log, #statsd

Constructor Details

#initialize(options) ⇒ Datadog

Returns a new instance of Datadog.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/interferon/destinations/datadog.rb', line 11

def initialize(options)
  %w{app_key api_key}.each do |req|
    unless options[req]
      raise ArgumentError, "missing required argument #{req}"
    end
  end

  @dog = Dogapi::Client.new(options['api_key'], options['app_key'])
  @dry_run = !!options['dry_run']
  @existing_alerts = nil

  # create datadog alerts 10 at a time
  @concurrency = 10

  @stats = {
    :alerts_created => 0,
    :alerts_updated => 0,
    :alerts_deleted => 0,
    :alerts_silenced => 0,
    :api_successes => 0,
    :api_client_errors => 0,
    :api_unknown_errors => 0,
    :manually_created_alerts => 0,
  }
end

Instance Attribute Details

#concurrency ⇒ Object

Returns the value of attribute concurrency.



8
9
10
 
# File 'lib/interferon/destinations/datadog.rb', line 8

def concurrency
  @concurrency
end

Instance Method Details

#create_alert(alert, people) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/interferon/destinations/datadog.rb', line 58

def create_alert(alert, people)
  # create a message which includes the notifications
  message = [
    alert['message'],
    ALERT_KEY,
    people.map{ |p| "@#{p}" }
  ].flatten.join("\n")

  # create the hash of options to send to datadog
  alert_opts = {
    :name => alert['name'],
    :message => message,
    :silenced => alert['silenced'] || alert['silenced_until'] > Time.now,
    :notify_no_data => alert['notify_no_data'],
    :timeout_h => nil,
  }

  # allow an optional timeframe for "no data" alerts to be specified
  # (this feature is supported, even though it's not documented)
  alert_opts[:no_data_timeframe] = alert['no_data_timeframe'] if alert['no_data_timeframe']

  # timeout is in seconds, but set it to 1 hour at least
  alert_opts[:timeout_h] = [1, (alert['timeout'].to_i / 3600)].max if alert['timeout']

  # new alert, create it
  if existing_alerts[alert['name']].nil?
    action = :creating
    log.debug("new alert #{alert['name']}")

    resp = @dog.alert(
      alert['metric']['datadog_query'].strip,
      alert_opts,
    ) unless @dry_run

  # existing alert, modify it
  else
    action = :updating
    id = existing_alerts[alert['name']]['id']
    log.debug("updating existing alert #{id} (#{alert['name']})")

    resp = @dog.update_alert(
      id,
      alert['metric']['datadog_query'].strip,
      alert_opts
    ) unless @dry_run
  end

  # log whenever we've encountered errors
  code = @dry_run ? 200 : resp[0].to_i

  # client error
  if code == 400
    statsd.gauge('datadog.api.unknown_error', 0, :tags => ["alert:#{alert}"])
    statsd.gauge('datadog.api.client_error', 1, :tags => ["alert:#{alert}"])
    statsd.gauge('datadog.api.success', 0, :tags => ["alert:#{alert}"])

    @stats[:api_client_errors] += 1
    log.error("client error while #{action} alert '#{alert['name']}';" \
        " query was '#{alert['metric']['datadog_query'].strip}'")

  # unknown (prob. datadog) error:
  elsif code >= 400 || code == -1
    statsd.gauge('datadog.api.unknown_error', 1, :tags => ["alert:#{alert}"])
    statsd.gauge('datadog.api.client_error', 0, :tags => ["alert:#{alert}"])
    statsd.gauge('datadog.api.success', 0, :tags => ["alert:#{alert}"])

    @stats[:api_unknown_errors] += 1
    log.error("unknown error while #{action} alert '#{alert['name']}':" \
        " query was '#{alert['metric']['datadog_query'].strip}'" \
        " response was #{resp[0]}:'#{resp[1].inspect}'")

  # assume this was a success
  else
    statsd.gauge('datadog.api.unknown_error', 0, :tags => ["alert:#{alert}"])
    statsd.gauge('datadog.api.client_error', 0, :tags => ["alert:#{alert}"])
    statsd.gauge('datadog.api.success', 1, :tags => ["alert:#{alert}"])

    @stats[:api_successes] += 1
    @stats[:alerts_created] += 1 if action == :creating
    @stats[:alerts_updated] += 1 if action == :updating
    @stats[:alerts_silenced] += 1 if alert_opts[:silenced]
  end

  # lets key alerts by their name
  return alert['name']
end

#existing_alerts ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/interferon/destinations/datadog.rb', line 37

def existing_alerts
  unless @existing_alerts
    resp = @dog.get_all_alerts()
    alerts = resp[1]['alerts']

    # key alerts by name
    @existing_alerts = Hash[alerts.map{ |a| [a['name'], a] }]

    # count how many are manually created
    @stats[:manually_created_alerts] = \
      @existing_alerts.reject{|n,a| a['message'].include?(ALERT_KEY)}.length

    log.info "datadog: found %d existing alerts; %d were manually created" % [
      @existing_alerts.length,
      @stats[:manually_created_alerts],
    ]
  end

  return @existing_alerts
end

#remove_alert(alert) ⇒ Object 



145
146
147
148
149
150
151
152
153
 
# File 'lib/interferon/destinations/datadog.rb', line 145

def remove_alert(alert)
  if alert['message'].include?(ALERT_KEY)
    log.debug("deleting alert #{alert['id']} (#{alert['name']})")
    @dog.delete_alert(alert['id']) unless @dry_run
    @stats[:alerts_deleted] += 1
  else
    log.warn("not deleting manually-created alert #{alert['id']} (#{alert['name']})")
  end
end

#report_stats ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/interferon/destinations/datadog.rb', line 155

def report_stats
  @stats.each do |k,v|
    statsd.gauge("datadog.#{k}", v)
  end

  log.info "datadog: created %d updated %d and deleted %d alerts" % [
    @stats[:alerts_created],
    @stats[:alerts_updated],
    @stats[:alerts_deleted],
  ]
end