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
@@ -68,9 +68,9 @@ This is for the latest Chronos version **5.1 release and later**.
68
68
- LTS release: 5.0.1
69
69
70
70
### 1. Pre-Installation
71
-
Make sure you're running version 12.18.3 of <ahref="#"><imgsrc="./app/assets/node-logo-color.png"alt="Node"title="Node"align="center"height="20" /></a>, which is the most recent LTS (long-term support) version.
71
+
Make sure you're running version 12.18.3 of <ahref="#"><imgsrc="./app/assets/node-logo-color.png"alt="Node"title="Node"align="center"height="20" /></a></a>, which is the most recent LTS (long-term support) version.
72
72
73
-
If you need to roll back from <imgsrc="./app/assets/node-logo-color.png"alt="Node"title="Node"align="center"height="20" /> 14.9.0, make sure to run
73
+
If you need to roll back from <ahref="#"><imgsrc="./app/assets/node-logo-color.png"alt="Node"title="Node"align="center"height="20" /></a> 14.9.0, make sure to run
74
74
```npm rebuild```
75
75
in the root directory.
76
76
@@ -118,10 +118,10 @@ The `database` property is required and takes in the following:
118
118
-`URI` which should be a connection string the database you intend Chronos to write and record data regarding health, HTTP route tracing, and container infomation to. A `.env` is recommended.
119
119
120
120
<!-- - `isDockerized`: Is this microservice running in a Docker container? Enter `yes` or `no`. The current default setting is `no`.
121
-
- <img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> When starting up the container, give it the same name that you used for the microservice, because the middleware finds the correct container ID of your container by matching the container name to the microservice name you input as 1st argument.
122
-
- <img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> Don't forget to bind mount to Docker socket. -->
121
+
- <img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /></a> When starting up the container, give it the same name that you used for the microservice, because the middleware finds the correct container ID of your container by matching the container name to the microservice name you input as 1st argument.
122
+
- <img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /></a> Don't forget to bind mount to Docker socket. -->
123
123
124
-
The `notifications` property is optional. Jump to the section below, [Notifications](#notifications) to configure <imgsrc="./app/assets/slack-logo-color.png"alt="Slack"title="Slack"align="center"height="20" /> or email <imgsrc="./app/assets/email-icon-black.png"alt="Slack"title="Slack"align="center"height="20" /> notifications.
124
+
The `notifications` property is optional. Jump to the section below, [Notifications](#notifications) to configure <ahref="#"><imgsrc="./app/assets/slack-logo-color.png"alt="Slack"title="Slack"align="center"height="20" /></a> or email <ahref="#"><imgsrc="./app/assets/email-icon-black.png"alt="Slack"title="Slack"align="center"height="20" /></a> notifications.
125
125
<br>
126
126
<br>
127
127
@@ -147,16 +147,16 @@ chronos.propagate();
147
147
app.use('/', chronos.track());
148
148
```
149
149
150
-
You should be good to go! The last step, Step #5, is **only applicable** if you need to configure <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> for your application.
150
+
You should be good to go! The last step, Step #5, is **only applicable** if you need to configure <ahref="#"><imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /></a> for your application.
151
151
<br>
152
152
153
153
### 5. Docker Configuration
154
154
155
-
Again, this step is **only applicable** if you are currently using <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> containers for your microservices.
155
+
Again, this step is **only applicable** if you are currently using <ahref="#"><imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /></a> containers for your microservices.
156
156
157
-
<imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /> Give your containers the same names you pass as arguments for microservice names.
157
+
<ahref="#"><imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /></a> Give your containers the same names you pass as arguments for microservice names.
158
158
159
-
<imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /> In order to have container stats saved to your database, along with other health info, bind volumes to this path when starting up the containers:
159
+
<ahref="#"><imgsrc="./app/assets/important.png"alt="Important"title="Important"align="center"height="20" /></a> In order to have container stats saved to your database, along with other health info, bind volumes to this path when starting up the containers:
160
160
```
161
161
/var/run/docker.sock
162
162
```
@@ -185,7 +185,7 @@ Chronos only supports **Slack** and **email** notifications.
185
185
186
186
### Slack
187
187
188
-
Chronos uses the <imgsrc="./app/assets/slack-logo-color.png"alt="Slack"title="Slack"align="center"height="20" /> API to send messages to a Slack channel and only requires the **webhook url**. Learn how to set up [Slack webhooks](https://api.slack.com/messaging/webhooks) for your team.
188
+
Chronos uses the <ahref="#"><imgsrc="./app/assets/slack-logo-color.png"alt="Slack"title="Slack"align="center"height="20" /></a> API to send messages to a Slack channel and only requires the **webhook url**. Learn how to set up [Slack webhooks](https://api.slack.com/messaging/webhooks) for your team.
189
189
190
190
An example of configured **slack** settings:
191
191
@@ -203,7 +203,7 @@ notifications: [
203
203
```
204
204
205
205
### Email
206
-
Chronos provides the option to send <imgsrc="./app/assets/email-icon-black.png"alt="Slack"title="Slack"align="center"height="20" /> emails. The properties that should be provided are the following
206
+
Chronos provides the option to send <ahref="#"><imgsrc="./app/assets/email-icon-black.png"alt="Slack"title="Slack"align="center"height="20" /></a> emails. The properties that should be provided are the following
207
207
-`emails` - The recipient list (string) can be a single email address or multiple as comma seprated values.
208
208
-`emailHost` - The smtp host (string) of your email server
209
209
-`emailPort` - The email port (integer) is either **465** or **587** depending on the sender email security settings. Learn more about email ports by reading the [nodemailer docs](https://nodemailer.com/smtp/)
@@ -238,7 +238,7 @@ notifications: [
238
238
239
239
### Master Branch
240
240
241
-
The **'master'** branch of this repository is where the <imgsrc="./app/assets/electron-logo-color.png"alt="Electron"title="Electron"align="center"height="20" /> application for Chronos is deployed. The Chronos monitoring tool includes two database examples, one PostgresQL and one MongoDB, with sample data sets.
241
+
The **'master'** branch of this repository is where the <ahref="#"><imgsrc="./app/assets/electron-logo-color.png"alt="Electron"title="Electron"align="center"height="20" /></a> application for Chronos is deployed. The Chronos monitoring tool includes two database examples, one PostgresQL and one MongoDB, with sample data sets.
242
242
243
243
**NOTE:** To _replace_ or _delete_ these two databases, simply change the database URIs stored in the following path:
244
244
```
@@ -251,23 +251,23 @@ We provide two working example microservice applications in the `master` branch
251
251
252
252
#### _Microservices_
253
253
254
-
In the `microservices` folder, we provide a sample microservice application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the <imgsrc="./app/assets/electron-logo-color.png"alt="Electron"title="Electron"align="center"height="20" /> app.
254
+
In the `microservices` folder, we provide a sample microservice application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the <imgsrc="./app/assets/electron-logo-color.png"alt="Electron"title="Electron"align="center"height="20" /></a> app.
255
255
256
256
Refer to the [README](link) in the `microservices` folder for more details.
257
257
258
258
#### _Docker_
259
259
260
-
In the <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> folder within the `master` branch, we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience.
260
+
In the <ahref="#"><imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /></a> folder within the `master` branch, we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience.
261
261
262
-
The `docker` folder includes individual <imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /> files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
262
+
The `docker` folder includes individual <ahref="#"><imgsrc="./app/assets/docker-logo-color.png"alt="Docker"title="Docker"align="center"height="20" /></a> files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
263
263
264
264
Refer to the [README](link) in the `docker` folder for more details.
265
265
266
266
<br>
267
267
268
268
### Middleware Branch
269
269
270
-
The **'middleware'** branch is the current codebase for the <imgsrc="./app/assets/npm-logo-color.png"alt="NPM"title="NPM"align="center"height="20" /> package, which is what you will install in your own application in order to use Chronos. Download the <imgsrc="./app/assets/npm-logo-color.png"alt="NPM"title="NPM"align="center"height="20" /> package [here](link).
270
+
The **'middleware'** branch is the current codebase for the <ahref="#"><imgsrc="./app/assets/npm-logo-color.png"alt="NPM"title="NPM"align="center"height="20" /></a> package, which is what you will install in your own application in order to use Chronos. Download the <ahref="#"><imgsrc="./app/assets/npm-logo-color.png"alt="NPM"title="NPM"align="center"height="20" /></a> package [here](link).
271
271
<br>
272
272
273
273
#
@@ -276,26 +276,26 @@ The **'middleware'** branch is the current codebase for the <img src="./app/asse
@@ -314,6 +314,6 @@ Development of Chronos is open source on GitHub through the tech accelerator umb
314
314
315
315
## License
316
316
317
-
Chronos is <imgsrc="./app/assets/mit-logo-color.png"alt="MIT"title="MIT"align="center"height="20" /> [licensed.](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
317
+
Chronos is <ahref="#"><imgsrc="./app/assets/mit-logo-color.png"alt="MIT"title="MIT"align="center"height="20" /></a> [licensed.](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
0 commit comments