mirror of
https://github.com/Ellpeck/ExtremelySimpleLogger.git
synced 2024-11-22 10:03:29 +01:00
42 lines
No EOL
1.5 KiB
Markdown
42 lines
No EOL
1.5 KiB
Markdown
# ExtremelySimpleLogger
|
|
**A very simple logger for .NET programs.**
|
|
|
|
To set up an extremely simple logger, add a reference to the [NuGet package](https://www.nuget.org/packages/ExtremelySimpleLogger/) to your project file. Remember to change the `VERSION` to the most recent one.
|
|
```xml
|
|
<ItemGroup>
|
|
<PackageReference Include="ExtremelySimpleLogger" Version="VERSION" />
|
|
</ItemGroup>
|
|
```
|
|
|
|
Next, you have to create an instance of the `Logger` class:
|
|
```cs
|
|
var logger = new Logger {
|
|
Name = "My Logger",
|
|
Sinks = {
|
|
new FileSink("Log.txt", append: true),
|
|
new ConsoleSink()
|
|
}
|
|
};
|
|
```
|
|
|
|
Since there are multiple ways for logging data to be processed, the logger needs to receive a set of `Sink` instances. By default, the following sinks are available:
|
|
- `FileSink`, which outputs logging data to a file
|
|
- `ConsoleSink`, which outputs logging data to the default console
|
|
- `DirectorySink`, which outputs logging data to a set of files and automatically manages how many old logs are kept
|
|
- `StringSink`, which stores logging data in a string
|
|
|
|
There are multiple ways to easily log messages with your newly created logger:
|
|
```cs
|
|
// Logging info
|
|
logger.Log(LogLevel.Info, "Some information");
|
|
logger.Info("Some information, but shorter");
|
|
|
|
// Logging exceptions
|
|
try {
|
|
// some dangerous code
|
|
} catch (Exception e) {
|
|
logger.Error("An exception was thrown", e);
|
|
}
|
|
```
|
|
|
|
For more information, you can also check out [the sample](https://github.com/Ellpeck/ExtremelySimpleLogger/blob/main/Sample/Program.cs). |