Structurizr Stats Generator

[qtzar]

Wrote a plugin for Structurizr that creates a new Document Section in the Workspace. It works great with Structurizr-Site-Generatr as the markdown uses some of the advanced FlexMark features that were added.

Here is the code, just needs to be compiled in to a jar file and put in the 'plugins' folder of your dsl file structure. The stats are coded around a concept of nested groups in the DSL, with a parent group, portfolio groups and engineering team groups but you should be able to adjust the code as needed.

StatsPlugin.txt

At the BOTTOM of your DSL workspace file add the following, making sure you update the name of the main group used for the enterprise. the container.sections define how you want to break down the tags for containers and the container.NAME.tags need to exist for each container section to show what tags appear in that grouping.

!plugin com.dcsg.StatsPlugin {
            output "landscapes/statistics.md"
            systems.parent "ROOT ENTERPRISE GROUP NAME"
            container.sections "Frontend,Backend,Storage,Queues,Connectors,Misc,Services,Future"
            container.Frontend.tags "ReactWeb,Android,ReactNative,Angular"
            container.Backend.tags "SpringBootJava,SpringBootKotlin,dotnet,.NET Framework,Python,JavaEE,NodeJS"
            container.Queues.tags "KafkaTopic,RabbitQueue,webMethods,JbossQueue,Control-M"
            container.Storage.tags "Redis,Elastic,Microsoft Azure - Azure Cosmos DB,Microsoft Azure - Azure Database PostgreSQL Server,Microsoft Azure - Azure SQL,Microsoft Azure - Azure Database MySQL Server,SQL Server 2016,SQL Server 2019,OracleDB,DB2,Microsoft Azure - SQL Server,Microsoft Azure - SQL Database"
            container.Connectors.tags "KafkaConnect,KafkaHttpSinkConnector,KafkaJdbcSourceConnector,KsqlTransform"
            container.Misc.tags "Microsoft Azure - Application Insights,Microsoft Azure - Cognitive Search,Microsoft Azure - Storage Container,Microsoft Azure - General Storage,Microsoft Azure - Storage Accounts,Microsoft Azure - Azure Spring Apps,Microsoft Azure - Data Factories,Microsoft Azure - Logic Apps,Microsoft Azure - Function Apps,Azure Durable Function,Microsoft Azure - Azure Service Bus"
            container.Services.tags "APIEndpoint,SFTPServer,SMTPServer"
            container.Future.tags "New,Deprecated,Enhance,Unchanged"
        }

Note : it is very important that the plugin is the last thing in the DSL as it needs the DSL model to have been read in completely to be able to get the details needed to generate the stats.

The generated markdown will get added to the DSL's model as a documentation section and will appear in the sidebar in the generated site.

Overall stats :

Stats for the portfolios :

Stats for a single portfolio broken down by engineering team :

Container Tag Stats showing details of where to find the container:

Relationship Stats : ( this needs more work to be able to specify tags via the plugin config )