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 Platform Debugger sessions.

By configuring OpenTelemetry you also have access to:

• Auto-Documentation: It automatically discovers all components, APIs, dependencies, platforms, and environments within your software system, 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:

• *Components
• APIs
• *Platforms
• Dependencies
• Debugger sessions

🔑 Pro Tip: If you don’t have Auto-Documentation configured, you will still be able to see a summary of all Components and Platforms manually added within your Multiplayer project.

🔑 Pro Tip: When Auto-Documentation is configured, we can discover and document more information about your system. The APIs and Dependencies tabs in the System Dashboard will automatically update on with Auto-Documentation enabled.

If you also configured the Platform Debugger, all your deep session recordings will appear in the relevant tab as well.

Getting Started with Auto-Documentation and Debugger

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

That's why they share the same set up window and the following OpenTelemetry configuration steps.

• Open your project
• In the left-side menu, click "System" to open the System Dashboard
• Click "Configure Auto-Docs + Debugger"
• Name your integration
• Hit "Create"
• An OpenTelemetry (OTel) token will be created for your OTel integration.
• Follow these steps to configure OpenTelemetry.

🔑 Pro Tip: 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 configured, the System Dashboard will display a status next to each Component and API.

• 🟢 In Sync = 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.
• ⬜️ Documented = 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 or merge components in the System Dashboard.
• 🟣 Detected = The component has been detected by Auto-Documentation, but does not exist in Multiplayer. You can automatically add components and dependecies to your Platform from Platform Auto-Docs in the top navigation bar.

🔑 Pro Tip: To easily identify the 🟣 detected components, you can toggle on "Show differences". This option appears only if Auto-Documentation is enabled.

Merge Duplicate Components in the System Dashboard

Auto-Documentation detects all components in your system based on name.

If your project uses specific naming conventions (e.g. environment-specific naming such as api-service-production and api-service-staging) this can result in duplicate entries that clutter your System Dashboard.

You can now merge these components into a single, canonical component and automatically assign the original names as aliases.

For example:

• Merge api-service-production and api-service-staging into api-service
• The result is one clean component (api-service) with the original names preserved as aliases

How to use it:

1. Go to System Dashboard → Components tab
2. Select the components you want to merge
3. Click Merge
4. In the merge window, name your canonical component. Aliases will be applied automatically for the names of the merged components.
5. Click "Confirm Merge" to apply changes

Filtering the System Dashboard results

Filtering options vary per tab. For example, the "Components" tab supports filtering by:

• Platform
• Environment
• Status
• Tag

As another example, the "Dependencies" tab supports filtering by:

• Source
• Target
• Protocol (HTTP, Messaging, RPC)
• Status

Review Component, API, and Platform Info

Double clicking on each line item in Components, APIs, and Platforms will open a side panel with additional information about that item.

Double clicking on line items is not currently enabled for Dependencies, while double clicking on the Debugger sessions will open the respective deep session replays as separate tabs.

Next Steps

---

You did it! What’s next?

• Automatically document your entire system architecture
• Capture a debugging session with frontend and backend data
• Build, test, and debug API integrations with ease