mirror of
https://github.com/ICDSystems/ICD.Common.Utils.git
synced 2026-02-16 13:15:07 +00:00
Created S# .sln and moved project to src folder
This commit is contained in:
94
ICD.Common/Services/Logging/ILoggerService.cs
Normal file
94
ICD.Common/Services/Logging/ILoggerService.cs
Normal file
@@ -0,0 +1,94 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using ICD.Common.Properties;
|
||||
using ICD.Common.Utils;
|
||||
|
||||
namespace ICD.Common.Services.Logging
|
||||
{
|
||||
public enum eSeverity
|
||||
{
|
||||
Emergency = 0,
|
||||
Alert = 1,
|
||||
Critical = 2,
|
||||
Error = 3,
|
||||
Warning = 4,
|
||||
Notice = 5,
|
||||
Informational = 6,
|
||||
Debug = 7
|
||||
}
|
||||
|
||||
public interface ILoggerService
|
||||
{
|
||||
[PublicAPI]
|
||||
event EventHandler<LogItemEventArgs> OnEntryAdded;
|
||||
|
||||
[PublicAPI]
|
||||
event EventHandler<SeverityEventArgs> OnSeverityLevelChanged;
|
||||
|
||||
/// <summary>
|
||||
/// Gets and sets the severity level.
|
||||
/// </summary>
|
||||
[PublicAPI]
|
||||
eSeverity SeverityLevel { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Adds the log item.
|
||||
/// </summary>
|
||||
/// <param name="item">Log entry to add</param>
|
||||
[PublicAPI]
|
||||
void AddEntry(LogItem item);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the log history.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[PublicAPI]
|
||||
KeyValuePair<int, LogItem>[] GetHistory();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Extension methods for ILoggerService.
|
||||
/// </summary>
|
||||
public static class LoggerServiceExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Adds the log item with string formatting.
|
||||
/// </summary>
|
||||
/// <param name="extends"></param>
|
||||
/// <param name="severity">Severity Code, 0 - 7</param>
|
||||
/// <param name="message">Message Text format string</param>
|
||||
[PublicAPI]
|
||||
public static void AddEntry(this ILoggerService extends, eSeverity severity, string message)
|
||||
{
|
||||
LogItem item = new LogItem(severity, message);
|
||||
extends.AddEntry(item);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds the log item with string formatting.
|
||||
/// </summary>
|
||||
/// <param name="extends"></param>
|
||||
/// <param name="severity">Severity Code, 0 - 7</param>
|
||||
/// <param name="message">Message Text format string</param>
|
||||
/// <param name="args">objects to format into the string</param>
|
||||
[PublicAPI]
|
||||
public static void AddEntry(this ILoggerService extends, eSeverity severity, string message, params object[] args)
|
||||
{
|
||||
extends.AddEntry(severity, string.Format(message, args));
|
||||
}
|
||||
|
||||
[PublicAPI]
|
||||
public static void AddEntry(this ILoggerService extends, eSeverity severity, Exception e, string message)
|
||||
{
|
||||
extends.AddEntry(severity, string.Format("{0}: {1}{2}{3}{2}{4}", e.GetType().Name, message,
|
||||
IcdEnvironment.NewLine, e.Message, e.StackTrace));
|
||||
}
|
||||
|
||||
[PublicAPI]
|
||||
public static void AddEntry(this ILoggerService extends, eSeverity severity, Exception e, string message,
|
||||
params object[] args)
|
||||
{
|
||||
extends.AddEntry(severity, e, string.Format(message, args));
|
||||
}
|
||||
}
|
||||
}
|
||||
126
ICD.Common/Services/Logging/LogItem.cs
Normal file
126
ICD.Common/Services/Logging/LogItem.cs
Normal file
@@ -0,0 +1,126 @@
|
||||
using System;
|
||||
using System.Text;
|
||||
using ICD.Common.Properties;
|
||||
using ICD.Common.Utils;
|
||||
|
||||
namespace ICD.Common.Services.Logging
|
||||
{
|
||||
/// <summary>
|
||||
/// Log Entry Item
|
||||
/// </summary>
|
||||
public struct LogItem
|
||||
{
|
||||
private readonly string m_Message;
|
||||
private readonly eSeverity m_Severity;
|
||||
private readonly DateTime m_Timestamp;
|
||||
|
||||
#region Properties
|
||||
|
||||
/// <summary>
|
||||
/// Accessor only for timestamp.
|
||||
/// </summary>
|
||||
[PublicAPI]
|
||||
public DateTime Timestamp { get { return m_Timestamp; } }
|
||||
|
||||
/// <summary>
|
||||
/// Get/Set for severity level.
|
||||
/// </summary>
|
||||
public eSeverity Severity { get { return m_Severity; } }
|
||||
|
||||
/// <summary>
|
||||
/// Get/Set for message string.
|
||||
/// </summary>
|
||||
public string Message { get { return m_Message; } }
|
||||
|
||||
#endregion
|
||||
|
||||
#region Constructors
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new LogItem object with the specified values.
|
||||
/// </summary>
|
||||
/// <param name="severity">Severity Level, between 0 and 7</param>
|
||||
/// <param name="message">Error message text</param>
|
||||
public LogItem(eSeverity severity, string message)
|
||||
{
|
||||
m_Severity = severity;
|
||||
m_Message = message;
|
||||
m_Timestamp = IcdEnvironment.GetLocalTime();
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Methods
|
||||
|
||||
/// <summary>
|
||||
/// Return the text format to send to Fusion
|
||||
/// </summary>
|
||||
/// <returns>text format for fusion, including timestamp, severity, and message</returns>
|
||||
[PublicAPI]
|
||||
public string GetFusionLogText()
|
||||
{
|
||||
StringBuilder s = new StringBuilder();
|
||||
|
||||
s.Append(Timestamp.ToString("yyyyMMddHHmmss"));
|
||||
s.Append("||");
|
||||
s.Append((int)Severity);
|
||||
s.Append("||");
|
||||
s.Append(Message);
|
||||
|
||||
return s.ToString();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Implementing default equality.
|
||||
/// </summary>
|
||||
/// <param name="a1"></param>
|
||||
/// <param name="a2"></param>
|
||||
/// <returns></returns>
|
||||
public static bool operator ==(LogItem a1, LogItem a2)
|
||||
{
|
||||
return a1.Equals(a2);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Implementing default inequality.
|
||||
/// </summary>
|
||||
/// <param name="a1"></param>
|
||||
/// <param name="a2"></param>
|
||||
/// <returns></returns>
|
||||
public static bool operator !=(LogItem a1, LogItem a2)
|
||||
{
|
||||
return !(a1 == a2);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns true if this instance is equal to the given object.
|
||||
/// </summary>
|
||||
/// <param name="other"></param>
|
||||
/// <returns></returns>
|
||||
public override bool Equals(object other)
|
||||
{
|
||||
if (other == null || GetType() != other.GetType())
|
||||
return false;
|
||||
|
||||
return GetHashCode() == ((LogItem)other).GetHashCode();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the hashcode for this instance.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public override int GetHashCode()
|
||||
{
|
||||
unchecked
|
||||
{
|
||||
int hash = 17;
|
||||
hash = hash * 23 + (m_Message == null ? 0 : m_Message.GetHashCode());
|
||||
hash = hash * 23 + (int)m_Timestamp.Ticks;
|
||||
hash = hash * 23 + (int)m_Severity;
|
||||
return hash;
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
16
ICD.Common/Services/Logging/LogItemEventArgs.cs
Normal file
16
ICD.Common/Services/Logging/LogItemEventArgs.cs
Normal file
@@ -0,0 +1,16 @@
|
||||
using ICD.Common.EventArguments;
|
||||
|
||||
namespace ICD.Common.Services.Logging
|
||||
{
|
||||
public sealed class LogItemEventArgs : GenericEventArgs<LogItem>
|
||||
{
|
||||
/// <summary>
|
||||
/// Constructor.
|
||||
/// </summary>
|
||||
/// <param name="item"></param>
|
||||
public LogItemEventArgs(LogItem item)
|
||||
: base(item)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
16
ICD.Common/Services/Logging/SeverityEventArgs.cs
Normal file
16
ICD.Common/Services/Logging/SeverityEventArgs.cs
Normal file
@@ -0,0 +1,16 @@
|
||||
using ICD.Common.EventArguments;
|
||||
|
||||
namespace ICD.Common.Services.Logging
|
||||
{
|
||||
public sealed class SeverityEventArgs : GenericEventArgs<eSeverity>
|
||||
{
|
||||
/// <summary>
|
||||
/// Constructor.
|
||||
/// </summary>
|
||||
/// <param name="data"></param>
|
||||
public SeverityEventArgs(eSeverity data)
|
||||
: base(data)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user