Relativity.Logging 2019.3.0

API Differences between 2019.3.0 and 1.0.1

167 Additions 19 Removals

Relativity.Logging

public class ConfigFileReader : MarshalByRefObject, IReadFile, IReadConfigurationParts, IDisposable
- public static ConfigFileReader Instance { get; set; }
- public List<Configuration> GetAllConfigurations()
- public List<Rule> GetAllRules()
- public List<Sink> GetAllSinks()
- public List<Rule> GetRules()
- public List<Sink> GetSinks()
- public int GetPollingInterval()
- public Configuration ParseConfig(XmlNode configNode)
- public void ParseRuleNodeForConfiguration(XmlNode configNode, List<Configuration> configurations)
public class Constants
- public const string OPERATION_CONTEXT = "OperationContext"
- public const string OPERATION_ID = "OperationID"
public interface IInternalLogger
- void Write(string message)
- void Write(string message, LoggerOptions options)
- void WriteFromExternal(string message, LoggerOptions options)
public class LoggerOptions
- public void AddSinkParameter(string name, object value)
public class NullInternalLogger : IInternalLogger
- public NullInternalLogger()
- public void Write(string message)
- public void Write(string message, LoggerOptions options)
- public void WriteFromExternal(string message, LoggerOptions options)

Relativity.Logging.Configuration

public class Configuration
- public string Application { get; set; }
- public int Id { get; set; }
- public bool LoggingEnabled { get; set; }
- public string MachineName { get; set; }
- public int Order { get; set; }
- public int PollingInterval { get; set; }
- public string SubSystem { get; set; }
- public string System { get; set; }
- public Configuration()
- public Configuration(string machineName, string system, string subSystem, string application, bool loggingEnabled)
- public bool CompareConfigurationToOptions(LoggerOptions options)
public interface IReadConfigurationParts
- bool GetEnabled()
- List<Rule> GetRules()
- List<Sink> GetSinks()
- List<Configuration> GetAllConfigurations()
- List<Rule> GetAllRules()
- List<Sink> GetAllSinks()
public interface IReadFile : IReadConfigurationParts
- bool GetEnabled()
- int GetPollingInterval()
public abstract class PeriodicBatchingSinkConfig : Sink
- public const int DefaultBatchSizeLimit = 1000
- public const int DefaultWaitPeriodSeconds = 60
- public int BatchSizeLimit { get; }
- public int WaitPeriodSeconds { get; }
- protected PeriodicBatchingSinkConfig(string name, int batchSizeLimit, int waitPeriodSeconds)
public class RelativityHttpSinkConfig : PeriodicBatchingSinkConfig
- public const string CredentialSinkParameterKey = "relativity-http-sink-credential"
- public const string InstanceUrlSinkParameterKey = "relativity-http-sink-instance-url"
- public RelativityHttpSinkConfig(string name, int batchSizeLimit, int waitPeriodSeconds)
public class Rule
- public int Id { get; set; }
- public int Order { get; set; }
- public Rule()
- public string GetLoggingLevelNumericValue()
- public string GetSemicolonDelimitedSinks()
public class SeqSinkConfig : PeriodicBatchingSinkConfig
- public const string ApiKeySinkParameterKey = "seq-sink-api-key"
- public const string ServerUrlSinkParameterKey = "seq-sink-server-url"
- public SeqSinkConfig(string name, int batchSizeLimit, int waitPeriodSeconds)
public class SplunkSinkConfig : Sink
- public string CollectorUrl { get; }
- public string HecToken { get; }
- public SplunkSinkConfig(string name, string collectorUrl, string hecToken)
public class SQLSinkConfig : Sink
- public string SchemaName { get; }
- public SQLSinkConfig(string name, string connectionString, string tableName, string schemaName)
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 EDDSReader(LoggerOptions options, IReadDatabase databaseReader)
- public bool IsConnectionHealthy { get; }
- public EDDSReader(LoggerOptions options, IReadDatabase databaseReader)
- public bool TestConnection()
public class FailOverReader : IReadConfiguration
- public FailOverReader(LoggerOptions options, IReadDatabase databaseReader)
public class LocalFile : IReadConfiguration
- public LocalFile(LoggerOptions options, IReadFile reader)

Relativity.Logging.Configuration.EDDS

public class DatabaseReader : MarshalByRefObject, IReadDatabase, IReadConfigurationParts
- public static DatabaseReader Instance { get; set; }
- public bool IsConnectionHealthy { get; }
- public DatabaseReader(LoggerOptions options, int pollingInterval)
- public DatabaseReader(LoggerOptions options, ICreateSinks sinkFactory, int pollingInterval)
- public bool GetEnabled()
- public List<Rule> GetRules()
- public List<Sink> GetSinks()
- public bool TestConnection()
- public bool EnsureEDDSLogging()
- public List<Configuration> GetAllConfigurations()
- public List<Rule> GetAllRules()
- public List<Sink> GetAllSinks()
public class DatabaseWriter : IWriteDatabase, IWriteConfigurationsParts
- public class SinkTypeData
- public DatabaseWriter(LoggerOptions options)
- public void DeleteConfiguration(Configuration config)
- public void DeleteRule(Rule rule)
- public void EnsureConfiguration(Configuration config)
- public void EnsureDataGridSink(string name, string dataGridEndPoint)
- public void EnsureFileSink(string name, string logFileLocation, int maxFileSize)
- public void EnsureLogentriesSinkSource(string name, string token)
- public void EnsureRule(Rule rule)
- public void EnsureSplunkSinkSource(string name, string collectorUrl, string hecToken)
- public void EnsureSqlSinkSource(string name, string connectionString, string tableName)
- public void EnsureTcpSinkSource(string name, string host, int port)
public interface IReadDatabase : IReadConfigurationParts
- bool DatabaseUpdated()
- bool TestConnection()
- bool IsConnectionHealthy { get; }
public interface IWriteDatabase : IWriteConfigurationsParts
public enum SinkType
- Splunk = 6
- Tcp = 5

Relativity.Logging.Configuration.Interface

public interface IWriteConfigurationsParts
- void DeleteConfiguration(Configuration config)
- void DeleteRule(Rule rule)
- void EnsureConfiguration(Configuration config)
- void EnsureDataGridSink(string name, string dataGridEndPoint)
- void EnsureFileSink(string name, string logFileLocation, int maxFileSize)
- void EnsureLogentriesSinkSource(string name, string token)
- void EnsureRule(Rule rule)
- void EnsureSplunkSinkSource(string name, string collectorUrl, string hecToken)
- void EnsureSqlSinkSource(string name, string connectionString, string tableName)
- void EnsureTcpSinkSource(string name, string host, int port)

Relativity.Logging.Configuration.Serilog

public class ConfigurationReaderFactory : ICreateConfigurationReader
- public void EnsureEDDSLogging(LoggerOptions options)
public class ElasticSearchJsonFormatterExtended : ElasticsearchJsonFormatter
- public ElasticSearchJsonFormatterExtended(bool omitEnclosingObject = false, string closingDelimiter = null, bool renderMessage = false, IFormatProvider formatProvider = null, IElasticsearchSerializer serializer = null, bool inlineFields = false)
- public ElasticSearchJsonFormatterExtended(bool omitEnclosingObject = false, string closingDelimiter = null, bool renderMessage = false, IFormatProvider formatProvider = null, IElasticsearchSerializer serializer = null, bool inlineFields = false)

Relativity.Logging.Factory

public static class LogFactory
- public static ILog GetLogger(LoggerOptions options, IInternalLogger internalLogger)
- public static ILog GetLogger(LoggerOptions options, LogConfiguration configuration, IInternalLogger internalLogger)

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)
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 RelativitySinkFactory
- public RelativitySinkFactory(LoggerOptions options)
- public ILogEventSink GetHttpSink(Sink sink)
public class SeqSinkFactory
- public SeqSinkFactory(LoggerOptions options)
- public ILogEventSink GetSeqSink(Sink sink)
public class SplunkSinkFactory
- public SplunkSinkFactory()
- public ILogEventSink GetSplunkSinkConfig(Sink sink)
public class TcpSinkFactory
- public TcpSinkFactory()
- public ILogEventSink GetTcpSinkConfig(Sink sink)

Relativity.Logging.Tools

public class InternalLogger
- public static InternalLogger Instance { get; }
- public static void WriteTokCuraEventLog(string message, string system)
- public InternalLogger()
- public static void Initialize(IInternalLogger internalLogger)
- public static void WriteFromExternal(string message, LoggerOptions options)
public class InternalTraceLogger : IInternalLogger
- public InternalTraceLogger(LoggerOptions options)
- public static void WriteFromExternal(string message, LoggerOptions options)
- public void Write(string message)
- public void Write(string message, LoggerOptions options)

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)