Zooka: initial creation

2024-01-18T14:04:43Z

initial creation

New page

[[Category:Mudlet Package Listing]]
{| class="wikitable" style="width: 70%;"
|-
| style="width: 10%" | Game || non-mud specific
|-
| By || Wyd
|-
| Download || https://forums.mudlet.org/download/file.php?id=307&sid=ee16e5b03abb9d132a2a95bfd37f48fb
|-
| Dependencies ||  Mudlet 4.17
|}

= Description =


The Simple logger is a basic logging system for Mudlet, that allows you to log text out to a file. The difference between this logger and the inbuild mudlet one, is that the Simple Logger allows you to log out only certain lines (For example, "You have slain <blah>."), or split your log files up into files of a certain size.

= Usage =


* <code>Logger:Log(file, line_to_save, options_table)</code> - Simply appends <code>line_to_save</code> to <code>file.txt</code>. See the "options" section below to see the currently valid options.

* <code>Logger:LogSection(file, options_table)</code> - The logger will append every line that comes from the MUD until you call <code>Logger:StopLogging()</code>. Not, this will only output stuff directly from the MUD, and not show echo's or such. See the "options" section below to see the currently valid options. When you log a section, the logged output will be put between <code>[[[START OF SECTION]]]</code> and <code>[[[END OF SECTION]]]</code> to make sections easier to find.

* <code>Logger:StopLogging()</code> - Stops logging after <code>Logger:LogSection()</code> is called.

* <code>Logger:SearchLog(file, pattern)</code> - Searches through <code>file.txt</code> for the given pattern, and output matched lines. This uses rex_pcre to search, so the pattern can be regular expression.

* <code>Logger:CloseLog(file)</code> - To be used with the <code>keepOpen</code> option (explained below). The <code>file</code> parameter is optional, and if omitted, then the Logger will close all open log files.

There are currently three recognized options:

* <code>timestamp</code> - When included in the options table, the Logger will prefix each logged line with a time stamp. Note: Dates in the order (dd/mm/yyyy). If you want to change this around, just modify the <code>time_format</code> variable in <code>Logger:Log()</code>.

* <code>split = <number></code> - This tells the logger to ensure that the log file gets no larger then <code><number></code> kilobytes. If the log file gets larger then the given number, the logger will backup the old file.txt, and create a new one. If this option is used with <code>Logger:Log()</code>, then it will check each time the function is called. With <code>Logger:LogSection()</code>, the file size is checked when logging first begins, and every 10 minutes after that, for performance reasons.

* <code>keepOpen</code> - This option tells the Logger to not close the handle to the log file, and to keep it open until <code>Logger:CloseLog(file)</code> is called. This allows a substantial performance gain when logging large amounts of data at once. If you use this, then <code>Logger:CloseLog()</code> should be called when you close the connection to your MUD, to ensure that the Logger closes all open logs.

Note: <code>LogSection</code> uses <code>keepOpen</code> by default, and closes the log when the logging is stopped. This means you'll need to ensure that <code>Logger:StopLogging()</code> is called at some point.

Two examples of using the option table would be;

* <code>Logger:Log("kills", { "timestamp"})</code>
* <code>Logger:LogSection("arena", {split = 5000})</code>

See also: [https://forums.mudlet.org/viewtopic.php?f=6&t=1424 Mudlet Forums]

= Examples =

I have included the following aliases to demonstrate its use:

* <code>log <file></code> - Will call <code>Logger:LogSection(<file>)</code>. If <code><type></code> is "off", it will call <code>Logger:StopLogging()</code>

* <code>searchlog <file> <pattern></code> - Will call <code>Logger:SearchLog(<type>, <pattern>)</code>

* A "slain" trigger for Achaea to demonstrate how to use the <code>Logger:Log()</code> function.

Simple logger - Revision history

Zooka: initial creation