summaryrefslogtreecommitdiff
path: root/lib/Log/Log4perl/Filter/MDC.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Log/Log4perl/Filter/MDC.pm')
-rw-r--r--lib/Log/Log4perl/Filter/MDC.pm97
1 files changed, 97 insertions, 0 deletions
diff --git a/lib/Log/Log4perl/Filter/MDC.pm b/lib/Log/Log4perl/Filter/MDC.pm
new file mode 100644
index 0000000..ae9211b
--- /dev/null
+++ b/lib/Log/Log4perl/Filter/MDC.pm
@@ -0,0 +1,97 @@
+package Log::Log4perl::Filter::MDC;
+use strict;
+use warnings;
+
+use Log::Log4perl::Util qw( params_check );
+
+use base "Log::Log4perl::Filter";
+
+sub new {
+ my ( $class, %options ) = @_;
+
+ my $self = {%options};
+
+ params_check( $self, [qw( KeyToMatch RegexToMatch )] );
+
+ $self->{RegexToMatch} = qr/$self->{RegexToMatch}/;
+
+ bless $self, $class;
+
+ return $self;
+}
+
+sub ok {
+ my ( $self, %p ) = @_;
+
+ my $context = Log::Log4perl::MDC->get_context;
+
+ my $value = $context->{ $self->{KeyToMatch} };
+ return 1
+ if defined $value && $value =~ $self->{RegexToMatch};
+
+ return 0;
+}
+
+1;
+
+__END__
+
+=encoding utf8
+
+=head1 NAME
+
+Log::Log4perl::Filter::MDC - Filter to match on values of a MDC key
+
+=head1 SYNOPSIS
+
+ log4perl.filter.Match1 = Log::Log4perl::Filter::MDC
+ log4perl.filter.Match1.KeyToMatch = foo
+ log4perl.filter.Match1.RegexToMatch = bar
+
+=head1 DESCRIPTION
+
+This Log4perl filter checks if a predefined MDC key, as set in C<KeyToMatch>,
+of the currently submitted message matches a predefined regex, as set in
+C<RegexToMatch>.
+
+=head1 SEE ALSO
+
+L<Log::Log4perl::Filter>,
+L<Log::Log4perl::Filter::Boolean>,
+L<Log::Log4perl::Filter::LevelMatch>,
+L<Log::Log4perl::Filter::LevelRange>,
+L<Log::Log4perl::Filter::MDC>,
+L<Log::Log4perl::Filter::StringMatch>
+
+=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.
+