From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

VVU / wubot-0.3.0-TRIAL / lib / App / Wubot / Plugin / FileTail.pm 

            

              
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

              
package App::Wubot::Plugin::FileTail;
use Moose;
our $VERSION = '0.3.0'; # VERSION
use App::Wubot::Logger;
use App::Wubot::Util::Tail;
has 'path'      => ( is      => 'rw',
                     isa     => 'Str',
                     default => '',
                 );
has 'tail'      => ( is      => 'ro',
                     isa     => 'App::Wubot::Util::Tail',
                     lazy    => 1,
                     default => sub {
                         my ( $self ) = @_;
                         return App::Wubot::Util::Tail->new( { path           => $self->path,
                                                      } );
                     },
                 );
has 'logger'    => ( is      => 'ro',
                     isa     => 'Log::Log4perl::Logger',
                     lazy    => 1,
                     default => sub {
                         return Log::Log4perl::get_logger( __PACKAGE__ );
                     },
                 );
with 'App::Wubot::Plugin::Roles::Cache';
with 'App::Wubot::Plugin::Roles::Plugin';
sub init {
    my ( $self, $inputs ) = @_;
    $self->path( $inputs->{config}->{path} );
    my $ignore;
    if ( $inputs->{config}->{ignore} ) {
        $ignore = join( "|", @{ $inputs->{config}->{ignore} } );
    }
    my $callback = sub {
        my $line = $_[0];
        return if $ignore && $line =~ m|$ignore|;
        $self->logger->debug( "$self->{key}: $line" );
        push @{ $self->{react} }, { subject => $line }
    };
    $self->tail->callback(       $callback );
    $self->tail->reset_callback( $callback );
    if ( $inputs->{cache}->{position} ) {
        $self->tail->position( $inputs->{cache}->{position} );
    }
    return;
}
sub check {
    my ( $self, $inputs ) = @_;
    $self->tail->get_lines();
    $inputs->{cache}->{position} = $self->tail->position;
    if ( $self->{react} ) {
        my $return = { react => \@{ $self->{react} }, cache => $inputs->{cache} };
        undef $self->{react};
        return $return;
    }
    return { cache => $inputs->{cache} };
}
1;
__END__
=head1 NAME
App::Wubot::Plugin::FileTail - monitor a log file for all new lines
=head1 VERSION
version 0.3.0
=head1 SYNOPSIS
  ~/wubot/config/plugins/FileTail/bsd-01.messages.yaml
  ---
  delay: 30
  path: /var/log/messages
  ignore:
    - my.ignore.string
    - some\sregexp\d+
=head1 DESCRIPTION
Monitor a log file for new lines.
Each time a new line is seen in the file, a message will be sent
containing the fields:
  subject: {line}
If 'ignore' is defined in your configuration, then it should be set to
an array of regular expressions.  If any of the regular expressions
matches, then no message will be sent.  All patterns in the 'ignore'
array will get joined together with '|' and evaluated as a single
regular expression.
=head1 SUBROUTINES/METHODS
=over 8
=item init( $inputs )
The standard monitor init() method.
=item check( $inputs )
The standard monitor check() method.
=back