Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 2.96 KB

README.md

File metadata and controls

101 lines (66 loc) · 2.96 KB
Raw

SyslogLogging

NuGet Version NuGet

Simple C# class library for logging to syslog, console, and file, targeted to .NET Core, .NET Standard, and .NET Framework. For a sample app please refer to the included test project.

SyslogLogging is targeted to .NET Core, .NET Standard, and .NET Framework.

Help or Feedback

First things first - do you need help or have feedback? File an issue here! We'd love to hear from you.

New in v2.0.x

  • Breaking changes including new constructors and minor API changes
  • Support for multiple syslog servers
  • Simplified class definitions

It's Really Easy... I Mean, REALLY Easy

Easiest Way Possible

Using the constructor with no parameters will cause the library to log to 127.0.0.1:514.

using SyslogLogging;
LoggingModule log = new LoggingModule();
log.Debug("Hello, world!");

Single Syslog Server

using SyslogLogging;

LoggingModule log = new LoggingModule("mysyslogserver", 514);
log.Debug("Hello, world!");

Multiple Syslog Servers and Console

using SyslogLogging;

List<SyslogServer> servers = new List<SyslogServer>
{
  new SyslogServer("logginghost.com", 2000),
  new SyslogServer("myhost.com", 514)
};

LoggingModule log = new LoggingModule(servers, true); // true to enable console
log.Warn("Look out!");

Logging to File

using SyslogLogging;

LoggingModule log = new LoggingModule("mylogfile.txt");
log.Info("Here's some new information!");

Logging EVERYWHERE

using SyslogLogging;

List<SyslogServer> servers = new List<SyslogServer>
{
  new SyslogServer("127.0.0.1", 514)
};

LoggingModule log = new LoggingModule(servers, true); // true to enable console
log.Settings.FileLogging = FileLoggingMode.SingleLogFile;
log.Settings.LogFilename = "mylogfile.txt";
log.Alert("We're going everywhere!");

When using FileLoggingMode.FileWithDate, LoggingModule with append .yyyyMMdd to the supplied filename in LogFilename. When using FileLoggingMode.SingleLogFile, the filename is left untouched.

Changing Console Message Color

Colors are disabled by default to ensure compatibility across different operating systems and environments.

If you wish to enable colors and change the colors used by the library, set Settings.EnableColors to true and modify the Settings.Colors property. A variable of type ColorScheme exists for each severity level. To disable colors, set Settings.EnableColors to false.

log.Settings.EnableColors = true;
log.Settings.Colors.Debug = new ColorScheme(ConsoleColor.DarkGray, ConsoleColor.Black);

Special Thanks

We'd like to extend a special thank you to those that have helped make this library better, including:

@dev-jan @jisotalo

Version History

Please refer to CHANGELOG.md.