Skip to content

Commit 86bf929

Browse files
committed
README logo & link
1 parent e0d93f2 commit 86bf929

1 file changed

Lines changed: 38 additions & 34 deletions

File tree

README.md

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,14 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
2424
2. [Install Dependencies](#2.-install-dependencies)
2525
3. [Configure Chronos](#3.-configure-chronos)
2626
4. [Initialize Chronos](#4.-initialize-chronos)
27+
5. [Docker Configuration](#docker-configuration)
2728
- [Notifications](#notifications)
2829
- [Slack](#slack)
2930
- [Email](#email)
3031
- [Branches](#branches)
31-
- [Master](#master)
32+
- [Master](#master-branch)
3233
- [Examples](#examples)
33-
- [Middleware](#middleware)
34-
- [Microservices](#microservices)
35-
- [Docker](#docker)
36-
- [ChronosWebsite](#chronoswebsite)
37-
- [Others](#others)
34+
- [Middleware](#middleware-branch)
3835
- [Technologies](#technologies)
3936
- [License](#license)
4037

@@ -155,9 +152,30 @@ chronos.propagate();
155152
app.use('/', chronos.track());
156153
```
157154

158-
You should be good to go!
155+
You should be good to go! The last step, Step #5, is **only applicable** if you need to configure <img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /> for your application.
159156

157+
### 5. Docker Configuration
160158

159+
Again, this step is **only applicable** if you are currently using <img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /> containers for your microservices.
160+
161+
<img src="./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.
162+
163+
<img src="./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:
164+
```
165+
/var/run/docker.sock
166+
```
167+
168+
For example, you can type the following when starting up a container:
169+
```
170+
docker run -v /var/run/docker.sock:/var/run/docker.sock [your-image-tag]
171+
```
172+
173+
If you're using `docker-compose` to start up multiple containers, you can add a `volumes` key for each of your services in the `docker-compose.yml` file:
174+
175+
```
176+
volumes:
177+
- "/var/run/docker.sock:/var/run/docker.sock"
178+
```
161179
#
162180
###### Return to [Top](#Chronos)
163181
<br>
@@ -222,7 +240,8 @@ notifications: [
222240

223241
## Branches
224242

225-
### Master
243+
### Master Branch
244+
#
226245

227246
The **'master'** branch of this repository is where the <img src="./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.
228247

@@ -231,46 +250,31 @@ The **'master'** branch of this repository is where the <img src="./app/assets/e
231250
root directory -> electron -> user -> settings.json
232251
```
233252

234-
#### Examples
253+
### Examples
254+
#
235255

236-
We provide two working example microservice applications in the `master` branch for you to test out Chronos.
256+
We provide two working example microservice applications in the `master` branch for you to test out Chronos: `microservices` and `docker`.
237257

238258
#### Microservices
259+
#
239260

240-
The **'dummy-microservice'** branch is where we provide a test suite of sample microservices 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 <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> app.
241-
242-
The microservices include individual <img src="./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.
261+
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 <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> app.
243262

244-
Refer to the [README](https://github.com/oslabs-beta/Chronos/tree/docker/microservice) of that branch for more details.
245-
<br>
246263
<br>
247264

248265
#### Docker
266+
#
249267

250-
The '<img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /> **/microservice'** branch is where we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience..
251-
252-
<img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> Give your containers the same names you use for arguments for microservice names. Read more about it under the INSTALLATION section below.
268+
In the <img src="./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.
253269

254-
<img src="./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, when starting up the containers, bind volumes to this path:
255-
```
256-
/var/run/docker.sock
257-
```
258-
259-
For example, you can type the following when starting up a container:
260-
```
261-
docker run -v /var/run/docker.sock:/var/run/docker.sock [your-image-tag]
262-
```
270+
The `docker` folder includes individual <img src="./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.
263271

264-
If you're using docker-compose to start up multiple containers at once, you can add a `volumes` key for each of your services in the YAML file:
272+
Refer to the [README](link) in the `docker` folder for more details.
265273

266-
```
267-
volumes:
268-
- "/var/run/docker.sock:/var/run/docker.sock"
269-
```
270274
<br>
271275

272-
### Middleware
273-
276+
### Middleware Branch
277+
#
274278
The **'middleware'** branch is the current codebase for the <img src="./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.
275279
<br>
276280

0 commit comments

Comments
 (0)