Seminar 15: Poster Assignment Deadline | Checkpoint #4 - Final Evaluation
Goal: Assess the integration of all the components, conduct end-to-end testing, and add system-wide monitoring.
Introduction
In Session 15, we reach another milestone with Checkpoint #4, a final concise 10-15 minute evaluation per group. This session also marks the deadline to deliver your Poster. The checkpoint evaluation process will involve a demonstration where you will showcase the functionality of your system. While the demo can be simple, it should effectively highlight that your implementation is generating the expected behaviour. This practical demonstration is designed to assess your understanding of the concepts covered and the successful execution of key functionalities. During the evaluation, there is no need to scrutinize your code. Instead, we will focus on your design decisions. Represent your choices in diagrams and leverage the dashboards you created.
Task
As we approach Checkpoint #4, it's crucial to finalize your distributed system implementation, document key aspects, ensure smooth deployment, add system logs, and provide clarity through version tagging and comprehensive diagrams. These are the concrete tasks for this week:
- Finish the implementation: Complete the remaining tasks in your distributed system project, ensuring all functionalities align with the concepts covered in the sessions.
- Document Relevant Code: Provide concise and informative documentation for crucial sections of your code, aiding in understanding and evaluation.
- Docker Setup: Verify that your services can be spun up seamlessly using Docker and Docker Compose. Confirm they connect with the provided frontend and other client software to showcase the desired functionality.
- Add System Logs: Implement relevant system logs within your application to offer insights into the functioning and interactions of different components.
- Commit Changes to Repository: Commit the latest changes to your project repository, keeping it up-to-date and facilitating a smooth evaluation process.
- Create "checkpoint-4" Tag: Add a version tag "checkpoint-4" to mark this stage of your project in the repository, allowing for easy reference and tracking.
- Diagrams and Dashboards: Create visual documentation for your project by developing concise and informative diagrams. Leverage the dashboards you created to showcase the behavior and observability over your system.
- Final Architecture Diagram: Develop an architecture diagram illustrating the multiple services, ports, communication protocols, and their relationships within your distributed system.
- Grafana Dashboard: Create a Grafana Dashboard to visualize the collection of your metrics and traces.
- Schedule: Choose your team slot for the evaluation time here.
- This week is also the deadline (24th of May) for the delivery of the Poster. You may ask for preliminary feedback during the checkpoint evaluation, before submitting, by the end of the day. Upload your poster here in PDF format.
Evaluation
During the Checkpoint #4 evaluation, each group will have 10-15 minutes to showcase their distributed system project. Be prepared to provide a demonstration, displaying the proper functionality of your system. Emphasize the implementation of system logs to offer insights into your project's inner workings. Additionally, represent your design decisions using diagrams, providing a visual guide for a more comprehensive understanding of your distributed system. Create also a Grafana Dashboard to visualize the metrics and traces collected throughout the execution of your system. You may only enter the room in the assigned time slot. Make sure to have at least one laptop with your solution ready to be demoed and with the codebase and diagrams and dashboards ready to be displayed.
Distribution of points
- 2 - The entire system is up and running, with all the components, and the entire order execution flow is working properly.
- 2.5 - Manual and Automated Test suites and demonstration covering all the cases.
- 2.5 - Metrics and Traces collection and demonstration covering all the cases.
- 0.5 - Logging.
- 0.5 - Project organization, documentation, collaboration, and other factors...
- 1 - Architecture diagram.
- 1 - Grafana Dashboard.
Total: 10 points
This week is also the deadline (24th of May) for the delivery of the Poster. You may ask for preliminary feedback during the checkpoint evaluation, before submitting, by the end of the day. Upload your poster here in PDF format.