2011-01-25 00:56:55 +01:00
|
|
|
# File: LagChecker.pm
|
|
|
|
# Author: pragma_
|
|
|
|
#
|
|
|
|
# Purpose: sends PING command to IRC server and times duration for PONG reply in
|
|
|
|
# order to maintain lag history and average.
|
|
|
|
|
2017-03-05 22:33:31 +01:00
|
|
|
# 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/.
|
|
|
|
|
2011-01-25 00:56:55 +01:00
|
|
|
package PBot::LagChecker;
|
|
|
|
|
|
|
|
use warnings;
|
|
|
|
use strict;
|
|
|
|
|
2019-07-11 03:40:53 +02:00
|
|
|
use feature 'unicode_strings';
|
2011-01-25 00:56:55 +01:00
|
|
|
use feature 'switch';
|
|
|
|
|
|
|
|
use Time::HiRes qw(gettimeofday tv_interval);
|
|
|
|
use Time::Duration;
|
|
|
|
use Carp ();
|
|
|
|
|
|
|
|
sub new {
|
2020-01-04 06:18:51 +01:00
|
|
|
Carp::croak("Options to LagChecker should be key/value pairs, not hash reference") if ref($_[1]) eq 'HASH';
|
2011-01-25 00:56:55 +01:00
|
|
|
my ($class, %conf) = @_;
|
|
|
|
my $self = bless {}, $class;
|
|
|
|
$self->initialize(%conf);
|
|
|
|
return $self;
|
|
|
|
}
|
|
|
|
|
|
|
|
sub initialize {
|
|
|
|
my ($self, %conf) = @_;
|
|
|
|
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot} = $conf{pbot} // Carp::croak("Missing pbot reference to LagChecker");
|
2011-01-25 00:56:55 +01:00
|
|
|
|
2014-11-01 01:15:21 +01:00
|
|
|
$self->{lag_average} = undef; # average of entries in lag history, in seconds
|
|
|
|
$self->{lag_string} = undef; # string representation of lag history and lag average
|
|
|
|
$self->{lag_history} = []; # history of previous PING/PONG timings
|
|
|
|
$self->{pong_received} = undef; # tracks pong replies; undef if no ping sent; 0 if ping sent but no pong reply yet; 1 if ping/pong completed
|
|
|
|
$self->{ping_send_time} = undef; # when last ping was sent
|
|
|
|
|
2014-05-19 04:42:18 +02:00
|
|
|
# maximum number of lag history entries to retain
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot}->{registry}->add_default('text', 'lagchecker', 'lag_history_max', $conf{lag_history_max} // 3);
|
2014-05-19 04:42:18 +02:00
|
|
|
# lagging is true if lag_average reaches or exceeds this threshold, in seconds
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot}->{registry}->add_default('text', 'lagchecker', 'lag_threshold', $conf{lag_threadhold} // 2);
|
2014-05-19 04:42:18 +02:00
|
|
|
# how often to send PING, in seconds
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot}->{registry}->add_default('text', 'lagchecker', 'lag_history_interval', $conf{lag_history_interval} // 10);
|
2014-05-19 12:30:25 +02:00
|
|
|
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot}->{registry}->add_trigger('lagchecker', 'lag_history_interval', sub { $self->lag_history_interval_trigger(@_) });
|
2011-01-25 00:56:55 +01:00
|
|
|
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot}->{timer}->register(
|
2014-05-19 12:30:25 +02:00
|
|
|
sub { $self->send_ping },
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot}->{registry}->get_value('lagchecker', 'lag_history_interval'),
|
2014-05-19 12:30:25 +02:00
|
|
|
'lag_history_interval'
|
|
|
|
);
|
2011-01-25 00:56:55 +01:00
|
|
|
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{pbot}->{commands}->register(sub { return $self->lagcheck(@_) }, "lagcheck", 0);
|
2014-11-01 01:15:21 +01:00
|
|
|
$self->{pbot}->{event_dispatcher}->register_handler('irc.pong', sub { $self->on_pong(@_) });
|
2011-01-25 00:56:55 +01:00
|
|
|
}
|
|
|
|
|
2014-05-19 12:30:25 +02:00
|
|
|
sub lag_history_interval_trigger {
|
|
|
|
my ($self, $section, $item, $newvalue) = @_;
|
|
|
|
$self->{pbot}->{timer}->update_interval('lag_history_interval', $newvalue);
|
|
|
|
}
|
|
|
|
|
2011-01-25 00:56:55 +01:00
|
|
|
sub send_ping {
|
|
|
|
my $self = shift;
|
2014-05-18 22:09:05 +02:00
|
|
|
return unless defined $self->{pbot}->{conn};
|
2011-01-25 00:56:55 +01:00
|
|
|
$self->{ping_send_time} = [gettimeofday];
|
2011-12-12 00:33:01 +01:00
|
|
|
$self->{pong_received} = 0;
|
2014-05-18 22:09:05 +02:00
|
|
|
$self->{pbot}->{conn}->sl("PING :lagcheck");
|
2011-01-25 00:56:55 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
sub on_pong {
|
|
|
|
my $self = shift;
|
|
|
|
|
2011-12-12 00:33:01 +01:00
|
|
|
$self->{pong_received} = 1;
|
|
|
|
|
2011-01-25 00:56:55 +01:00
|
|
|
my $elapsed = tv_interval($self->{ping_send_time});
|
2020-01-04 06:18:51 +01:00
|
|
|
push @{$self->{lag_history}}, [ $self->{ping_send_time}[0], $elapsed * 1000];
|
2011-01-25 00:56:55 +01:00
|
|
|
|
2020-01-04 06:18:51 +01:00
|
|
|
my $len = @{$self->{lag_history}};
|
2011-01-25 00:56:55 +01:00
|
|
|
|
2014-05-19 04:42:18 +02:00
|
|
|
my $lag_history_max = $self->{pbot}->{registry}->get_value('lagchecker', 'lag_history_max');
|
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
while ($len > $lag_history_max) {
|
2020-01-04 06:18:51 +01:00
|
|
|
shift @{$self->{lag_history}};
|
2011-01-25 00:56:55 +01:00
|
|
|
$len--;
|
|
|
|
}
|
|
|
|
|
|
|
|
$self->{lag_string} = "";
|
|
|
|
my $comma = "";
|
|
|
|
|
|
|
|
my $lag_total = 0;
|
2020-01-04 06:18:51 +01:00
|
|
|
foreach my $entry (@{$self->{lag_history}}) {
|
|
|
|
my ($send_time, $lag_result) = @$entry;
|
2011-01-25 00:56:55 +01:00
|
|
|
|
|
|
|
$lag_total += $lag_result;
|
2020-01-04 06:18:51 +01:00
|
|
|
my $ago = concise ago(gettimeofday - $send_time);
|
|
|
|
$self->{lag_string} .= $comma . "[$ago] " . sprintf "%.1f ms", $lag_result;
|
2011-01-25 00:56:55 +01:00
|
|
|
$comma = "; ";
|
|
|
|
}
|
|
|
|
|
|
|
|
$self->{lag_average} = $lag_total / $len;
|
2020-01-04 06:18:51 +01:00
|
|
|
$self->{lag_string} .= "; average: " . sprintf "%.1f ms", $self->{lag_average};
|
2014-11-01 01:15:21 +01:00
|
|
|
return 0;
|
2011-01-25 00:56:55 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
sub lagging {
|
|
|
|
my $self = shift;
|
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (defined $self->{pong_received} and $self->{pong_received} == 0) {
|
2011-12-12 00:33:01 +01:00
|
|
|
# a ping has been sent (pong_received is not undef) and no pong has been received yet
|
|
|
|
my $elapsed = tv_interval($self->{ping_send_time});
|
2014-05-19 04:42:18 +02:00
|
|
|
return $elapsed >= $self->{pbot}->{registry}->get_value('lagchecker', 'lag_threshold');
|
2011-12-12 00:33:01 +01:00
|
|
|
}
|
|
|
|
|
2011-01-25 00:56:55 +01:00
|
|
|
return 0 if not defined $self->{lag_average};
|
2014-05-19 04:42:18 +02:00
|
|
|
return $self->{lag_average} >= $self->{pbot}->{registry}->get_value('lagchecker', 'lag_threshold');
|
2011-01-25 00:56:55 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
sub lagstring {
|
|
|
|
my $self = shift;
|
|
|
|
my $lag = $self->{lag_string} || "initializing";
|
|
|
|
return $lag;
|
|
|
|
}
|
|
|
|
|
|
|
|
sub lagcheck {
|
|
|
|
my ($self, $from, $nick, $user, $host, $arguments) = @_;
|
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (defined $self->{pong_received} and $self->{pong_received} == 0) {
|
2011-12-12 00:44:04 +01:00
|
|
|
# a ping has been sent (pong_received is not undef) and no pong has been received yet
|
|
|
|
my $elapsed = tv_interval($self->{ping_send_time});
|
|
|
|
my $lag_total = $elapsed;
|
2020-01-04 06:18:51 +01:00
|
|
|
my $len = @{$self->{lag_history}};
|
2011-12-12 00:44:04 +01:00
|
|
|
|
|
|
|
my $lagstring = "";
|
|
|
|
my $comma = "";
|
|
|
|
|
2020-01-04 06:18:51 +01:00
|
|
|
foreach my $entry (@{$self->{lag_history}}) {
|
|
|
|
my ($send_time, $lag_result) = @$entry;
|
2011-12-12 00:44:04 +01:00
|
|
|
$lag_total += $lag_result;
|
2020-01-04 06:18:51 +01:00
|
|
|
my $ago = concise ago(gettimeofday - $send_time);
|
|
|
|
$lagstring .= $comma . "[$ago] " . sprintf "%.1f ms", $lag_result;
|
2011-12-12 00:44:04 +01:00
|
|
|
$comma = "; ";
|
|
|
|
}
|
|
|
|
|
|
|
|
$lagstring .= $comma . "[waiting for pong] $elapsed";
|
|
|
|
|
|
|
|
my $average = $lag_total / ($len + 1);
|
2020-01-04 06:18:51 +01:00
|
|
|
$lagstring .= "; average: " . sprintf "%.1f ms", $average;
|
2011-12-12 00:44:04 +01:00
|
|
|
return $lagstring;
|
|
|
|
}
|
|
|
|
|
2011-01-25 00:56:55 +01:00
|
|
|
return "My lag: " . $self->lagstring;
|
|
|
|
}
|
|
|
|
|
|
|
|
1;
|