Class LogService

Provides logging services by buffering messages and dispatching them into destinations. This is an asynchronous service, meaning that Write(msg) never blocks for long.

Inheritance
System.Object
DisposableObject
ApplicationComponent
Service
Service<System.Object>
ServiceWithInstrumentationBase<System.Object>
LogServiceBase
LogService
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Log
Assembly: NFX.dll
Syntax
[ConfigMacroContext]
public class LogService : LogServiceBase, IService, INamed, ILogImplementation, ILog, IApplicationComponent, ILocalizedTimeProvider, IDisposable, IConfigurable, IInstrumentable, IExternallyParameterized

Constructors

LogService()

Creates a new logging service instance

Declaration
public LogService()

LogService(Service)

Creates a new logging service instance

Declaration
public LogService(Service director = null)
Parameters
Type Name Description
Service director

Fields

CONFIG_FILEEXTENSION_ATTR

Declaration
public const string CONFIG_FILEEXTENSION_ATTR = "file-extension"
Field Value
Type Description
System.String

CONFIG_RELIABLE_ATTR

Declaration
public const string CONFIG_RELIABLE_ATTR = "reliable"
Field Value
Type Description
System.String

CONFIG_WRITEINTERVAL_ATTR

Declaration
public const string CONFIG_WRITEINTERVAL_ATTR = "write-interval-ms"
Field Value
Type Description
System.String

Properties

FileExtension

Extension for log files

Declaration
[Config("$file-extension")]
[ExternalParameter(new string[]{"log"})]
public string FileExtension { get; set; }
Property Value
Type Description
System.String

Reliable

Determines whether this service blocks on stop longer until all buffered messages have been tried to be dispatched into all destinations. This property is true by default. Certain destinations may take considerable time to fail per message (i.e. database connection timeout), consequently buffered messages processing may delay service stop significantly if this property is true

Declaration
[Config("$reliable", true)]
[ExternalParameter(new string[]{"log"})]
public bool Reliable { get; set; }
Property Value
Type Description
System.Boolean

WriteInterval

Determines how often a log should be written to storage. The value of this property must be between 10 and 5000 (milliseconds)

Declaration
[Config("$write-interval-ms", 250)]
[ExternalParameter(new string[]{"log"})]
public int WriteInterval { get; set; }
Property Value
Type Description
System.Int32

Methods

DoStart()

Declaration
protected override void DoStart()
Overrides

DoWaitForCompleteStop()

Declaration
protected override void DoWaitForCompleteStop()
Overrides

DoWrite(Message, Boolean)

Writes log message into log

Declaration
protected override void DoWrite(Message msg, bool urgent)
Parameters
Type Name Description
Message msg
System.Boolean urgent
Overrides

Implements

System.IDisposable

Extension Methods