This project is read-only.

Unique Advantages of LogNut:

  • You can start logging with a few very-simple lines of code. No config-files or installation is necessary. This is intended to be a tool that just works.
  • The API is made as consistent and easy-to-understand as possible, with full Intellisense provided for the source and a complete help-file for the API.
  • LogNut provides real-time viewer applications so that you can see your log output instantly, as it happens. These viewers are available on the platforms that are most likely to be the most convenient to you (Windows Desktop, Mac OS X, Linux, Android, Windows Phone, iOS).
  • Sample applications are provided for exploring it's operation, playing with it's settings and to test your specific platform and environment.
  • A Control-Panel desktop-application is provided which may be used to control the settings of LogNut, including in real-time as your subject-program is running.
  • You have a full range of distribution options for your log-records including to file or the Windows Event Log, or over an internet-connected messaging service to be viewed on other computers and devices, sent via email or even via IM or SMS.
  • The log-output file, by default, has a very simple text format with a minimum of clutter.
  • Test-Driven-Development: LogNut is designed to be simple to use within your unit-tests, bringing unique features to enable your test automation. You can configure or use it within your PowerShell scripts and it provides an ideal solution for continuous-integration (CI).
  • There is a special indicator that flags when log output is generated during design-mode (ie when the code is executed within Microsoft Expression Blend or within the design-view of Visual Studio). This can be a huge butt-saver when you're attempting to troubleshoot XAML issues.
  • A clear, simple, quick-start tutorial is provided, and the author is available via email to help with any problems.

Current Feature-Set Highlights

  • Each log-record contains comprehensive contextual information including which computer and which program sent it, the username, thread-id and a precise timestamp of when it was created.
  • The information that is displayed within the log traces is highly configurable.
  • Log files are unique - with enough contextual information in their name to easily identify or sort them. They may be set to roll-over when a certain size-limit or time is reached.
  • The file logging has sensible defaults which just work straight out of the box, but yet is highly configurable. You can set a max number of log files and a max log file size, location, rollover-mode, output format, whether to insert blank lines or to append to the file and many other options.
  • You can transmit the log-records via email
  • Logging can be directed to the Windows Event Log.
  • A simple, versatile method is provided for the logging of C# exceptions.
  • Log records have a level (Debug, Warn, Error, Fatal) that is compatible with NLog and Log4Net.
  • Loggers may be organized by category.
  • A setting is available that can compress the existing Log files whenever a file-rollover occurs, to save disk space.
  • The NuGet packages will include separate versions for strong-named assemblies, and not strong-named. The reason for this the inherent complexity involved when a library forces you to transition from the one to the other: I elected to do the little bit of extra work to provide you with both options so that you avoid that complexity.

Features Currently In The Works

  • A version will be provided for each of the target platforms, and for the supported development platforms (such as Microsoft Visual Studio 2012, 2010, and 2008).
  • The actual logging work is handled by a separate, dedicated process such that (optionally) your subject-program continues at full speed as logging work is passed off to LogNut, and so that logging information is not lost if your program crashes.

Other, possible features that may be added

  • (Suggested ?) Can log to a database (SQL Server ?)
  • (Suggested ?) Can set it to plot the time-delay between two different types of log event, and graph the result.
  • (Suggested ?) Can convert the output into .CSV format for import into Excel

Last edited Dec 10, 2012 at 8:55 PM by JamesHurst, version 11


No comments yet.