Relativity.Logging 2019.5.1 - API Reference

<PackageReference Include="Relativity.Logging" Version="2019.5.1" />

API Differences between 2019.5.1 and 9.4.316

75 Additions 31 Removals

Relativity.Logging

public class ConfigFileReader : MarshalByRefObject, IReadFile, IReadConfigurationParts, IDisposable
- public static ConfigFileReader Instance { get; set; }
- public List<Sink> GetAllSinks()
- public List<Rule> GetRules()
- public List<Sink> GetSinks()
- public Rule ParseRule(XmlNode ruleNode, bool compareToOption)
- public Rule ParseRule(XmlNode ruleNode)
- public void ParseRuleNodeForRules(XmlNode rulesNode, List<Rule> rules, bool compareToOptions)
- public void ParseRuleNodeForRules(XmlNode rulesNode, List<Rule> rules)
public class Constants
- public const string OPERATION_CONTEXT = "OperationContext"
- public const string OPERATION_ID = "OperationID"
public class LoggerOptionsComparer : IEqualityComparer<LoggerOptions>
- public LoggerOptionsComparer()
- public bool Equals(LoggerOptions x, LoggerOptions y)
- public int GetHashCode(LoggerOptions x)

Relativity.Logging.Configuration

public class Configuration
- public int PollingInterval { get; set; }
- public bool CompareConfigurationToOptions(LoggerOptions options)
public interface IReadConfigurationParts
- bool GetEnabled()
- int GetPollingInterval()
- List<Rule> GetRules()
- List<Sink> GetSinks()
- List<Sink> GetAllSinks()
public interface IReadFile : IReadConfigurationParts
- bool GetEnabled()
- int GetPollingInterval()
public class SyslogSinkConfig : Sink
public class TcpSinkConfig : Sink
- public string Host { get; }
- public int Port { get; }
- public TcpSinkConfig(string name, string host, int port)

Relativity.Logging.Configuration.ConfigReaders

public class EDDSReader : IReadConfiguration
- public bool IsConnectionHealthy { get; }
- public bool TestConnection()
public class LocalFile : IReadConfiguration
- public LocalFile(LoggerOptions options, IReadFile reader)

Relativity.Logging.Configuration.EDDS

public class DatabaseReader : MarshalByRefObject, IReadDatabase, IReadConfigurationParts
- public bool IsConnectionHealthy { get; }
- public DatabaseReader(LoggerOptions options, int pollingInterval)
- public bool DatabaseUpdated()
- public DatabaseReader(LoggerOptions options, ICreateSinks sinkFactory, int pollingInterval)
- public bool GetEnabled()
- public int GetPollingInterval()
- public List<Rule> GetRules()
- public List<Sink> GetSinks()
- public bool TestConnection()
- public List<Sink> GetAllSinks()
public class DatabaseWriter : IWriteDatabase, IWriteConfigurationsParts
- public class SinkTypeData
- public void EnsureLogentriesSinkSouce(string name, string token)
- public void EnsureLogentriesSinkSource(string name, string token)
- public void EnsureSplunkSinkSouce(string name, string collectorUrl, string hecToken)
- public void EnsureSplunkSinkSource(string name, string collectorUrl, string hecToken)
- public void EnsureSyslogSinkSouce(string name, string server, int port, string application)
- public void EnsureTcpSinkSource(string name, string host, int port)
public interface IReadDatabase : IReadConfigurationParts
- bool DatabaseUpdated()
- bool TestConnection()
- bool IsConnectionHealthy { get; }
public enum SinkType
- Syslog = 5
- Tcp = 5

Relativity.Logging.Configuration.Interface

public interface IWriteConfigurationsParts
- void EnsureLogentriesSinkSouce(string name, string token)
- void EnsureLogentriesSinkSource(string name, string token)
- void EnsureSplunkSinkSouce(string name, string collectorUrl, string hecToken)
- void EnsureSplunkSinkSource(string name, string collectorUrl, string hecToken)
- void EnsureSyslogSinkSouce(string name, string server, int port, string application)
- void EnsureTcpSinkSource(string name, string host, int port)

Relativity.Logging.Configuration.Serilog

public class ConfigurationReaderFactory : ICreateConfigurationReader
- public void EnsureEDDSLogging(LoggerOptions options)
public class SyslogRfc5424WithJsonFormatter : ISyslogFormatter

Relativity.Logging.Sinks

public class MemorySink : ILogEventSink, IDisposable
- public static List<LogEvent> MemoryLogList
- public MemorySink()
- public static void ClearList()
- public void Dispose()
- public void Emit(LogEvent logEvent)
public class TcpSink : PeriodicBatchingSink
- protected static readonly UTF8Encoding Utf8
- public TcpSink(TcpSinkConnectionInfo connectionInfo, ITextFormatter textFormatter, int batchPostingLimit, TimeSpan period, IInternalLogger internalLogger)
public class TcpSinkConnection
- public TcpSinkConnection(TcpSinkConnectionInfo connectionInfo)
- public void Close()
- public Task ConnectAsync()
- public Task FlushAsync()
- public Task WriteAsync(byte[] buffer, int offset, int count)
public class TcpSinkConnectionInfo
- public const int DefaultMaxQueueSize = 10000
- public IPAddress Host { get; }
- public int MaxQueueSize { get; set; }
- public int Port { get; }
- public TcpSinkConnectionInfo(string host, int port)
- public TcpSinkConnectionInfo(IPAddress host, int port)

Relativity.Logging.Sinks.Factory

public class SyslogSinkFactory
public class TcpSinkFactory
- public TcpSinkFactory()
- public ILogEventSink GetTcpSinkConfig(Sink sink)

Relativity.Logging.Tools.ExceptionHandlers

public class ConfigFileExceptionHandler : MarshalByRefObject, IReadFile, IReadConfigurationParts
- public MasterLoggingConfiguration LoggingSetting { get; }
- public ConfigFileExceptionHandler(IReadFile fileReader)
- public List<Configuration> GetAllConfigurations()
- public List<Rule> GetAllRules()
- public List<Sink> GetAllSinks()
- public bool GetEnabled()
- public int GetPollingInterval()
- public void ReadFile()
public class DatabaseExceptionHandler : MarshalByRefObject, IReadDatabase, IReadConfigurationParts
- public bool IsConnectionHealthy { get; }
- public DatabaseExceptionHandler(IReadDatabase databaseReader)
- public List<Configuration> GetAllConfigurations()
- public List<Rule> GetAllRules()
- public List<Sink> GetAllSinks()

Relativity.Logging.Tools.FileLock

public interface ILoggingMutex : IDisposable
- void UseLock(Action useFile)
- void UseLock(Func<bool> useFile)
public class LoggingMutex : ILoggingMutex, IDisposable
- public void UseLock(Action useFile)
- public void UseLock(Func<bool> useFile)