AppMap can generate sequence diagrams in the PlantUML format, a textual format which is portable and easy to modify. This lets you integrate with other tools that support the Mermaid or PlantUML syntax. You can touch up the generated diagrams, and copy-paste the diagram text into a wide variety of tools that support the PlantUML format, such as Atlassian Confluence.
There are two ways to generate a PlantUML sequence diagram:
sequence-diagramcommand with the option
You can copy the file contents directly into other tools, or you can customize it first like. If you are going to edit the PlantUML file, be sure and save it as a new file first.
AppMaps can be generated on the command line from your terminal, or within a CI build.
You can generate sequence diagrams using the AppMap CLI command
$ appmap sequence-diagram --format plantuml tmp/appmap/minitest/Following_followers_page.appmap.json
When two AppMaps are similar, it can be useful to represent them as sequence diagrams and then compare them. This is most useful:
Sequence diagram comparisons can be attached to GitHub Pull Requests to make it easier for reviewers to better understand changes in code.
sequence-diagram-diff command takes two diagram files as arguments, and produces a comparison file of the differences between them. For example:
$ appmap sequence-diagram-diff --format plantuml user-search-1.sequence.json user-search-2.sequence.json
Note: this command takes sequence diagram files as arguments, not AppMap files. To convert an AppMap file to sequence diagram format, use this command:
$ appmap sequence-diagram -f json user-search-1.appmap.json
Download the PlantUML JAR file from https://plantuml.com/download
Configure the file location: