System Auto-Documentation
System Auto-Documentation (Radar)
With Multiplayer’s System Auto-Documentation functionality (Radar) you can automatically discover, track, and detect drift in your system architecture, dependencies and APIs by directly connecting to your infrastructure.
Radar compares the components, environments, dependencies, and APIs in your project with your real-world system, highlighting missing information and discrepancies.
You don’t have to manually check for drift and create new components, environments, dependencies, and APIs as your system evolves - just set up Radar to do the work for you.
How Radar Works
In Multiplayer, you can visualize your system architecture by creating a platform, adding your components, and connecting them with their relevant dependencies. Components represent all software that uses or provides an API such as web apps, microservices, SaaS providers, etc.
When Radar is enabled, it reviews all the component names (and their respective aliases) in your project or in a selected platform, and it compares them to the component information present in your real-world system.
Radar then lists all the existing platform components, highlighting any detected drift in information in terms of component environment, release version, API actions, and dependencies.
Radar separately lists all newly detected components which are not currently present in the selected Multiplayer platform.
Information in Radar is updated automatically, every time a change happens in the real-world system.
Radar offers options to take action on the detected changes either by automatically merging them into a specified design branch, or by manually merging individual changes one by one.
Getting Started with Radar
- Radar Set Up
- Configuring OTel for multiple observability backends
- Understanding Radar Information
- Merging Radar Information Into a Main or Design Branch
- Add HTTP Endpoint Request and Response Payloads to Radar
Next Steps
You did it! What’s next?