A tool for quantifying data integrity violations in event-driven microservices.
-
Python and Matplotlib - This is needed to visualize the results
To run the tool against an example event-driven application, we will separately deploy the modified version of a popular open-source application eShopOnContainers. You can use the original project, but please take care of authentication and updating catalog items in the example scenario provided with the tool. This step can be performed after installing the tool as well.
-
Install Docker Compose
-
Configure the application by following the original guidelines
-
Run the below command from the
/src/directory of eShopOnContainers to deploy necessary microservices for the example scenarios.
docker-compose up -d webmvc
Configure the property file to set up RabbitMQ connector (as per the external event driven application), logger and max thread pool allowed for the scenarios.
#RabbitMQ Connection prop:
rabbitmq.username=guest
rabbitmq.password=guest
rabbitmq.virtualhost=/
rabbitmq.hostname=localhost
rabbitmq.port=5672
#Logger prop:
#Path separator expected at the end. Specify as per the OS path separators; otherwise, the default path will be used.
logger.path=/home/HawkEDA/
#ThreadPool:
executors.nThreads=100Build and package the project. This generates a package with required dependencies at /HawkEDA/target/HawkEDA-1.0-SNAPSHOT-jar-with-dependencies.jar
mvn clean package
java -cp /HawkEDA/target/HawkEDA-1.0-SNAPSHOT-jar-with-dependencies.jar HawkEDA SCENARIO_CLASS_NAME [arguments]
Executing scenarios included in the tool:
java -cp /HawkEDA/target/HawkEDA-1.0-SNAPSHOT-jar-with-dependencies.jar HawkEDA CheckoutWhilePriceUpdateScenario 500 zipfian 25
java -cp /HawkEDA/target/HawkEDA-1.0-SNAPSHOT-jar-with-dependencies.jar HawkEDA OutOfStockCheckoutScenario 500 uniform 100
java -cp /HawkEDA/target/HawkEDA-1.0-SNAPSHOT-jar-with-dependencies.jar HawkEDA SingleBasketMultipleCheckoutScenario 10
Execution Result and Logs:
After the execution, result and event log will be stored in the path specified in the property files or the default path \HawkEDA\logs.
Format of the log files:
- Esper - Complex Event Processor
- YCSB - Distribution generator for the workload
- Hawk Icon by deviantART:qsc123951
When referring to HawkEDA, please refer to the following work:
@inbook{10.1145/3465480.3467838,
author = {Das, Prangshuman and Laigner, Rodrigo and Zhou, Yongluan},
title = {HawkEDA: A Tool for Quantifying Data Integrity Violations in Event-Driven Microservices},
year = {2021},
isbn = {9781450385558},
publisher = {Association for Computing Machinery},
address = {New York, NY, USA},
url = {https://doi.org/10.1145/3465480.3467838},
abstract = {A microservice architecture advocates for subdividing an application into small and
independent components, each communicating via well-defined APIs or asynchronous events,
to allow for higher scalability, availability, and fault isolation. However, the implementation
of substantial amount of data management logic at the application-tier and the existence
of functional dependencies cutting across microservices create a great barrier for
developers to reason about application safety and performance trade-offs.To fill this
gap, this work presents HawkEDA, the first data management tool that allows practitioners
to experiment their microservice applications with different real-world workloads
to quantify the amount of data integrity anomalies. In our demonstration, we present
a case study of a popular open-source event-driven microservice to showcase the interface
through which developers specify application semantics and the flexibility of HawkEDA.},
booktitle = {Proceedings of the 15th ACM International Conference on Distributed and Event-Based Systems},
pages = {176–179},
numpages = {4}
}
This project is licensed under the MIT License - see the LICENSE.md file for details
It could not have been possible without the guidance of: