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
|
##################################################
package Log::Log4perl::Appender::Socket;
##################################################
our @ISA = qw(Log::Log4perl::Appender);
use warnings;
use strict;
use IO::Socket::INET;
##################################################
sub new {
##################################################
my($class, @options) = @_;
my $self = {
name => "unknown name",
silent_recovery => 0,
no_warning => 0,
PeerAddr => "localhost",
Proto => 'tcp',
Timeout => 5,
@options,
};
bless $self, $class;
unless ($self->{defer_connection}){
unless($self->connect(@options)) {
if($self->{silent_recovery}) {
if( ! $self->{no_warning}) {
warn "Connect to $self->{PeerAddr}:$self->{PeerPort} failed: $!";
}
return $self;
}
die "Connect to $self->{PeerAddr}:$self->{PeerPort} failed: $!";
}
$self->{socket}->autoflush(1);
#autoflush has been the default behavior since 1997
}
return $self;
}
##################################################
sub connect {
##################################################
my($self, @options) = @_;
$self->{socket} = IO::Socket::INET->new(@options);
return $self->{socket};
}
##################################################
sub log {
##################################################
my($self, %params) = @_;
{
# If we were never able to establish
# a connection, try to establish one
# here. If it fails, return.
if(($self->{silent_recovery} or $self->{defer_connection}) and
!defined $self->{socket}) {
if(! $self->connect(%$self)) {
return undef;
}
}
# Try to send the message across
eval { $self->{socket}->send($params{message});
};
if($@) {
warn "Send to " . ref($self) . " failed ($@), retrying once...";
if($self->connect(%$self)) {
redo;
}
if($self->{silent_recovery}) {
return undef;
}
warn "Reconnect to $self->{PeerAddr}:$self->{PeerPort} " .
"failed: $!";
return undef;
}
};
return 1;
}
##################################################
sub DESTROY {
##################################################
my($self) = @_;
undef $self->{socket};
}
1;
__END__
=encoding utf8
=head1 NAME
Log::Log4perl::Appender::Socket - Log to a socket
=head1 SYNOPSIS
use Log::Log4perl::Appender::Socket;
my $appender = Log::Log4perl::Appender::Socket->new(
PeerAddr => "server.foo.com",
PeerPort => 1234,
);
$appender->log(message => "Log me\n");
=head1 DESCRIPTION
This is a simple appender for writing to a socket. It relies on
L<IO::Socket::INET> and offers all parameters this module offers.
Upon destruction of the object, pending messages will be flushed
and the socket will be closed.
If the appender cannot contact the server during the initialization
phase (while running the constructor C<new>), it will C<die()>.
If the appender fails to log a message because the socket's C<send()>
method fails (most likely because the server went down), it will
try to reconnect once. If it succeeds, the message will be sent.
If the reconnect fails, a warning is sent to STDERR and the C<log()>
method returns, discarding the message.
If the option C<silent_recovery> is given to the constructor and
set to a true value, the behaviour is different: If the socket connection
can't be established at initialization time, a single warning is issued.
Every log attempt will then try to establish the connection and
discard the message silently if it fails.
If you don't even want the warning, set the C<no_warning> option to
a true value.
Connecting at initialization time may not be the best option when
running under Apache1 Apache2/prefork, because the parent process creates
the socket and the connections are shared among the forked children--all
the children writing to the same socket could intermingle messages. So instead
of that, you can use C<defer_connection> which will put off making the
connection until the first log message is sent.
=head1 EXAMPLE
Write a server quickly using the IO::Socket::INET module:
use IO::Socket::INET;
my $sock = IO::Socket::INET->new(
Listen => 5,
LocalAddr => 'localhost',
LocalPort => 12345,
Proto => 'tcp');
while(my $client = $sock->accept()) {
print "Client connected\n";
while(<$client>) {
print "$_\n";
}
}
Start it and then run the following script as a client:
use Log::Log4perl qw(:easy);
my $conf = q{
log4perl.category = WARN, Socket
log4perl.appender.Socket = Log::Log4perl::Appender::Socket
log4perl.appender.Socket.PeerAddr = localhost
log4perl.appender.Socket.PeerPort = 12345
log4perl.appender.Socket.layout = SimpleLayout
};
Log::Log4perl->init(\$conf);
sleep(2);
for(1..10) {
ERROR("Quack!");
sleep(5);
}
=head1 LICENSE
Copyright 2002-2013 by Mike Schilli E<lt>m@perlmeister.comE<gt>
and Kevin Goess E<lt>cpan@goess.orgE<gt>.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHOR
Please contribute patches to the project on Github:
http://github.com/mschilli/log4perl
Send bug reports or requests for enhancements to the authors via our
MAILING LIST (questions, bug reports, suggestions/patches):
log4perl-devel@lists.sourceforge.net
Authors (please contact them via the list above, not directly):
Mike Schilli <m@perlmeister.com>,
Kevin Goess <cpan@goess.org>
Contributors (in alphabetical order):
Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton
Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony
Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy
Grundman, Paul Harrington, Alexander Hartmaier David Hull,
Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter,
Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope,
Lars Thegler, David Viner, Mac Yang.
|
