Update Readme
This commit is contained in:
parent
1eedae47f2
commit
610027528e
42
README.md
42
README.md
|
@ -1,2 +1,44 @@
|
|||
# Renegade Logger Class
|
||||
|
||||
Logger class for Free Pascal
|
||||
|
||||
## Usage
|
||||
|
||||
```pascal
|
||||
uses
|
||||
Renegade.Logger,
|
||||
{ Only handler at the moment
|
||||
Implement Logger.LoggingHandlerInterface
|
||||
(Logger.HandlerInterface unit)
|
||||
to create your own. }
|
||||
Logger.SysLogHandler,
|
||||
//... other units;
|
||||
|
||||
var
|
||||
LogHandler : SysLogHandler;
|
||||
Log : RTLogger;
|
||||
begin
|
||||
LogHandler := SysLogHandler.Create(LOG_DAEMON);
|
||||
Log := RTLogger.Create(LogHandler);
|
||||
{ Context is an array of consts
|
||||
It gets turned into json object in the log.
|
||||
It should be in the format ['Key', 'Value', 'Otherkey', 'Value']
|
||||
Put any context to your log messages here.
|
||||
e.g. ['UserID', User.getId(), 'Menu', Menu.getName()] }
|
||||
Log.Info('Testing', ['Context', 'LogContext']);
|
||||
Log.Debug('Debug Log', []);
|
||||
Log.Log(LOG_NOTICE, 'Notice Log', []);
|
||||
{
|
||||
Other Shortcuts
|
||||
Log.Emergency
|
||||
Log.Alert
|
||||
Log.Critical
|
||||
Log.Error
|
||||
Log.Warning
|
||||
Log.Notice
|
||||
|
||||
}
|
||||
Log.Free;
|
||||
LogHandler.Free;
|
||||
end.
|
||||
```
|
Loading…
Reference in New Issue