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 configuring 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.

Screenshot of the System Dashboard with auto-documentation configured

How the System Dashboard Works​

The System Dashboard summarizes all Multiplayer project information across:

🔑 Pro Tip: If you don’t have auto-documentation configured, you will still be able to see a summary of all components and platforms within your Multiplayer project.

What's visible in the System Dashboard when auto-documentation is not configured

🔑 Pro Tip: When System Auto-Documentation is configured, we can discover and document more information about your system and we’ll automatically update the APIs and Dependencies tabs.

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

What's visible in the System Dashboard when auto-documentation is configured

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. 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: 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 configured, next to each Component, API and dependency in your System Dashboard you will see a status icon.

  • 🟢 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.
  • 🟣 Detected = The component has been detected by Auto-Documentation, but does not exist in Multiplayer. If “Auto-add” is configured 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.

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

Show differences toggle in the System Dashboard

Filtering the System Dashboard results​

Filtering options for the System Dashboard results varies according to section you're checking. For example, the "Components" section supports filtering by:

  • Platform
  • Environment
  • Status
  • Tag

Filtering options in the System Dashboard for components

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

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

Filtering options in the System Dashboard for dependencies

Deep dive into each item​

Double clicking on each line item in Components, APIs, and Platforms will open a side panel with additional information and metadata 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 line items will open the respective deep session replays.

Next Steps​

You did it! What’s next?