Skip to content

Commit e3356ee

Browse files
nmczormicknmczormick
authored
Update README.md
Updated README.md. Would like to insert photos of Electron app
1 parent 6fe2d96 commit e3356ee

1 file changed

Lines changed: 92 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,93 @@
11
# Chronos
2+
<hr />
3+
Chronos consists of an NPM package to be required into a user’s microservices that intercepts all http and gRPC microservice communications, as well as monitors the health of each microservice over time. This information is written to a user-owned database (PostgreSQL or NoSQL) where it is queried and rendered by the frontend utilizing Node in conjunction with a native, cross-platform Electron desktop application with React components to ensure agreement between the frontend and database.
4+
5+
## Why was Chronos created?
6+
<hr />
7+
As companies grow larger and begin to scale, they have a tendency to move from a monolithic code architecture and microservices and distributed systems architecture in order to build faster, more maintainable code.
8+
9+
The process of modularizing a code bases and breaking a monolith into individual services can be a daunting task. How do you break apart and re-connect these services? There is often a transitional period where valuable time is spent debugging these connections between services.
10+
11+
Chronos is deigned to meet the needs of companies and developers working to break down their monoliths into distributed systems by combining an NPM package together with an Electron application to monitor and assist in the debugging of their services.
12+
13+
## How to Install Chronos
14+
<hr />
15+
The Chronos-Microservice-Debugger Express Middleware can be found on npm: https://www.npmjs.com/package/chronos-microservice-debugger
16+
17+
To install NPM package:
18+
```javascript
19+
npm install chronos-microservice-debugger
20+
```
21+
22+
The Chronos Electron application is in progress and will soon be availble for public download for all platforms. Please stay tuned.
23+
24+
## How to Use Chronos
25+
<hr />
26+
There are two main aspects to Chronos-Microservice-Debugger
27+
1. Communication Monitor: Listens in on all microservice-microservice and microservice-client communication and monitors the response statuses and messages to ensure communications are making it to the correct destination successfully.
28+
2. Health Monitor: The health monitor checks the status of your microservice every second and sends this health information to an optional electron frontend where it is visualized for easier use.
29+
30+
To use the npm package, there are three required parameters and an optional fourth parameter. You can enter the items as individual strings or as an array containing the three required parameters and one optional parameter.
31+
32+
The parameters are:
33+
1. microserviceName: What do you want to name the current microservice
34+
2. databaseType: We currently support PostgreSQL and Mongo. Enter "mongo" or "sql"
35+
3. databaseURL: Where would you like to store your information? Enter the URL to your database
36+
4. queryFrequency: How often do you want microHealth to monitor the health of your database? It defaults to every second, but you can choose:
37+
..1. "s" : The default, monitors every second
38+
..2. "m" : Monitors every minute
39+
..3. "h" : Monitors every hour
40+
..4. "d" : Monitors once per day
41+
..5. "w" : Monitors once per week
42+
43+
String parameter example:
44+
```javascript
45+
// How to use chronos-microservice-debugger
46+
app.use('/', chronos-microservice-debgugger.microCom('microserviceName', 'databaseType', 'databaseURL'))
47+
48+
chronos-microservice-debugger.microHealth('microserviceName', 'databaseType', 'databaseURL', 'queryFrequency'))
49+
50+
// Example using string parameters
51+
app.use('/', chronos-microservice-debugger.microCom('books', 'sql', 'thisIsMyURL'))
52+
// Note: microCom does not utilize queryFreq because it logs all communication when an endpoint is hit
53+
54+
chronos-microservice-debugger.microHealth('books', 'sql', 'thisIsMyURL', 'h')
55+
```
56+
57+
Array parameter example:
58+
```javascript
59+
let values = [
60+
'microserviceName',
61+
'databaseType',
62+
'databaseURL',
63+
'queryFrequency'
64+
]
65+
// How to use chronos-micrservice-debugger with an array parameter
66+
app.use('/', chronos-microservice-debgugger.microCom(values)
67+
68+
chronos-microservice-debugger.microHealth(values)
69+
70+
// Example using an array parameter
71+
let values = [
72+
'books',
73+
'mongo',
74+
'thisIsMyNewURL',
75+
'w'
76+
]
77+
78+
app.use('/', chronos-microservice-debgugger.microCom(values)
79+
// Note: microCom does not utilize queryFreq because it logs all communication when an endpoint is hit
80+
81+
chronos-microservice-debugger.microHealth(values)
82+
83+
```
84+
85+
## How to Contribute to Chronos
86+
<hr />
87+
Chronos hopes to inspire an active community of both users and developers. For questions, comments, suggestions, please contact us at teammicronos@gmail.com or submit a pull request.
88+
89+
## Created By
90+
* Duane McFarlane
91+
* Michelle Herrera
92+
* Mohtasim Chowdhury
93+
* Natalie Umanzor

0 commit comments

Comments
 (0)