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: chronos_npm_package/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,7 +89,7 @@ _See mode-specific configuration descriptions in the "Chronos Tracker for Micros
89
89
90
90
The `microservice` property takes in a string. This should be a descriptive name for your microservice.
91
91
92
-
- <imgsrc="assets/important.png"alt="Important"title="Important"align="center"height="20" /> For **Dockerized** microservices, this field **must** match the _container_name_ of the corresponding Docker container.
92
+
- <imgsrc="../assets/important.png"alt="Important"title="Important"align="center"height="20" /> For **Dockerized** microservices, this field **must** match the _container_name_ of the corresponding Docker container.
93
93
94
94
The `interval` property is optional and takes in an integer. This controls the Chronos monitoring frequency. If this is omitted, Chronos will default to recording server health every 60000 ms or 60 seconds.
95
95
@@ -279,7 +279,7 @@ When viewing your information in the Chronos Electron application the data will
279
279
280
280
### Chronos Tracker for gRPC
281
281
282
-
To monitory your gRPC server, setup `chronos-config.js` as if it was a standard microservices example, but be sure to set the `connection` type to `gRPC`.
282
+
To monitor your gRPC server, setup `chronos-config.js` as if it was a standard microservices example, but be sure to set the `connection` type to `gRPC`.
Microservices architecture for testing [Chronos](https://github.com/open-source-labs/Chronos), a microservice communication and health visualizer.
5
3
@@ -13,11 +11,12 @@ Each microservice has its own server, which receives requests from both the clie
13
11
14
12
## Getting Started w/ gRPC Example Microservices
15
13
16
-
Follow **'main'** branch README steps: Pre-Installation, Install Dependencies before start.
14
+
Follow **'main'** branch [README](../../README.md) steps: Pre-Installation, Install Dependencies before start.
15
+
16
+
We have already initialized Chronos within this example. To track gRPCs within your own application, please review the [README for the Chronos microtracker npm package](../../chronos_npm_package/README.md) for more information.
17
17
18
-
On each microservice in example/microservices, perform the following steps
19
-
-**NOTE: Do this for microservices: books, orders, & reverse proxy**
20
-
- Create a .env file under each microservice folder and input your own Mongodb Atlas URI for Microservice_URI, CHRONOS_URI and ORDER_URI, see example below:
18
+
On **each** microservice in ```example/microservices```, perform the following steps:
19
+
- Create a .env file under the microservice's folder and input your own Mongodb Atlas URI for Microservice_URI, CHRONOS_URI and ORDER_URI (example below):
- In each Microservices *chronos-config.js* file, verify that `"mode"` property has a value of `"microservices"`
30
28
29
+
- In each Microservices *chronos-config.js* file, verify that `"mode"` property has a value of `"microservices"`
31
30
32
-
-** Note: The Initialize Chronos step is already taken care of for you.
33
31
- Inside each microservice directory, install all dependencies using the `npm install`
34
32
- Run `npm run start` in each folder directory
35
-
- Head over to localhost:3000 to view reverse proxy acting as the frontend of this microservice example
33
+
- Head over to localhost:3000 to view reverse proxy acting as the front end of this microservice example
36
34
37
35
<palign="center">
38
36
<imgalt="gRPC reverse proxy front end"src="../../assets/gRPC_example_reverseProxy.png">
39
37
</p>
40
38
41
39
- Start adding data!
42
-
- Run `npm run both` to start Electron app
40
+
- Run `npm run dev:app` and `npm run dev:electron`**in separate terminals** to start Electron app
43
41
- Add a new application in Chronos app dashboard.
44
42
- The URI should be your CHRONOS_URI
45
43
46
44
47
-
**To test the functionality of Chronos using this sample microservices architecture, you must have the [Chronos node module](https://www.npmjs.com/package/chronos-microservice-debugger3) within each microservice.**
48
-
49
-
This is already included as a dependency therefore there should be no need to install it manually. But if it is missing from the dependency list, the installation instructions for both the Chronos node module and the Chronos desktop visualizer are below:
45
+
**To test the functionality of Chronos using this sample microservices architecture, you must have the [Chronos microservice tracker](https://www.npmjs.com/package/@chronosmicro/tracker) within each microservice.**
50
46
47
+
This is already included as a dependency, therefore there should be no need to install it manually. But if it is missing from the dependency list, the installation instructions for both the Chronos node module and the Chronos desktop visualizer are below:
51
48
52
49
#### Electron desktop application
53
50
54
51
After installing the node module in each microservice, download the Electron desktop application from the public [Chronos](https://github.com/oslabs-beta/Chronos) repo.
55
52
56
-
Inside the downloaded directory, install all dependencies using the `npm install` command followed by the `npm run both` command to start the Electron desktop application.
53
+
Inside the downloaded directory, install all dependencies using the `npm install` command, followed by the `npm run both` command to start the Electron desktop application.
57
54
58
55
## Contributing
59
56
@@ -67,3 +64,4 @@ Chronos hopes to inspire an active community of both users and developers. For q
Copy file name to clipboardExpand all lines: examples/kubernetes/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ This example demonstrates how `Chronos` can be used to track health metrics of a
7
7
-*scripts*: Scripts to automate some of the steps involved in running the example
8
8
9
9
## Install Docker Desktop
10
-
This example has been developed and tested using the Kubernetes Engine packaged in the Docker Desktop application. Follow instructions online to download/install Docker Desktop and to enable the Kubernetes Engine.
10
+
This example has been developed and tested using the Kubernetes Engine packaged in the Docker Desktop application.
11
11
12
+
Follow instructions online to download/install Docker Desktop and to **enable the Kubernetes Engine**. The examples will not work without the Kubernetes Engine enabled.
12
13
## Build the Client
13
14
`cd` into the *client* folder and run the following command:
14
15
```
15
16
docker build -t frontend:1.0 .
16
-
17
17
```
18
18
**Mac Users:** Alternatively running the above command, `cd` into the scripts folder and run the `buildClient.sh` script
0 commit comments