Class: Sensu::Handler

Inherits:
Object
  • Object
show all
Includes:
Mixlib::CLI, Plugin::Utils
Defined in:
lib/sensu-handler.rb

Constant Summary collapse

@@autorun =

This works just like Plugin::CLI’s autorun.

self

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Plugin::Utils

#config_files, #load_config, #net_http_req_class, #read_event, #settings

Constructor Details

#initialize(argv = ARGV) ⇒ Handler

Returns a new instance of Handler.



14
15
16
17
 
# File 'lib/sensu-handler.rb', line 14

def initialize(argv = ARGV)
  super()
  self.argv = parse_options(argv)
end

Instance Attribute Details

#argv ⇒ Object

Returns the value of attribute argv.



12
13
14
 
# File 'lib/sensu-handler.rb', line 12

def argv
  @argv
end

Class Method Details

.disable_autorun ⇒ Object 



46
47
48
 
# File 'lib/sensu-handler.rb', line 46

def self.disable_autorun
  @@autorun = false
end

.method_added(name) ⇒ Object 



39
40
41
42
43
 
# File 'lib/sensu-handler.rb', line 39

def method_added(name)
  if name == :handle
    @@autorun = self
  end
end

Instance Method Details

#api_request(method, path) {|req| ... } ⇒ Object

Yields:

  • (req) 


78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/sensu-handler.rb', line 78

def api_request(method, path, &blk)
  if not settings.has_key?('api')
    raise "api.json settings not found."
  end
  http = Net::HTTP.new(settings['api']['host'], settings['api']['port'])
  req = net_http_req_class(method).new(path)
  if settings['api']['user'] && settings['api']['password']
    req.basic_auth(settings['api']['user'], settings['api']['password'])
  end
  yield(req) if block_given?
  http.request(req)
end

#bail(msg) ⇒ Object 



73
74
75
76
 
# File 'lib/sensu-handler.rb', line 73

def bail(msg)
  puts msg + ': ' + @event['client']['name'] + '/' + @event['check']['name']
  exit 0
end

#event_exists?(client, check) ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/sensu-handler.rb', line 147

def event_exists?(client, check)
  api_request(:GET, '/event/' + client + '/' + check).code == '200'
end

#event_summary(trim_at = 100) ⇒ Object

Helpers and filters.



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/sensu-handler.rb', line 61

def event_summary(trim_at=100)
  summary = @event['check']['notification'] || @event['check']['description']
  if summary.nil?
    source = @event['check']['source'] || @event['client']['name']
    event_context = [source, @event['check']['name']].join('/')
    output = @event['check']['output'].chomp
    output = output.length > trim_at ? output[0..trim_at] + '...' : output
    summary = [event_context, output].join(' : ')
  end
  summary
end

#filter ⇒ Object

Filters exit the proccess if the event should not be handled. Implementation of the default filters is below.



28
29
30
31
32
33
 
# File 'lib/sensu-handler.rb', line 28

def filter
  filter_disabled
  filter_repeated
  filter_silenced
  filter_dependencies
end

#filter_dependencies ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/sensu-handler.rb', line 151

def filter_dependencies
  if @event['check'].has_key?('dependencies')
    if @event['check']['dependencies'].is_a?(Array)
      @event['check']['dependencies'].each do |dependency|
        begin
          timeout(2) do
            check, client = dependency.split('/').reverse
            if event_exists?(client || @event['client']['name'], check)
              bail 'check dependency event exists'
            end
          end
        rescue Errno::ECONNREFUSED
          puts 'connection refused attempting to query the sensu api for an event'
        rescue Timeout::Error
          puts 'timed out while attempting to query the sensu api for an event'
        end
      end
    end
  end
end

#filter_disabled ⇒ Object 



91
92
93
94
95
 
# File 'lib/sensu-handler.rb', line 91

def filter_disabled
  if @event['check']['alert'] == false
    bail 'alert disabled'
  end
end

#filter_repeated ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/sensu-handler.rb', line 97

def filter_repeated
  defaults = {
    'occurrences' => 1,
    'interval' => 30,
    'refresh' => 1800
  }

  if settings['sensu_plugin'].is_a?(Hash)
    defaults.merge!(settings['sensu_plugin'])
  end

  occurrences = (@event['check']['occurrences'] || defaults['occurrences']).to_i
  interval = (@event['check']['interval'] || defaults['interval']).to_i
  refresh = (@event['check']['refresh'] || defaults['refresh']).to_i
  if @event['occurrences'] < occurrences
    bail 'not enough occurrences'
  end
  if @event['occurrences'] > occurrences && @event['action'] == 'create'
    number = refresh.fdiv(interval).to_i
    unless number == 0 || @event['occurrences'] % number == 0
      bail 'only handling every ' + number.to_s + ' occurrences'
    end
  end
end

#filter_silenced ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/sensu-handler.rb', line 126

def filter_silenced
  stashes = [
    ['client', '/silence/' + @event['client']['name']],
    ['check', '/silence/' + @event['client']['name'] + '/' + @event['check']['name']],
    ['check', '/silence/all/' + @event['check']['name']]
  ]
  stashes.each do |(scope, path)|
    begin
      timeout(2) do
        if stash_exists?(path)
          bail scope + ' alerts silenced'
        end
      end
    rescue Errno::ECONNREFUSED
      puts 'connection refused attempting to query the sensu api for a stash'
    rescue Timeout::Error
      puts 'timed out while attempting to query the sensu api for a stash'
    end
  end
end

#handle ⇒ Object

Implementing classes should override this.



21
22
23
 
# File 'lib/sensu-handler.rb', line 21

def handle
  puts 'ignoring event -- no handler defined'
end

#stash_exists?(path) ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/sensu-handler.rb', line 122

def stash_exists?(path)
  api_request(:GET, '/stash' + path).code == '200'
end