Skip to content
This repository was archived by the owner on Aug 2, 2023. It is now read-only.

Commit 85105b1

Browse files
mogarg18mccoyp
authored andcommitted
Update to Readme (#172)
* adding new screenshots for readme update * reorganizing photos * update readme adding to visualize your data section * Rerouting photos * fixing typos
1 parent ebfce4e commit 85105b1

9 files changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The data a developer chooses to view for their application is easily customizabl
2121

2222
## Architecture Overview
2323

24-
![Architecture Diagram](Architecture.PNG)
24+
![Architecture Diagram](docs/Photos/Architecture.PNG)
2525

2626
### Data Collection
2727
Data collection is performed via a class library that can be utilized in the user's executable code for the application they want to monitor. All that is required to perform this tracking is to include the library, create a class instance, and call the class' Record() function.
@@ -88,10 +88,30 @@ monitor.Record();
8888

8989
Now when we view the web application, we'll be able to see the performance of both processes factor into performance of the overall application. Below is a diagram showing the structure of the system:
9090

91-
![Application Diagram](Application.png)
91+
![Application Diagram](docs/Photos/Application.png)
9292

9393
If we were to additionally create two new processes - "Process3" and "Process4", respectively - with arbitrary sampling and transmission rates but no application name, the system would now look like this:
9494

95-
![New Application Diagram](Applications.png)
95+
![New Application Diagram](docs/Photos/Applications.png)
9696

9797
Each process can be viewed individually, but they will be organized under whatever application they belong to. This allows an application with multiple, distinct processes or microservices to be easily tracked as a cohesive unit.
98+
99+
## Visualize your Data
100+
101+
Once the web application is spin up, the user is prompted to enter the application and process name of the session that they want to monitor. The web application would look similar to this.
102+
103+
![Homepage for Web Application](docs/Photos/landingHomepage.PNG)
104+
105+
Once the user clicks on an application name, all the associated process names will appear on the adjacent menu.
106+
107+
![Selecting application name](docs/Photos/selectingApplication.PNG)
108+
109+
Once the user clicks on a process name and clicks "Examine", the side bar will update to inform the user what session they are currently viewing data for and the menus will be cleared.
110+
111+
![Selected Session](docs/Photos/updatingSideBartoSession.PNG)
112+
113+
Now, the user can utilize the sidebar to navigate between the different metric pages and view the data collected from their application. For example, once the CPU and Memory tab is selected on the sidebar, the user will see the CPU and Memory graphs (which live update), the average percentage cpu used, the average memory used, and a table.
114+
115+
![CPU and Memory graphs](docs/Photos/cpuMemGraphs.PNG)
116+
117+
![CPU and Memory tables](docs/Photos/tables.PNG)
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/Photos/cpuMemGraphs.PNG

189 KB
Loading

docs/Photos/landingHomepage.PNG

104 KB
Loading

docs/Photos/selectingApplication.PNG

105 KB
Loading

docs/Photos/tables.PNG

175 KB
Loading
109 KB
Loading

0 commit comments

Comments
 (0)