Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 3.22 KB

Readme.md

File metadata and controls

59 lines (40 loc) · 3.22 KB
Raw

sensenet Diagnostics

In this namespace you'll find easy-to-use and extendable logging components. We build on them extensively in the core sensenet project but they can also be used in any kind of tool or application as a lightweight logging technology.

SnLog

This component was designed to handle the most common event logging scenarios - e.g. writing messages or exceptions to the underlying replaceable adapter.

If you want to use this logger in a custom tool or application, please provide the appropriate logger instance during app start:

SnLog.Instance = new MyCustomLogger();

Of course sensenet already does this for you, you do not have to set a logger manually when you are working in the context of sensenet - unless you want to set your custom logger.

Available built-in loggers in the SenseNet.Tools library:

  • TraceEventLogger: writes messages to the trace
  • SnEventLogger: lightweight logger implementation that writes events into the Windows event log
  • SnFileSystemEventLogger: writes events into a file

Additional loggers available in sensenet:

  • EntLibLoggerAdapter: legacy logger implementation based on Enterprise Library

Usage

Writing a message to the logger is a one line operation. There are a couple of optional parameters (e.g. category or properties) that you can fill to provide more information to the colleague who will review the entries later.

SnLog.WriteInformation("ContentTypeManager loaded.");
SnLog.WriteException(ex, "Error during content save.", EventId.Indexing, 
   properties: new Dictionary<string, object> { { "Path", path } });

Providing an event id also helps debugging errors; you can even use one of the built-in ids listed in the EventId static class - or define your own ids.

Audit events

An audit event is a special kind of event that is usually related to data or permission change. The SnLog API lets you customize how these events are written to what target.

SnLog.AuditEventWriter = new MyCustomAuditEventWriter();

By default this dedicated audit writer is not set and audit events are written to the regular event log along all other types of events. In sensenet there is a built-in audit log writer that is set when the application starts: the DatabaseAuditEventWriter directs audit messages toward the database so that they are not mixed with other, less relevant messages and kept for a longer time.

SnTrace

Tracing is a bit different subject. It requires a lightning fast infrastructure and can be used a lot more extensively in your code than writing events. In sensenet we write trace messages in many places - e.g. at web request life cycle events, db operations or content life cycle events.

// this will go to the Custom category
SnTrace.Write("My message");

// this will be written to the Database category
SnTrace.Database.Write("Query executed");

We have a predefined list of categories and you can either use the Custom category or define your own ones on-the-fly. Categories can be switched on or off to make the trace log less noisy.

The trace lines will be written to the file system in a buffered way so that it does not take too much resources.

For details please visit this article.