From 47a18e75303807c392a9f27b6dd3145e89592dae Mon Sep 17 00:00:00 2001 From: Suzanne Ezell Date: Tue, 27 Feb 2024 11:36:06 -0700 Subject: [PATCH] .md file that points to the svg --- .../database_listener_design_documentation.md | 5 ++ docs/database_listeners_sequence_diagram.puml | 10 ++-- docs/database_listeners_sequence_diagram.svg | 55 +++++++++++++++++++ 3 files changed, 66 insertions(+), 4 deletions(-) create mode 100644 docs/database_listener_design_documentation.md create mode 100644 docs/database_listeners_sequence_diagram.svg diff --git a/docs/database_listener_design_documentation.md b/docs/database_listener_design_documentation.md new file mode 100644 index 0000000..f41b448 --- /dev/null +++ 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) \ No newline at end of file diff --git a/docs/database_listeners_sequence_diagram.puml b/docs/database_listeners_sequence_diagram.puml index 8b243dc..85c05e5 100644 --- 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 \ No newline at end of file +@enduml diff --git a/docs/database_listeners_sequence_diagram.svg b/docs/database_listeners_sequence_diagram.svg new file mode 100644 index 0000000..39dee85 --- /dev/null +++ b/docs/database_listeners_sequence_diagram.svg @@ -0,0 +1,55 @@ +GrasshopperGrasshopperTestGrasshopperTestLaunchTestLaunchTestGrasshopperGrasshopperGrasshopperListenersGrasshopperListenersLocustDBListenerLocustDBListenerDbClientDbClientDatabaseDatabaseLocustLocustrun testcreate new grasshopper objectgrasshopper objectcreate new listeners objectcreate new listener objectcreate new client objectconnectnew client objectregister listeners on locust eventsnew listener objectnew listeners objectsend http request (via API library, wich calls the Locust request method)call listener on request eventadd metric for the requestpost data point \ No newline at end of file