🧬Local Debugging
Debugging the kernel locally
Locally debugging the kernel allows you to diagnose the kernel directly on the host computer. Debugging information from different kernel components are saved to a kernel debugging file, kernelDbg-#.log
, where it is numbered depending on how many times the kernel is run.
Structure
The structure of the local debugging log is like the below picture:

The local debug logs contain two versions of formatting:
Classic
Each of these fields have their own values, as follows:
date
: The date of the eventtime
: The time of the eventlevel
: One character error level, which is one of:T
: Trace verbose messageD
: Debug verbose messageI
: Informational messageW
: Warning messageE
: Error messageF
: Fatal error message
method
: The method name in which the message was postedsource
: The source code file where the method is foundlinenum
: The line number from the source filemessage
: The message
Modern
Each of these fields have their own values, as follows:
date
: The date of the eventtime
: The time of the eventlevel
: One character error level, which is one of:T
: Trace verbose messageD
: Debug verbose messageI
: Informational messageW
: Warning messageE
: Error messageF
: Fatal error message
fully-qualified-method
: The full method name in which the message was postedmessage
: The message
Debug your Mods
To debug your mods, they must call the debug functions in order for the kernel to acknowledge your message. There are useful functions listed below that may help you debug your routines in your mods.
Normal Debugging
Calling the debug function below will post your debug message to the kernel debugger normally. There's a function for you to call below:
Found in the DebugWriter
module under the Nitrocid.Kernel.Debugging
namespace.
Conditional Debugging
Calling the debug function below will post your debug message to the kernel debugger if the condition that you've set within the function is satisfied. There's a function for you to call below:
Found in the DebugWriter
module under the Nitrocid.Kernel.Debugging
namespace.
Privacy-aware Debugging
Calling the debug function below will post your debug message to the kernel debugger normally. However, it also filters every variable you've selected to be censored in the debug log. For example, if you provide two variables (A, B) and B contains sensitive info, you may want to create an array of indexes which holds B's index (in this case, 1) when calling the below function.
Found in the DebugWriter
module under the Nitrocid.Kernel.Debugging
namespace.
Stack Trace Debugging
Calling the debug function below will post the stack trace of an exception, including its inner exceptions, to the kernel debugger. There's a function for you to call below:
Found in the DebugWriter
module under the Nitrocid.Kernel.Debugging
namespace.
Stack Trace Conditional Debugging
Calling the debug function below will post the stack trace of an exception, including its inner exceptions, to the kernel debugger if the condition that you've set within the function is satisfied. There's a function for you to call below:
Found in the DebugWriter
module under the Nitrocid.Kernel.Debugging
namespace.
Debug quotas
If you want to rotate logs each n
th message, such as the 10000th message, you can enable this feature by going to the kernel settings and enabling it there. You can also set the number of messages before the log rotation occurs.
If this session's debug quota is exceeded, the new debug file is created with the increasing number. For example, if kernelDbg-0.log
exceeds 10000 messages, the debugger creates the kernelDbg-1.log
and writes further messages there, and so on.
Last updated