Skip to content

Commit 0617277

Browse files
authored
Update README.md
1 parent e3356ee commit 0617277

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,24 @@
11
# Chronos
2-
<hr />
32
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.
43

54
## Why was Chronos created?
6-
<hr />
75
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.
86

97
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.
108

119
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.
1210

1311
## How to Install Chronos
14-
<hr />
1512
The Chronos-Microservice-Debugger Express Middleware can be found on npm: https://www.npmjs.com/package/chronos-microservice-debugger
1613

17-
To install NPM package:
14+
To install the NPM package:
1815
```javascript
1916
npm install chronos-microservice-debugger
2017
```
2118

2219
The Chronos Electron application is in progress and will soon be availble for public download for all platforms. Please stay tuned.
2320

2421
## How to Use Chronos
25-
<hr />
2622
There are two main aspects to Chronos-Microservice-Debugger
2723
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.
2824
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:
3430
2. databaseType: We currently support PostgreSQL and Mongo. Enter "mongo" or "sql"
3531
3. databaseURL: Where would you like to store your information? Enter the URL to your database
3632
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
33+
* "s" : The default, monitors every second
34+
* "m" : Monitors every minute
35+
* "h" : Monitors every hour
36+
* "d" : Monitors once per day
37+
* "w" : Monitors once per week
4238

4339
String parameter example:
4440
```javascript
@@ -83,7 +79,6 @@ chronos-microservice-debugger.microHealth(values)
8379
```
8480
8581
## How to Contribute to Chronos
86-
<hr />
8782
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.
8883
8984
## Created By

0 commit comments

Comments
 (0)