.md file that points to the svg

alteryx · Feb 27, 2024 · 47a18e7 · 47a18e7
1 parent 0b9f94b
commit 47a18e7
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 4 deletions.
diff --git a/docs/database_listener_design_documentation.md b/docs/database_listener_design_documentation.md
@@ -0,0 +1,5 @@
+# Database Listener for Locust/Grasshopper Design Documentation
+
+## Sequence Diagram of how listeners are currently working within the framework
+
+![Sequence Diagram](database_listeners_sequence_diagram.svg)
diff --git a/docs/database_listeners_sequence_diagram.puml b/docs/database_listeners_sequence_diagram.puml
@@ -2,9 +2,11 @@
 
 @startuml
 actor GrasshopperTest
-control LaunchTest
-boundary Grasshopper
+box "Grasshopper" #LightBlue
+boundary LaunchTest
+entity Grasshopper
 entity GrasshopperListeners
+end box
 entity LocustDBListener
 boundary DbClient
 database Database
@@ -41,6 +43,6 @@ deactivate LaunchTest
 GrasshopperTest -> Locust : send http request (via API library, wich calls the Locust request method)
 Locust ->> LocustDBListener : call listener on request event
 LocustDBListener ->> DbClient : add metric for the request
-DbClient ->> Database : post data point 
+DbClient ->> Database : post data point
 
-@enduml
+@enduml
diff --git a/docs/database_listeners_sequence_diagram.svg b/docs/database_listeners_sequence_diagram.svg