You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,24 @@
1
1
# Chronos
2
-
<hr />
3
2
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
3
5
4
## Why was Chronos created?
6
-
<hr />
7
5
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
6
9
7
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
8
11
9
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
10
13
11
## How to Install Chronos
14
-
<hr />
15
12
The Chronos-Microservice-Debugger Express Middleware can be found on npm: https://www.npmjs.com/package/chronos-microservice-debugger
16
13
17
-
To install NPM package:
14
+
To install the NPM package:
18
15
```javascript
19
16
npm install chronos-microservice-debugger
20
17
```
21
18
22
19
The Chronos Electron application is in progress and will soon be availble for public download for all platforms. Please stay tuned.
23
20
24
21
## How to Use Chronos
25
-
<hr />
26
22
There are two main aspects to Chronos-Microservice-Debugger
27
23
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
24
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.
@@ -34,11 +30,11 @@ The parameters are:
34
30
2. databaseType: We currently support PostgreSQL and Mongo. Enter "mongo" or "sql"
35
31
3. databaseURL: Where would you like to store your information? Enter the URL to your database
36
32
4. queryFrequency: How often do you want microHealth to monitor the health of your database? It defaults to every second, but you can choose:
Chronos hopes to inspire an active community of both users and developers. For questions, comments, suggestions, please contact us at [email protected] or submit a pull request.
0 commit comments