summaryrefslogtreecommitdiff
path: root/lib/custodian/alerts/mauve.rb
blob: 0187aaf9ffbac4b418f65f38f97478fe0429c391 (plain)
1
2
3
4
5
6
7
8
9
10
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
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
174
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
require 'custodian/util/bytemark'
require 'custodian/util/dns'



#
#  This class encapsulates the raising and clearing of alerts via Mauve.
#
#  There is a helper method to update any alerts with details of whether the
# affected host is inside/outside the Bytemark network.
#
#  This is almost Bytemark-specific, although the server it talks to is
# indeed Open Source:
#
#    https://projects.bytemark.co.uk/projects/mauvealert
#
#
module Custodian

  module Alerter

    class AlertMauve < AlertFactory


      #
      # The test this alerter cares about
      #
      attr_reader :test




      #
      # Constructor
      #
      def initialize( obj )
        @test = obj

        begin
          require 'mauve/sender'
          require 'mauve/proto'
        rescue LoadError
          raise  "ERROR Loading mauvealert libraries!"
        end
      end




      #
      # Generate an alert-message which will be raised via mauve.
      #
      def raise()


        #
        # Get ready to send to mauve.
        #
        update         = Mauve::Proto::AlertUpdate.new
        update.alert   = []
        update.source  = "custodian"
        update.replace = false

        #
        # Construct a new alert structure.
        #
        alert = _get_alert( true )

        #
        #  We're raising this alert.
        #
        alert.raise_time = Time.now.to_i

        #
        #  Update it and send it
        #
        update.alert << alert
        Mauve::Sender.new( @target ).send(update)
      end



      #
      # Generate an alert-message which will be cleared via mauve.
      #
      def clear

        #
        # Get ready to send to mauve.
        #
        update = Mauve::Proto::AlertUpdate.new
        update.alert   = []
        update.source  = "custodian"
        update.replace = false

        #
        # Construct a new alert structure.
        #
        alert = _get_alert( false )

        #
        #  We're clearing this alert.
        #
        alert.clear_time = Time.now.to_i

        #
        #  Update it and send it
        #
        update.alert << alert
        Mauve::Sender.new( @target ).send(update)
      end






      #
      # Using the test object, which was set in the constructor,
      # generate a useful alert that can be fired off to mauve.
      #
      # Most of the mess of this method is ensuring there is some
      # "helpful" data in the detail-field of the alert.
      #
      def _get_alert( failure )

        #
        # The subject of an alert MUST be one of:
        #
        #   1.  Hostname.
        #   2.  IP address
        #   3.  A URL.
        #
        # We attempt to resolve the alert to the hostname, as that is more
        # readable, if we have been given an IP address.
        #
        subject = @test.target

        if ( ( subject =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/ ) ||
             ( subject =~ /^([0-9a-f:]+)$/ ) )
          res = Custodian::Util::DNS.ip_to_hostname( subject )
          if ( res )
            subject = res
          end
        end


        #
        #  The test type + test target
        #
        test_host = test.target
        test_type = test.get_type


        alert         = Mauve::Proto::Alert.new
        alert.id      = "#{test_type}-#{test_host}"
        alert.subject = subject
        alert.summary = "#{test_type}-#{test_host}"
        alert.detail  = "<p>The #{test_type} test failed against #{test_host}.</p>"

        #
        #  If we're raising then add the error
        #
        if ( failure )
          alert.detail = "#{alert.detail}\n#{test.error()}"
        end

        #
        #  Determine if this is inside/outside the bytemark network
        #
        location = expand_inside_bytemark( test_host )
        if ( !location.nil? && location.length )
          alert.detail = "#{alert.detail}\n#{location}"
        end

        #
        # Return the alert to the caller.
        #
        alert
      end


      #
      # Expand to a message indicating whether a hostname is inside the Bytemark network.
      # or not.
      #
      #
      def expand_inside_bytemark( host )

        #
        #  If the host is a URL then we need to work with the hostname component alone.
        #
        #  We'll also make the host a link that can be clicked in the alert we raise.
        #
        target = host
        if ( target =~ /^([a-z]+):\/\/([^\/]+)/ )
          target = $2.dup
          host   = "<a href=\"#{host}\">#{host}</a>"
        end


        #
        #  Resolved IP of the target
        #
        resolved = nil

        #
        #  Resolve the target to an IP, unless it is already an address.
        #
        if ( ( target =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/ ) ||
             ( target =~ /^([0-9a-f:]+)$/ ) )
          resolved = target
        else
          resolved = Custodian::Util::DNS.hostname_to_ip( target )
        end


        #
        # Did we get an error?
        #
        return "" unless ( !resolved.nil? )


        #
        #  Return the formatted message
        #
        if ( Custodian::Util::Bytemark.inside?( resolved.to_s ) )
          if ( resolved == target )
            return "<p>#{host} is inside the Bytemark network.</p>"
          else
            return "<p>#{host} resolves to #{resolved} which is inside the Bytemark network.</p>"
          end
        else
          if ( resolved == target )
            return "<p>#{host} is OUTSIDE the Bytemark network.</p>"
          else
            return "<p>#{host} resolves to #{resolved} which is OUTSIDE the Bytemark network.</p>"
          end
        end

      end


      register_alert_type "mauve"




    end
  end
end