Skip to content

Commit 302e4c9

Browse files
committed
edited READMEs within examples, main, added contributors, changed npm package version
1 parent 08739a0 commit 302e4c9

File tree

14 files changed

+3217
-3177
lines changed

14 files changed

+3217
-3177
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ Chronos welcomes all pull requests.
2121
- Once compiled, `npm run dev:app` and `npm run dev:electron`
2222
* Note: If typescript is not installed, `npm install -g typescript`
2323

24+
## Chronos Website
25+
26+
The `chronosWebsite` branch holds the code for the website. Edit the website by checking out the branch, modifying the website, and then updating the AWS S3 bucket with the changes.
2427
## Issues
2528

2629
Please do not hesitate to file issues that detail bugs or offer ways to enhace Chronos.

README.md

Lines changed: 96 additions & 65 deletions
Large diffs are not rendered by default.

chronos_npm_package/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,8 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
77

88
## What's New?
99
- Bug Fixes
10-
- Metric query tool so you can filter out specific metrics — now you only have to see what you want on the dashboard.
11-
- Additional metrics added, bringing Chronos up from only 12 to 100+ metrics that are currently available
12-
- Option to filter by category and individual metric, and flip between services and categories with ease
13-
- Kubernetes monitoring via Prometheus server
14-
- Apache Kafka monitoring capability, all you need to do is run Prometheus JMX exporter on the system your Chronos application is running on. A sample JMX config.yaml file is provided in the Chronos repository for a quick and easy setup, however you are free to configure however you like.
10+
- Refactored code for additional modularity and customization
11+
- Ability for developers to increase number of metrics monitored for microservices
1512

1613
#
1714

@@ -75,7 +72,7 @@ module.exports = {
7572
}
7673
```
7774

78-
Then utilize the `chronos-config.js` file into your microservice application by importing it and using it as the Chronos class constructor argument:
75+
Then utilize the `chronos-config.js` file into your application by importing it and using it as the Chronos class constructor argument:
7976
```js
8077
const chronosConfig = require('./chronos-config.js');
8178
const Chronos = require('@chronosmicro/tracker');

chronos_npm_package/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@chronosmicro/tracker",
3-
"version": "8.0.3",
3+
"version": "11.0.1",
44
"description": "Chronos microservice metrics tracker",
55
"main": "chronos.js",
66
"scripts": {

contributors.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
## People
2-
[Josh James](https://github.com/joshjames289)
3-
[Elise Nie](https://github.com/elisanie)
4-
[Gahl Peled](https://github.com/GP3-RS)
5-
[Troy Prejusa](https://github.com/tprejusa)
2+
3+
[Snow X. Bai](https://github.com/xueapp),
4+
[Taylor Zhang](https://github.com/taylrzhang),
5+
[Tim Lee](https://github.com/timlee12),
6+
[Roberto Meloni ](https://github.com/RobertoRueMeloni),
7+
[Brian Lim](https://github.com/brianlim89),
8+
[Claire Tischuk](https://github.com/BoopdiBop),
9+
[Lennon Stewart](https://github.com/noahoo7),
10+
[Victor Ye](https://github.com/vctorye),
11+
[Josh James](https://github.com/joshjames289),
12+
[Elise Nie](https://github.com/elisanie),
13+
[Gahl Peled](https://github.com/GP3-RS),
14+
[Troy Prejusa](https://github.com/tprejusa),
615
[Vince Ho](https://github.com/hodesza)
7-
[Matt Jiang](https://github.com/mattljiang)
8-
[Derek Lam](https://github.com/DerekQuoc)
9-
[Kit Loong Yee](https://github.com/kitloong1)
16+
[Matt Jiang](https://github.com/mattljiang),
17+
[Derek Lam](https://github.com/DerekQuoc),
18+
[Kit Loong Yee](https://github.com/kitloong1),
1019
[Tim Atapagra](https://github.com/timpagra),
1120
[Mohtasim Chowdhury](https://github.com/mohtasim317),
1221
[Ousman Diallo](https://github.com/Dialloousman),

examples/AWS/AWS-EC2/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -128,18 +128,4 @@ git archive -v -o myMM.zip --format=zip HEAD
128128
## Contributing
129129
Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
130130

131-
## People
132-
[Snow X. Bai](https://github.com/xueapp)
133-
[Taylor Zhang](https://github.com/taylrzhang)
134-
[Tim Lee](https://github.com/timlee12)
135-
[Roberto Meloni ](https://github.com/RobertoRueMeloni)
136-
[Brian Lim](https://github.com/brianlim89)
137-
[Claire Tischuk](https://github.com/BoopdiBop)
138-
[Lennon Stewart](https://github.com/noahoo7)
139-
[Victor Ye](https://github.com/vctorye)
140-
[John Donato](https://github.com/jdonuto)
141-
[Iris Wong](https://github.com/wiris316)
142-
[Jon Cruz](https://github.com/Jrcrz)
143-
[Elena Atencio](https://github.com/elenaatencio)
144-
145131

examples/AWS/AWS-ECS/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,3 @@ The way deployment set up is using Fargate, you will not be able to see graphs i
7272

7373
## Contributing
7474
Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
75-
76-
## People
77-
[Snow X. Bai](https://github.com/xueapp)
78-
[Taylor Zhang](https://github.com/taylrzhang)
79-
[Tim Lee](https://github.com/timlee12)
80-
[Roberto Meloni ](https://github.com/RobertoRueMeloni)
81-
[Brian Lim](https://github.com/brianlim89)
82-
[Claire Tischuk](https://github.com/BoopdiBop)
83-
[Lennon Stewart](https://github.com/noahoo7)
84-
[Victor Ye](https://github.com/vctorye)
85-
[John Donato](https://github.com/jdonuto)
86-
[Iris Wong](https://github.com/wiris316)
87-
[Jon Cruz](https://github.com/Jrcrz)
88-
[Elena Atencio](https://github.com/elenaatencio)

examples/AWS/AWS-EKS/README.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -160,13 +160,3 @@ This process can also be done using the AWS Command Line Interface (CLI) or the
160160

161161
## Credit
162162
Credit for Knote application goes to the user learnK8s on [Github](https://github.com/learnk8s). Here is the source project [folder](https://github.com/learnk8s/knote-js/tree/master/04-05/kube).
163-
164-
## People
165-
[Brian Lim](https://github.com/brianlim89)
166-
[Claire Tischuk](https://github.com/BoopdiBop)
167-
[Lennon Stewart](https://github.com/noahoo7)
168-
[Victor Ye](https://github.com/vctorye)
169-
[John Donato](https://github.com/jdonuto)
170-
[Iris Wong](https://github.com/wiris316)
171-
[Jon Cruz](https://github.com/Jrcrz)
172-
[Elena Atencio](https://github.com/elenaatencio)

examples/docker/README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,25 +46,5 @@ Use `docker compose down` to stop containers
4646

4747
## Contributing
4848
Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
49-
50-
## People
51-
[Josh James](https://github.com/joshjames289)
52-
[Elise Nie](https://github.com/elisanie)
53-
[Gahl Peled](https://github.com/GP3-RS)
54-
[Troy Prejusa](https://github.com/tprejusa)
55-
[Tim Atapagra](https://github.com/timpagra),
56-
[Mohtasim Chowdhury](https://github.com/mohtasim317),
57-
[Ousman Diallo](https://github.com/Dialloousman),
58-
[Michelle Herrera](https://github.com/mesherrera),
59-
[Duane McFarlane](https://github.com/Duane11003),
60-
[Ben Mizel](https://github.com/ben-mizel),
61-
[Jenae Pennie](https://github.com/jenaepen),
62-
[Chris Romano](https://github.com/robicano22),
63-
[Natalie Umanzor](https://github.com/nmczormick)
64-
[John Donato](https://github.com/jdonuto)
65-
[Iris Wong](https://github.com/wiris316)
66-
[Jon Cruz](https://github.com/Jrcrz)
67-
[Elena Atencio](https://github.com/elenaatencio)
68-
6949
## License
7050
[MIT](LICENSE)

examples/gRPC/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Chronos hopes to inspire an active community of both users and developers. For q
5858

5959
## License
6060

61-
[MIT](LICENSE)
61+
[MIT](LICENSE)
6262

6363
[npm-image]: https://img.shields.io/npm/v/chronos-microservice-debugger3.svg
6464
[npm-url]: https://www.npmjs.com/package/chronos-microservice-debugger3

0 commit comments

Comments
 (0)