ChannelLogger
Documentation for the ChannelLogger plugin for Supybot
Purpose
Logs each channel to its own individual logfile.
Configuration
- supybot.plugins.ChannelLogger.public
This config variable defaults to True and is not channel specific.
Determines whether this plugin is publicly visible.
- supybot.plugins.ChannelLogger.flushImmediately
This config variable defaults to False and is not channel specific.
Determines whether channel logfiles will be flushed anytime they're written to, rather than being buffered by the operating system.
- supybot.plugins.ChannelLogger.stripFormatting
This config variable defaults to True and is channel specific.
Determines whether formatting characters (such as bolding, color, etc.) are removed when writing the logs to disk.
- supybot.plugins.ChannelLogger.timestamp
This config variable defaults to True and is channel specific.
Determines whether the logs for this channel are timestamped with the timestamp in supybot.log.timestampFormat.
- supybot.plugins.ChannelLogger.timestamp.format
This config variable defaults to "%B" and is not channel specific.
Determines what timestamp format will be used in the directory stucture for channel logs if supybot.plugins.ChannelLogger.directories.timestamp is True.
- supybot.plugins.ChannelLogger.timestamp.format
- supybot.plugins.ChannelLogger.noLogPrefix
This config variable defaults to "[nolog]" and is channel specific.
Determines what string a message should be prefixed with in order not to be logged. If you don't want any such prefix, just set it to the empty string.
- supybot.plugins.ChannelLogger.rotateLogs
This config variable defaults to False and is channel specific.
Determines whether the bot will automatically rotate the logs for this channel. The bot will rotate logs when the timestamp for the log changes. The timestamp is set according to the
filenameTimestampconfiguration variable. - supybot.plugins.ChannelLogger.filenameTimestamp
This config variable defaults to "%d-%a-%Y" and is channel specific.
Determines how to represent the timestamp used for the filename in rotated logs. When this timestamp changes, the old logfiles will be closed and a new one started. The format characters for the timestamp are in the time.strftime docs at python.org. In order for your logs to be rotated, you'll also have to enable supybot.plugins.ChannelLogger.rotateLogs.
- supybot.plugins.ChannelLogger.directories
This config variable defaults to True and is not channel specific.
Determines whether the bot will partition its channel logs into separate directories based on different criteria.
- supybot.plugins.ChannelLogger.directories.network
This config variable defaults to True and is not channel specific.
Determines whether the bot will use a network directory if using directories.
- supybot.plugins.ChannelLogger.directories.channel
This config variable defaults to True and is not channel specific.
Determines whether the bot will use a channel directory if using directories.
- supybot.plugins.ChannelLogger.directories.timestamp
This config variable defaults to False and is not channel specific.
Determines whether the bot will use a timestamp (determined by supybot.plugins.ChannelLogger.directories.timestamp.format) if using directories.
- supybot.plugins.ChannelLogger.directories.network