Skip to main content

System Dashboard

đź“Ś If you have any questions shoot us an email or join us on Discord! đź’ś

Overview​

The Multiplayer System Dashboard allows you to visualize your entire system at a glance, with real-time insights.

It summarizes all the information across your project’s platforms, components, APIs, dependencies, and debugger sessions, presenting them in a clear and concise dashboard.

By enabling Auto-Documentation and Debugger you also have access to

  • System Auto-Documentation: It automatically discovers all components, APIs, dependencies, platforms, and environments within your software system and shows them in the dynamic System Dashboard, giving you real-time information about any discrepancies between your documentation and your running system.
  • Platform Debugger: You can record and share deep session replays that include relevant data from frontend screens to distributed traces metrics and logs from your backend platform. All sessions will be automatically listed in the “Debugger” tab of the System Dashboard.

How the System Dashboard Works​

The System Dashboard summarizes all Multiplayer project information across:

*If you don’t have auto-documentation enabled, you will still be able to see a summary of all components and platforms within your Multiplayer project. When System Auto-Documentation is enabled, we can discover and document more information about your system and we’ll automatically update the APIs and Dependencies tabs.

Getting Started with Auto-Documentation and Debugger​

System Auto-Documentation and Platform Debugger both leverage the OpenTelemetry integration to discover and document backend data from your system.

Follow these steps to set up Auto-Documentation and Debugger:

  • Open your project
  • In the left-side menu, click "System" to open the System Dashboard
  • Click "Enable Auto-Docs + Debugger"
  • Name your integration
  • Hit "Create"
  • Two unique tokens will be created for your OTel configuration - follow these steps to complete the OTel integration.

ℹ️ The same OTel config panel is available when navigating from the "Debugger" tab, since both Auto-Documentation and Debugger leverage the same OTel integration.

If you would like Auto-Documentation to automatically create newly detected components that are not currently present in your Multiplayer project, select:

  • The name of the platform where the new components will be auto-created
  • Toggle on "Auto-add”

ℹ️ The ”Auto-documentation is active” message indicates that Multiplayer has created the OpenTelemetry tokens and is listening for your backend data. It’s not indicative that the environment variables with the Multiplayer tokens have been set up correctly in your software system or that OpenTelemetry has been instrumented correctly.

Reading the Auto-Documentation statuses​

When Auto-Documentation is enabled, next to each Component and API in your System Dashboard you will see a status icon.

  • 🟢 Green = The component exists in Multiplayer and has been detected by Auto-Documentation. Your System Dashboard is showing full sync between the information manually added to your Multiplayer project and the information automatically detected in your system by Auto-Documentation.
  • 🔵 Blue = The component exists in Multiplayer and has not been detected by Auto-Documentation. This may happen when you manually add components in your Multiplayer project (e.g. by editing a platform or through a system design review) that do not yet exist in your software system or that have a different name. To prevent naming confusion, you can add multiple aliases to components.
  • 🟣 Purple = The component has been detected by Auto-Documentation, but does not exist in Multiplayer. If “Auto-add” is enabled in your Otel configuration, Auto-Documentation will automatically create newly detected components that are not currently present in your Multiplayer project, in the selected platform.

Next Steps​

You did it! What’s next?