How to download C4 Container and Component Diagrams
- Distributed Applications
- Monolithic Applications
Environment
vFunction introduced the ability to download C4 Container Diagrams in Distributed Applications beginning in Server version 4.0. In Server version 4.2, this functionality was added to Monolithic Applications as well to be able to download C4 Component Diagrams.
Distributed Applications - Overview
In Distributed Applications, users can export a measurement as a C4 Container diagram. These diagrams can be edited as code, and imported back to vFunction to iterate on architectural planning, generating prescriptive TODOs for engineers to change the architecture to whatever was planned. Users can also import their existing diagrams to see the difference between existing and documented architectures, and can automatically generate documentation required for compliance.
In Distributed Applications, uploaded diagrams create a Reference Architecture visible in the Measurements list. Users can mark a reference as the “Latest Reference”, and differences between the latest reference and actual architecture generate actionable TODOs.
Distributed Applications - Steps to download
Take the following steps to download C4 Diagrams:
- Log into the vFunction Server UI
- Select the relevant Application from the top-left dropdown next to the vFunction icon
- Click the Analysis tab in the top, center menu bar
- Hover over the Measurement’s name in the top left-hand sidebar
- Click Export C4 Diagram to download the Measurement diagram as a PlantUML file
Monolithic Applications - Overview
In Monolithic Applications, vFunction supports generating and exporting C4 Component Diagrams from a Call Tree. The diagrams take into account architectural boundaries, calls between domains and access to resources, making it easier to understand system structure and highlight architecture issues across domain boundaries.
Monolithic Applications - Steps to download
Take the following steps to see and download C4 Diagrams in Monolithic Applications:
- Log into the vFunction Server UI
- Select the relevant Application from the top-left dropdown next to the vFunction icon
- Click the Analysis tab in the top, center menu bar
- Click the relevant Domain in the right-hand sidebar to expand the Domain options
- Click Explore Tree next to Entry Points
- Toggle between Call Tree and Component Diagram in the top of the center pane
- If desired, download the Component Diagram as a PNG by clicking the Download Icon at the top of the center pane
- If desired, copy the Mermaid Script by clicking the Copy icon at the top of the center pane