Debugging, Logging, and Tracing

If the framework does not behave as expected, it is important to understand how to use the logging and tracing functionality. If this doesn't resolve your issue, you should clone this repo, and add references to the necessary projects so that can debug directly. If the issue still cannot be resolved, then please log a GitHub issue, but please make sure you've followed these steps before reporting an issue.

Debug Tracing

All devices accept an ILogger, and an ITracer as arguments. These are used by the devices to log events that might occur during the process of connecting to and communicating with the device. The simplest logger is DebugLogger, and the simplest tracer is DebugTracer. The Windows sample uses these here. Both these classes will log formatted information to the Debug output Window. When reporting issues, please look at the Debug output window, copy the output, and paste it in to the GitHub issue.

Advanced Use

If logging to the Debug output window is inadequate, please implement the ILogger, and ITracer interfaces and implement your own tracing information. You may want to log to an external telemetry system so that you can track issues in your user's usage of the framework.