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, etc.

Screenshot of the System Dashboard with auto-documentation configured

How the System Dashboard Works​

The system dashboard summarizes all Multiplayer project information across:

  • Components
  • APIs
  • Platforms
  • Dependencies

🔑 Pro Tip: When you integrate with OpenTelementry, we can discover and document more information about your system. The "APIs" and "Dependencies" tabs in the system dashboard will automatically update.

Getting Started with Auto-Documentation and Debugger​

  • Open your project
  • In the left-side menu, click "System" to open the system dashboard
  • Click "Configure 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 the OTel integration 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. Your system dashboard is showing full sync between the information manually added to your Multiplayer project and the information automatically detected in your system.
  • ⬜️ Documented = The component exists in Multiplayer and has not been detected. This may happen when you manually add components in your Multiplayer project (e.g. by editing a platform) 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, but does not exist in Multiplayer.

🔑 Pro Tip: To easily identify the 🟣 detected components, you can toggle on "Show differences". This option appears only if the OTel integration has been setup.

Show differences toggle in the System Dashboard

Merge Duplicate Components in the System Dashboard​

Merge button in the System Dashboard

We detect 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

Merging two components in the System Dashboard

Filtering the System Dashboard results​

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

  • Platform
  • Environment
  • Status
  • Tag

Filtering options in the System Dashboard for components

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

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

Filtering options in the System Dashboard for dependencies

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.

Opening the APIs side panel in the System Dashboard

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?