Logging System - Categories

[tjvezina]

Depends on: #33
Currently, Log provides simple logging functionality, similar to Console.WriteLine() or Unity's Debug.Log(). In addition, it should be able to assign logs to a category, to visually distinguish them in the console.

Categories are user-defined per project, including name and color, which is prefixed to each log. Categories should be toggleable, to hide any that are irrelevant to current work without deleting them from the project. Logging messages with no category will still be possible.

Category functionality can grow with future features - once the logger includes a runtime debug console, categories could be toggled as the user sees fit to monitor existing systems.

[mbaker3]

I think LogCat's tags on Android is a great example of our aspiration here. I think you captured the intended feature set here.

• Representing the category in the logged string
• Making the category available in the metadata of the log message for Log Hanlders to use as they see fit
• Populating additional metadata along with each log message
  • Calling class
  • Stacktrace?
  • Line Number?
  • Time?
  • Include additional information, defined by the application

(Feel free to split these out into sub tasks if it's too much to tackle at once!)

[mbaker3]

Stumbled upon these docs. May be useful for the log categories or at provide some API inspiration:

• https://docs.microsoft.com/en-us/dotnet/framework/debug-trace-profile/trace-switches
• https://docs.microsoft.com/en-us/dotnet/api/system.diagnostics.tracesource?view=netcore-3.1
• https://docs.microsoft.com/en-us/dotnet/framework/debug-trace-profile/code-contracts