summaryrefslogtreecommitdiffstats
path: root/scripts/nagios_blocker_checker.pl
blob: 01a7b7348c223987a7e2ed8b1f2778a52363e703 (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
#!/usr/bin/perl

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

use strict;
use warnings;
use lib qw(. lib local/lib/perl5);

use Bugzilla;
use Bugzilla::Logging;
use Bugzilla::Constants;
use Bugzilla::Product;
use Bugzilla::User;
use Getopt::Long;
use English qw(-no_match_vars);

Bugzilla->usage_mode(USAGE_MODE_CMDLINE);
Bugzilla->error_mode(ERROR_MODE_DIE);
use Try::Tiny; # bmo ships with this nowadays

my $config = {
    # filter by assignee, product or component
    assignee        => '',
    product         => '',
    component       => '',
    unassigned      => Bugzilla->params->{'nobody_user'},
    # severities
    severity        => 'major,critical,blocker',
    # time in hours to wait before paging/warning
    major_alarm     => 24,
    major_warn      => 20,
    critical_alarm  => 8,
    critical_warn   => 5,
    blocker_alarm   => 0,
    blocker_warn    => 0,
    any_alarm       => 24,
    any_warn        => 20,
    # time in seconds before terminating this script
    # 300 chosen as it is longer than the default NRPE timeout
    # (meaning you should never need to tweak it upward) and
    # shorter than what you are likely to do checking bugs
    # (meaning you won't pile up too many instances before they die)
    max_runtime     => 300,
};

my $usage = <<"EOF";
FILTERS

  the filter determines which bugs to check, either by assignee, product or the
  product's component. For backward compatibility, if just an email address is
  provided, it will be used as the assignee.

  --assignee <email>    filter bugs by assignee
  --product <name>      filter bugs by product name
  --component <name>    filter bugs by product's component name
  --unassigned <email>  set the unassigned user (default: $config->{unassigned})

SEVERITIES

  by default alerts and warnings will be generated for 'major', 'critical', and
  'blocker' bugs.  you can alter this list with the 'severity' switch.

  setting severity to 'any' will result in alerting on unassigned bugs
  regardless of severity.

  --severity <major|critical|blocker>[,..]
  --severity any

TIMING

  time in hours to wait before paging or warning.

  --major_alarm <hours> (default: $config->{major_alarm})
  --major_warn  <hours> (default: $config->{major_warn})
  --critical_alarm <hours> (default: $config->{critical_alarm})
  --critical_warn  <hours> (default: $config->{critical_warn})
  --blocker_alarm <hours> (default: $config->{blocker_alarm})
  --blocker_warn  <hours> (default: $config->{blocker_warn})

  when severity checking is set to "any", use the any_* switches instead:

  --any_alarm <hours> (default: $config->{any_alarm})
  --any_warn  <hours> (default: $config->{any_warn})

NAGIOS SELF-TERMINATION

  In case of a hung process, this script self-terminates.  You can adjust:

  --max_runtime <seconds> (default: $config->{max_runtime})

EXAMPLES

  nagios_blocker_checker.pl --assignee server-ops\@mozilla-org.bugs
  nagios_blocker_checker.pl server-ops\@mozilla-org.bugs
  nagios_blocker_checker.pl --product 'Release Engineering' \
    --component 'Loan Requests' \
    --severity any --any_warn 24 --any_alarm 24
EOF

GetOptions(
    'assignee=s'        => \$config->{assignee},
    'product=s'         => \$config->{product},
    'component=s'       => \$config->{component},
    'severity=s'        => \$config->{severity},
    'major_alarm=i'     => \$config->{major_alarm},
    'major_warn=i'      => \$config->{major_warn},
    'critical_alarm=i'  => \$config->{critical_alarm},
    'critical_warn=i'   => \$config->{critical_warn},
    'blocker_alarm=i'   => \$config->{blocker_alarm},
    'blocker_warn=i'    => \$config->{blocker_warn},
    'any_alarm=i'       => \$config->{any_alarm},
    'any_warn=i'        => \$config->{any_warn},
    'max_runtime=i'     => \$config->{max_runtime},
    'help|?'            => \$config->{help},
) or die $usage;

$config->{assignee} = $ARGV[0] if !$config->{assignee} && @ARGV;
die $usage if
    $config->{help}
    || !($config->{assignee} || $config->{product})
    || ($config->{assignee} && $config->{product})
    || ($config->{component} && !$config->{product})
    || !$config->{severity};

#

use constant NAGIOS_OK          => 0;
use constant NAGIOS_WARNING     => 1;
use constant NAGIOS_CRITICAL    => 2;
use constant NAGIOS_NAMES       => [qw( OK WARNING CRITICAL )];

my $current_state = NAGIOS_OK;
try {
    # Per bug 1330293, the checker script can get confused/hung up
    # if the DB rotates out from under it.  Since a long-running
    # nagios check does no good, we terminate if we stick around too long.
    local $SIG{ALRM} = sub {
        my $message = "$PROGRAM_NAME ran for longer than $config->{max_runtime} seconds and was auto-terminated.";
        FATAL($message);
        die "$message\n";
    };
    alarm($config->{max_runtime});

    my $dbh = Bugzilla->switch_to_shadow_db;
    my $any_severity = $config->{severity} eq 'any';
    my ($where, @values);

    if ($config->{assignee}) {
        $where = 'bugs.assigned_to = ?';
        push @values, Bugzilla::User->check({ name => $config->{assignee} })->id;

    } elsif ($config->{component}) {
        $where = 'bugs.product_id = ? AND bugs.component_id = ? AND bugs.assigned_to = ?';
        my $product = Bugzilla::Product->check({ name => $config->{product} });
        push @values, $product->id;
        push @values, Bugzilla::Component->check({ product => $product, name => $config->{component} })->id;
        push @values, Bugzilla::User->check({ name => $config->{unassigned} })->id;

    } else {
        $where = 'bugs.product_id = ? AND bugs.assigned_to = ?';
        push @values, Bugzilla::Product->check({ name => $config->{product} })->id;
        push @values, Bugzilla::User->check({ name => $config->{unassigned} })->id;
    }

    if (!$any_severity) {
        my $severities = join ',', map { $dbh->quote($_) } split(/,/, $config->{severity});
        $where .= " AND bug_severity IN ($severities)";
    }

    my $sql = <<"EOF";
        SELECT bug_id, bug_severity, UNIX_TIMESTAMP(bugs.creation_ts) AS ts
          FROM bugs
         WHERE $where
               AND COALESCE(resolution, '') = ''
EOF

    my $bugs = {
        'major'     => [],
        'critical'  => [],
        'blocker'   => [],
        'any'       => [],
    };
    my $current_time = time;

    foreach my $bug (@{ $dbh->selectall_arrayref($sql, { Slice => {} }, @values) }) {
        my $severity = $any_severity ? 'any' : $bug->{bug_severity};
        my $age = ($current_time - $bug->{ts}) / 3600;

        if ($age > $config->{"${severity}_alarm"}) {
            $current_state = NAGIOS_CRITICAL;
            push @{$bugs->{$severity}}, $bug->{bug_id};

        } elsif ($age > $config->{"${severity}_warn"}) {
            if ($current_state < NAGIOS_WARNING) {
                $current_state = NAGIOS_WARNING;
            }
            push @{$bugs->{$severity}}, $bug->{bug_id};

        }
    }

    print 'bugs ' . NAGIOS_NAMES->[$current_state] . ': ';
    if ($current_state == NAGIOS_OK) {
        if ($config->{severity} eq 'any') {
            print 'No unassigned bugs found.';
        } else {
            print "No $config->{severity} bugs found."
        }
    }
    foreach my $severity (qw( blocker critical major any )) {
        my $list = $bugs->{$severity};
        if (@$list) {
            printf
                '%s %s %s found https://bugzil.la/' . join(',', @$list) . ' ',
                scalar(@$list),
                ($any_severity ? 'unassigned' : $severity),
                (scalar(@$list) == 1 ? 'bug' : 'bugs');
        }
    }
    print "\n";
    alarm 0;
} catch {
    # Anything that trips an error, we're calling nagios-critical
    $current_state = NAGIOS_CRITICAL;
    #
    # Templates often have linebreaks ; nagios really prefers a status
    # to be on one line.  Here we strip out breaks, and try to make sure
    # there's spacing in place when we crunch those lines together.
    s/\s?\r?\n/ /g;
    #
    # Now, just print the status we got out.
    # Keep in mind, depending on when 'try' blew out, we may have
    # already printed SOMETHING.  Can't help that without a much more
    # thorough fix.  Our majority case here is a blowout from BZ
    # where a Product/Component went away, ala bug 1326233.
    print "$_\n";
};

exit $current_state;