Author image Mario Domgörgen
and 1 contributors


Bot::BasicBot::Pluggable::Module::Log - Provide logging for Bot::BasicBot::Pluggable


Version 0.11


This module logs all traffic in irc channels to files. Every channel is logged to its own logfile and all files are rotated every 24 hours. For the sake of simplicity this module implements a very straightforward logging mechanism. Please take a look at the BUGS section for its limitations.


None. If the module is loaded every message, join and part event is recorded in the channel's log file.



The bot calls this functions for every message sent to the channel. The message is then formatted and sent further to the loggings subsystem. If the message is from the bot or addressed to it and ignore_bot is set to a true value, those messages are not logged. The same applies if the body of the message matches the pattern defined in ignore_pattern. The default logging output would look something like

[#botzone 12:34:12] <me> Hello World


This function simply calls seen.


This function is called every time someone enters the channel. The event is logged as follows:

[#botzone 12:34:12] JOIN: me


This function is called every time someone leaves the channel. The event is logged as follows:

[#botzone 12:34:12] PART: me


When ignore_bot is set to false, we log replies of the bot in this function. The message is formatted as in seen.


Print a friendly help message to the channel.


Sets all user variables to their default values. Please see the next section for further information about their exact values.



All lines mattching this regular expression will b<not> be logged at all. Normally all lines are logged.


Path to the directory where all logfiles are stored. Defaults to the current directory.


Format of the timestamp that is prepended to every logged statement. Defaults to '%H:%M:%S'. Consult your system's strftime() manpage for details about these and the other arguments.


Whether to ignore all communications with this bot. Defaults to 1.


Whether to log join and part events. Defaults to 0.


Whether to ignore all communications in a query with this bot. Defaults to 1.

If this variable is true (default), we will generate a symbolic link to the current logfile called $channel_current.log.


Mario Domgoergen, <dom at>


  • For the sake of simplicity this module opens and closes the logfile every time a message is written. This is far from optimal, but save me the hassle to save open filehandles between invocations, locking over nfs and rotating the log files. In the future there will be a submodule to use Log::Log4perl or Log::Dispatch.

  • No file is locked, so there could be a possible problem with multiple bots writing to the same file. This will also be solved by using one of the serious logging modules mentioned above.

Please report any bugs or feature requests to bug-bot-basicbot-pluggable-module-log at, or through the web interface at I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.


You can find documentation for this module with the perldoc command.

    perldoc Bot::BasicBot::Pluggable::Module::Log

You can also look for information at:



Copyright 2009 Mario Domgoergen, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.