Module: CloudwatchCommon

Includes:
Common
Defined in:
lib/sensu-plugins-aws/cloudwatch-common.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Common

#aws_config, #initialize

Class Method Details

.parse_dimensions(dimension_string) ⇒ Object 



61
62
63
64
65
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 61

def self.parse_dimensions(dimension_string)
  dimension_string.split(',')
                  .collect { |d| d.split '=' }
                  .collect { |a| { name: a[0], value: a[1] } }
end

Instance Method Details

#check(config) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 71

def check(config)
  resp = client.get_metric_statistics(metrics_request(config))

  no_data = resp_has_no_data(resp, config[:statistics])
  if no_data && config[:no_data_ok]
    ok "#{metric_desc} returned no data but that's ok"
  elsif no_data && !config[:no_data_ok]
    unknown "#{metric_desc} could not be retrieved"
  end

  value = read_value(resp, config[:statistics])
  base_msg = "#{metric_desc} is #{value}: comparison=#{config[:compare]}"

  if compare value, config[:critical], config[:compare]
    critical "#{base_msg} threshold=#{config[:critical]}"
  elsif config[:warning] && compare(value, config[:warning], config[:compare])
    warning "#{base_msg} threshold=#{config[:warning]}"
  else
    ok "#{base_msg}, will alarm at #{!config[:warning].nil? ? config[:warning] : config[:critical]}"
  end
end

#client ⇒ Object 



4
5
6
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 4

def client
  @client ||= Aws::CloudWatch::Client.new
end

#compare(value, threshold, compare_method) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 20

def compare(value, threshold, compare_method)
  case compare_method
  when 'greater'
    value > threshold
  when 'less'
    value < threshold
  when 'not'
    value != threshold
  else
    value == threshold
  end
end

#composite_metrics_request(metric) ⇒ Object 



56
57
58
59
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 56

def composite_metrics_request(metric)
  ## config is a class variable but don't want to change signature
  metrics_request(config).merge(metric_name: metric)
end

#dimension_string ⇒ Object 



67
68
69
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 67

def dimension_string
  config[:dimensions].map { |d| "#{d[:name]}=#{d[:value]}" }.join('&')
end

#extended_stats?(stats) ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 33

def extended_stats?(stats)
  stats[/p\d+\.\d+|p\d+/] # Check for percentile format
end

#get_metric(metric) ⇒ Object 



52
53
54
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 52

def get_metric(metric)
  client.get_metric_statistics(composite_metrics_request(metric))
end

#metrics_request(config) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 37

def metrics_request(config)
  request = {
    namespace: config[:namespace],
    metric_name: config[:metric_name],
    dimensions: config[:dimensions],
    start_time: Time.now - config[:period] * 10,
    end_time: Time.now,
    period: config[:period],
    unit: config[:unit]
  }
  stats_key = extended_stats?(config[:statistics]) ? :extended_statistics : :statistics
  request[stats_key] = [config[:statistics]]
  request
end

#read_value(resp, stats) ⇒ Object 



8
9
10
11
12
13
14
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 8

def read_value(resp, stats)
  if extended_stats? stats
    resp.datapoints.sort_by(&:timestamp).last.extended_statistics[stats]
  else
    resp.datapoints.sort_by(&:timestamp).last.send(stats.downcase)
  end
end

#resp_has_no_data(resp, stats) ⇒ Object 



16
17
18
 
# File 'lib/sensu-plugins-aws/cloudwatch-common.rb', line 16

def resp_has_no_data(resp, stats)
  resp.datapoints.nil? || resp.datapoints.empty? || resp.datapoints.first.nil? || read_value(resp, stats).nil?
end