/usr/share/perl5/Swatch/Threshold.pm is in swatch 3.2.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | package Swatch::Threshold;
require 5.000;
require Exporter;
use strict;
use Carp;
use Date::Calc;
use Date::Manip;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
@ISA = qw(Exporter);
@EXPORT = qw/
threshold
/;
$VERSION = '20060721';
#
# $thresholds = ( # List of Hashes
# <swid1> => { # swatch ID generated for each "watchfor" value
# <key1> => { # TRACK_BY value
# FIRST => seconds # time of first instance of this key
# EVENTS => <int>, # num of logs seen since last report
# },
# <key2> => {
# ...
# },
# ...
# },
# <swid2> => {
# ...
# },
# ...
# );
my $thresholds = {};
my $debug = 1;
################################################################
# threshold() -
################################################################
sub threshold {
my %opts = (
SWID => '0',
DEBUG => 0,
# TYPE
# TRACK_BY
# COUNT
# SECONDS
@_
);
my ($takeAction,$doNothing) = (1,0);
my $withinInterval = 1;
my $time = time();
my $endOfInterval = 0;
if (exists($thresholds->{$opts{SWID}})
and exists($thresholds->{$opts{SWID}}{$opts{TRACK_BY}})) {
$endOfInterval = $thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{FIRST} + $opts{SECONDS};
$withinInterval = ($endOfInterval > $time) ? 1 : 0;
}
####### TYPE is LIMIT #######
if ($opts{TYPE} eq 'limit') {
#
# Alert on the 1st COUNT events during the time interval, then ignore events
# for the rest of the time interval.
#
if (exists($thresholds->{$opts{SWID}}{$opts{TRACK_BY}})) {
if ($thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} < $opts{COUNT}) {
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS}++;
return $takeAction;
} elsif (not $withinInterval) {
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} = 1;
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{FIRST} = $time;
return $takeAction;
} else {
return $doNothing;
}
} else {
add_threshold(%opts);
return $takeAction;
}
####### TYPE is THRESHOLD #######
} elsif ($opts{TYPE} eq 'threshold') {
#
# Alert every COUNT times we see this event during the time interval.
#
if (exists($thresholds->{$opts{SWID}}{$opts{TRACK_BY}})) {
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS}++;
if ($withinInterval) {
if ($thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} == $opts{COUNT}) {
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} = 0;
return $takeAction;
} else {
return $doNothing;
}
} else { ### not $withinInterval ###
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{FIRST} = $time;
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} = 1;
}
} else {
add_threshold(%opts);
}
if ($opts{COUNT} == 1) {
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} = 0;
return $takeAction;
} else {
return $doNothing;
}
####### TYPE is BOTH #######
} elsif ($opts{TYPE} eq 'both') {
#
# Alert once per time interval after seeing COUNT occurrences of the event,
# then ignore any additional events during the time interval.
#
if (exists($thresholds->{$opts{SWID}}{$opts{TRACK_BY}})) {
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS}++;
if ($withinInterval and
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} == $opts{COUNT}) {
return $takeAction;
} elsif (not $withinInterval) {
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} = 1;
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{FIRST} = $time;
}
} else {
add_threshold(%opts);
}
if ($thresholds->{$opts{SWID}}{$opts{TRACK_BY}}{EVENTS} == $opts{COUNT}) {
return $takeAction;
} else {
return $doNothing;
}
####### TYPE is incorrectly defined #######
} else {
die "Swatch::Threshold - unknown type, $opts{TYPE} given\n";
}
}
################################################################
sub add_threshold {
my %opts = (@_);
my $rec = {};
$rec->{EVENTS} = 1;
$rec->{FIRST} = time();
$thresholds->{$opts{SWID}}{$opts{TRACK_BY}} = $rec;
}
################################################################
## The POD ###
=head1 NAME
Swatch::Threshold - Perl extension for thresholding in swatch(1)
=head1 SYNOPSIS
use Swatch::Threshold;
&Swatch::threshold( SWID => <int>,
TYPE => <limit|threshold|both>,
TRACK_BY => <key>, # like an IP addr
COUNT => <int>,
SECONDS => <int>
);
=head1 SWATCH SYNTAX
threshold track_by=<key>,
type=<limit|threshold|both>,
count=<int>,
seconds=<int>
=head1 DESCRIPTION
SWID is swatch's internal ID number for the watchfor block
TYPE can be limit, threshold, or both
Limit - Alert on the 1st COUNT events during the time interval,
then ignore events for the rest of the time interval.
Threshold - Alert every COUNT times we see this event during the
time interval.
Both
Alert once per time interval after seeing COUNT occurrences of the
event, then ignore any additional events during the time interval.
SECONDS is the time interval
=head1 AUTHOR
E. Todd Atkins, todd.atkins@stanfordalumni.org
=head1 SEE ALSO
perl(1), swatch(1).
=cut
1;
|