Make logging more intuitive

This commit is contained in:
Matt Nadareski
2020-09-15 14:38:37 -07:00
parent f506915a04
commit fc580c7d35
29 changed files with 88 additions and 64 deletions

View File

@@ -44,7 +44,7 @@ namespace RombaSharp.Features
string line = sr.ReadLine(); string line = sr.ReadLine();
if (line != "CRC,MD5,SHA-1") // ,Depot if (line != "CRC,MD5,SHA-1") // ,Depot
{ {
Globals.Logger.Error("{0} is not a valid export file"); Globals.Logger.Error($"{input} is not a valid export file");
continue; continue;
} }

View File

@@ -169,7 +169,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -481,7 +481,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -750,7 +750,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -816,7 +816,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -890,7 +890,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -939,7 +939,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -2286,7 +2286,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (IOException ex) catch (IOException ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -3526,7 +3526,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error($"Datfile {outfile} could not be written out: {ex}"); Globals.Logger.Error(ex, $"Datfile {outfile} could not be written out");
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }
@@ -3535,7 +3535,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -322,7 +322,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -138,7 +138,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -189,7 +189,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -153,7 +153,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -314,7 +314,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -1201,7 +1201,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -733,7 +733,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -92,7 +92,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -721,7 +721,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -583,7 +583,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -421,7 +421,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -407,7 +407,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -250,7 +250,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -159,7 +159,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -575,7 +575,7 @@ namespace SabreTools.Library.DatFiles
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (throwOnError) throw ex; if (throwOnError) throw ex;
return false; return false;
} }

View File

@@ -126,7 +126,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -207,7 +207,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -249,7 +249,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -389,7 +389,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -90,7 +90,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -180,7 +180,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -252,7 +252,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -83,7 +83,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -166,7 +166,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -229,7 +229,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -273,7 +273,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }

View File

@@ -132,7 +132,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -250,7 +250,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -340,7 +340,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -396,7 +396,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }
@@ -615,7 +615,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -847,7 +847,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -89,7 +89,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -172,7 +172,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -235,7 +235,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -279,7 +279,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }
@@ -435,7 +435,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -618,7 +618,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -84,7 +84,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -172,7 +172,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -241,7 +241,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -133,7 +133,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -251,7 +251,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -345,7 +345,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -401,7 +401,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }
@@ -619,7 +619,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -852,7 +852,7 @@ namespace SabreTools.Library.FileTypes
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -91,7 +91,7 @@ namespace SabreTools.Library.IO
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error($"An exception occurred getting the full path for '{input}': {ex}"); Globals.Logger.Error(ex, $"An exception occurred getting the full path for '{input}'");
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -115,7 +115,7 @@ namespace SabreTools.Library.IO
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error($"An exception occurred processing '{dir}': {ex}"); Globals.Logger.Error(ex, $"An exception occurred processing '{dir}'");
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }
@@ -194,7 +194,7 @@ namespace SabreTools.Library.IO
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error($"An exception occurred getting the full path for '{input}': {ex}"); Globals.Logger.Error(ex, $"An exception occurred getting the full path for '{input}'");
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
@@ -218,7 +218,7 @@ namespace SabreTools.Library.IO
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error($"An exception occurred processing '{file}': {ex}"); Globals.Logger.Error(ex, $"An exception occurred processing '{file}'");
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }
@@ -238,7 +238,7 @@ namespace SabreTools.Library.IO
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error($"An exception occurred processing '{input}': {ex}"); Globals.Logger.Error(ex, $"An exception occurred processing '{input}'");
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;
} }

View File

@@ -247,6 +247,18 @@ namespace SabreTools.Library.Logging
return Log(output, LogLevel.USER, appendPrefix); return Log(output, LogLevel.USER, appendPrefix);
} }
/// <summary>
/// Write the given exception as a warning to the log output
/// </summary>
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <param name="appendPrefix">True if the level and datetime should be prepended to each statement (default), false otherwise</param>
/// <returns>True if the output could be written, false otherwise</returns>
public bool Warning(Exception ex, string output = null, bool appendPrefix = true)
{
return Warning($"{(output != null ? output + ": " : string.Empty)}{ex}", appendPrefix);
}
/// <summary> /// <summary>
/// Write the given string as a warning to the log output /// Write the given string as a warning to the log output
/// </summary> /// </summary>
@@ -259,6 +271,18 @@ namespace SabreTools.Library.Logging
return Log(output, LogLevel.WARNING, appendPrefix); return Log(output, LogLevel.WARNING, appendPrefix);
} }
/// <summary>
/// Writes the given exception as an error in the log
/// </summary>
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <param name="appendPrefix">True if the level and datetime should be prepended to each statement (default), false otherwise</param>
/// <returns>True if the output could be written, false otherwise</returns>
public bool Error(Exception ex, string output = null, bool appendPrefix = true)
{
return Error($"{(output != null ? output + ": " : string.Empty)}{ex}", appendPrefix);
}
/// <summary> /// <summary>
/// Writes the given string as an error in the log /// Writes the given string as an error in the log
/// </summary> /// </summary>

View File

@@ -201,7 +201,7 @@ namespace SabreTools.Library.Skippers
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error(ex.ToString()); Globals.Logger.Error(ex);
if (Globals.ThrowOnError) if (Globals.ThrowOnError)
throw ex; throw ex;

View File

@@ -421,7 +421,7 @@ Reset the internal state: reset();";
} }
catch (Exception ex) catch (Exception ex)
{ {
Globals.Logger.Error($"There was an exception processing {path}: {ex}"); Globals.Logger.Error(ex, $"There was an exception processing {path}");
continue; continue;
} }
} }