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 your system information (components, APIs, dependencies, etc.) without you ever having to search for it or manually draw/update a diagram.
You can find an example system dashboard in our free sandbox: sandbox.multiplayer.app
How the system dashboard worksβ
The system dashboard summarizes all Multiplayer project information across:
- Components
- APIs
- Dependencies
- Environments
You can review this information in two formats:
- As a table (default)
- As a system map
We automatically populate the system dashboard, and generate a complete view of your system, when you fully configure Multiplayer, inlcuding step 2: connect your backend services for deeper insights.
Reading the dashboard statusesβ
When the backend 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. when clicking "Import components" or "Create a component") 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.
Merge duplicate components 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
andapi-service-staging
intoapi-service
- The result is one clean component (
api-service
) with the original names preserved as aliases
How to use it:
- Go to system dashboard β Components tab
- Select the components you want to merge
- Click Merge
- In the merge window, name your canonical component. Aliases will be applied automatically for the names of the merged components.
- 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 informationβ
Double clicking on each line item in "Components" will open a side panel with additional information about that item.
Double clicking on line items is not currently enabled for APIs and Dependencies.
Next stepsβ
You did it! Whatβs next?