themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Overhaul debug logging

Browse source 
Debug logging now provides ConsoleDebug and ILog has been updated to
support the concept of debug logs. Debug logs are now controlled by
config.json instead of by preprocessor debug flag.
This commit is contained in:
Lucas Nicodemus 2020-05-19 21:14:06 -07:00
parent 19de422304
commit b76d906c59
No known key found for this signature in database
GPG key ID: A07BD9023D1664DB
5 changed files with 68 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -2,6 +2,9 @@
This is the rolling changelog for TShock for Terraria. Use past tense when adding new entries; sign your name off when you add or change something. This should primarily be things like user changes, not necessarily codebase changes unless it's really relevant or large.
## Upcoming changes
* Debug logging now provides ConsoleDebug and ILog has been updated to support the concept of debug logs. Debug logs are now controlled by `config.json` instead of by preprocessor debug flag. (@hakusaro)
## TShock 4.4.0 (Pre-release 3)
* Fixed `/worldmode` command to correctly target world mode. (@Ristellise)
* The following commands have been removed: `tbloodmoon`, `invade`, `dropmeteor`. `fullmoon`, `sandstorm`, `rain`, `eclipse`

3
TShockAPI/ConfigFile.cs
View file

@ -520,6 +520,9 @@ namespace TShockAPI
[Description("Whether or not to show backup auto save messages.")]
public bool ShowBackupAutosaveMessages = true;
[Description("Whether or not the server should output debug level messages related to system operation.")]
public bool DebugLogs = false;
/// <summary>
/// Reads a configuration file from a given path
/// </summary>

16
TShockAPI/ILog.cs
View file

@ -123,13 +123,25 @@ namespace TShockAPI
void Write(string message, TraceLevel level);
/// <summary>
/// Writes a debug string to the log file. Only works if the DEBUG preprocessor conditional is set.
/// Writes a debug string to the log file and console. Only works if the DebugLogs config option is set to true.
/// </summary>
/// <param name="message">The message to be written.</param>
void ConsoleDebug(string message);
/// <summary>
/// Writes a debug string to the log file. Only works if the DebugLogs config option is set to true.
/// </summary>
/// <param name="message">The message to be written.</param>
void ConsoleDebug(string message, params object[] args);
/// <summary>
/// Writes a debug string to the log file. Only works if the DebugLogs config option is set to true.
/// </summary>
/// <param name="message">The message to be written.</param>
void Debug(string message);
/// <summary>
/// Writes a debug string to the log file. Only works if the DEBUG preprocessor conditional is set.
/// Writes a debug string to the log file. Only works if the DebugLogs config option is set to true.
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>

30
TShockAPI/SqlLog.cs
View file

@ -205,15 +205,34 @@ namespace TShockAPI
ConsoleInfo(string.Format(format, args));
}
/// <summary>
/// Writes a debug string to the log file. Also outputs to the console. Requires config TShock.DebugLogs to be true.
/// </summary>
/// <param name="message">The message to be written.</param>
public void ConsoleDebug(string message)
{
Console.WriteLine("Debug: " + message);
Write(message, TraceLevel.Verbose);
}
/// <summary>
/// Writes a debug string to the log file. Also outputs to the console. Requires config TShock.DebugLogs to be true.
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
public void ConsoleDebug(string format, params object[] args)
{
ConsoleDebug(string.Format(format, args));
}
/// <summary>
/// Writes a debug string to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void Debug(string message)
{
#if DEBUG
Write(message, TraceLevel.Verbose);
#endif
if (TShock.Config.DebugLogs)
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -223,9 +242,8 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void Debug(string format, params object[] args)
{
#if DEBUG
Debug(string.Format(format, args));
#endif
if (TShock.Config.DebugLogs)
Debug(string.Format(format, args));
}
public void Write(string message, TraceLevel level)

30
TShockAPI/TextLog.cs
View file

@ -172,15 +172,34 @@ namespace TShockAPI
ConsoleInfo(string.Format(format, args));
}
/// <summary>
/// Writes a debug string to the log file. Also outputs to the console. Requires config TShock.DebugLogs to be true.
/// </summary>
/// <param name="message">The message to be written.</param>
public void ConsoleDebug(string message)
{
Console.WriteLine("Debug: " + message);
Write(message, TraceLevel.Verbose);
}
/// <summary>
/// Writes a debug string to the log file. Also outputs to the console. Requires config TShock.DebugLogs to be true.
/// </summary>
/// <param name="format">The format of the message to be written.</param>
/// <param name="args">The format arguments.</param>
public void ConsoleDebug(string format, params object[] args)
{
ConsoleDebug(string.Format(format, args));
}
/// <summary>
/// Writes a debug string to the log file.
/// </summary>
/// <param name="message">The message to be written.</param>
public void Debug(string message)
{
#if DEBUG
Write(message, TraceLevel.Verbose);
#endif
if (TShock.Config.DebugLogs)
Write(message, TraceLevel.Verbose);
}
/// <summary>
@ -190,9 +209,8 @@ namespace TShockAPI
/// <param name="args">The format arguments.</param>
public void Debug(string format, params object[] args)
{
#if DEBUG
Debug(string.Format(format, args));
#endif
if (TShock.Config.DebugLogs)
Debug(string.Format(format, args));
}
/// <summary>