Tracing/logging instructions for Azure Playfab Lobby and Matchmaking SDKs

This topic describes how to capture diagnostic traces generated by the Azure PlayFab Lobby and Matchmaking SDKs.

Note

Our SDKs undergo internal testing before every release to ensure the expected level of functionality and normally don't require logging to be enabled by default, particularly in the shipping version of your game.

However, sometimes it may be needed to capture and share produced logs with Microsoft for troubleshooting and diagnostic purposes.

The type of logs and the way logging should be configured/captured depends on a platform. Our middleware SDKs (Unity and Unreal) use Lobby and Matchmaking C++ SDKs as an underlying dependency component, and a process of configuring/capturing logs for them is the same or very similar to the process for a corresponding C++ SDK. All necessary instructions and pointers are listed in the table below:

Per platform logging instructions

Platform	Log format	Logging instruction guidance location
Android	Plain text	See this README.md file.
Linux	Plain text	See this README.md file.
Switch	Plain text	See Logging section of README.md file included in a NuGet package for this SDK.
PlayStation 4	Plain text	See Logging section of README.md file included in a NuGet package for this SDK.
PlayStation 5	Plain text	See Logging section of README.md file included in a NuGet package for this SDK.
PC (GDK) and Xbox (GDK)	ETW trace	See this README.md file.
Windows 10	ETW trace	See this README.md file.
iOS	Plain text	See this README.md file.
macOS	Plain text	See this README.md file.