Debugging and troubleshooting workers
This page covers tools and tips for debugging workers.
Protocol logging records any data exchanged between a worker instance and the deployment it’s connected to, as well as other significant events. It is primarily designed for SpatialOS engineers to help identify internal issues, and you might be asked to provide protocol logs when reporting an issue.
There are a few important caveats that you should be aware of when you use protocol logging:
- Protocol logging records messages at a lower level than ops or methods that you call on the connection. There is no one-to-one correspondence between protocol logs and ops/methods you call on the connection, and the messages that are exchanged can change arbitrarily between SDK versions (including patch versions), and Runtime versions.
- The output is human readable. However, it does not come in any particular format. The output format can change arbitrarily between SDK versions (including patch versions).
- Protocol logging incurs runtime cost.
At the moment, there is no out-of-the-box solution for logging user-level ops.