Skip to content

Commit 609e856

Browse files
ZhongyanLiangZhongyanLiang
committed
main readme Monday
1 parent 66f82d5 commit 609e856

4 files changed

Lines changed: 278 additions & 177 deletions

File tree

‎README.md‎

Lines changed: 166 additions & 177 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,172 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
2020

2121
## What's New?
2222

23-
- new microservices app
24-
- updated version history with past iteration changes
25-
- Added codebase overview visulization
23+
### Chronos 13.0
24+
25+
<ul>
26+
<div>
27+
28+
Contributors:
29+
[Elsa Holmgren](https://github.com/ekh88),
30+
[Mckenzie Morris](https://github.com/mckenzie-morris),
31+
[Kelly Chandler](https://github.com/kchandler44),
32+
[Sean Simson](https://github.com/seantokuzo),
33+
[Zhongyan Liang](https://github.com/ZhongyanLiang)
34+
35+
</div>
36+
Updates:
37+
<ul>
38+
<li>TBD</li>
39+
</ul>
40+
41+
<a href=''>Version 13.0 Medium Article</a>
42+
43+
</ul>
44+
45+
### **Iteration Log**
46+
47+
<details><summary>Chronos 12.0</summary>
48+
<ul>
49+
<div>
50+
51+
Contributors:
52+
[Haoyu Liu](https://github.com/HaoyL666),
53+
[Edwin Leong](https://github.com/edwinlny),
54+
[Eisha Kaushal](https://github.com/eishakaushal),
55+
[Tyler Coryell](https://github.com/Tcoryell)
56+
57+
</div>
58+
Updates:
59+
<ul>
60+
<li>Grafana charting and visualizer</li>
61+
<li>Increase in Prometheus and cAdvisor integration span</li>
62+
<li>Increased testing coverage to include unit testing and Selenium-based, end-to-end testing</li>
63+
<li>Integrated CI/CD which automates GitHub Action to run testing suites in order and create a publishing action to NPM Registry</li>
64+
</ul>
65+
66+
<a href='https://medium.com/@coryelltyler/grafana-charting-improved-testing-and-ci-cd-with-chronos-12-0-6a1156cae456'>Version 12.0 Medium Article</a>
67+
68+
</ul>
69+
</details>
70+
71+
<details><summary>Chronos 11.0</summary>
72+
<ul>
73+
<div>
74+
75+
Contributors:
76+
[Brisa Zhu](https://github.com/beezoo10),
77+
[Lucie Seidler](https://github.com/LucieSeidler),
78+
[Justin Poirier](https://github.com/jcpoirier20),
79+
[Jeffrey Na](https://github.com/jeffreyNa),
80+
[Kelsi Webb](https://github.com/kelsicw)
81+
82+
</div>
83+
Updates:
84+
<ul>
85+
<li>Interactive charting which can display and compare metrics in rendered graphs</li>
86+
<li>Increased user database security with user authorization to connect multiple</li>
87+
<li>services and databases and have instances persist without having to reconnect</li>
88+
<li>Improved documentation by adding ReadMes about how to initialize the app, how to use the given examples, and how to update config files</li>
89+
<li>Updated NPM Package to ‘increase reliability and ease of navigation</li>
90+
<li>Fixed bugs and improved test coverage</li>
91+
</ul>
92+
93+
<a href='https://medium.com/@zhu.brisa/interactive-charting-increases-user-engagement-with-chronos-11-0-61b6b8b7399b'>Version 11.0 Medium Article</a>
94+
95+
</ul>
96+
</details>
97+
98+
<details><summary>Chronos 10.0</summary>
99+
<ul>
100+
<div>
101+
102+
Contributors:
103+
[Brian Lim](https://github.com/brianlim89),
104+
[Claire Tischuk](https://github.com/BoopdiBop),
105+
[Lennon Stewart](https://github.com/noahoo7),
106+
[Victor Ye](https://github.com/vctorye),
107+
108+
</div>
109+
Updates:
110+
<ul>
111+
<li>Full user authentication integrating with a functional database which enables users to securely save their profile and data</li>
112+
<li>Updated microservices, gRPC, and Dockerized app examples</li>
113+
</ul>
114+
115+
<a href='https://medium.com/@br.lim89/taking-chronos-to-the-next-level-with-eks-monitoring-c9102a450b3c'>Version 10.0 Medium Article</a>
116+
117+
</ul>
118+
</details>
119+
120+
<details><summary>Chronos 9.0</summary>
121+
<ul>
122+
<div>
123+
124+
Contributors:
125+
[Brian Lim](https://github.com/brianlim89),
126+
[Claire Tischuk](https://github.com/BoopdiBop),
127+
[Lennon Stewart](https://github.com/eishakaushal),
128+
[Victor Ye](https://github.com/vctorye)
129+
130+
</div>
131+
Updates:
132+
<ul>
133+
<li>Added AWS - Users of Chronos are now able to monitor and visualize containers running in Amazon’s Elastic Kubernetes Service (EKS)~Medium</li>
134+
<li>Ability to monitor cost metrics through Opencast integration</li>
135+
</ul>
136+
137+
<a href='https://medium.com/@br.lim89/taking-chronos-to-the-next-level-with-eks-monitoring-c9102a450b3c'>Version 9.0 Medium Article</a>
138+
139+
</ul>
140+
</details>
141+
142+
<details><summary>Chronos 8.0</summary>
143+
<ul>
144+
<div>
145+
146+
Contributors:
147+
[Vince Ho](https://github.com/brianlim89),
148+
[Matt Giant](https://github.com/BoopdiBop),
149+
[Derek Lam](https://github.com/eishakaushal),
150+
[Kit Loong Yee](https://github.com/vctorye)
151+
152+
</div>
153+
Updates:
154+
<ul>
155+
<li>Rewrite microservice in a language with a higher level of support such as GO or Java</li>
156+
<li>Use packages such as OpenTelementry to record data and export said data to an additional application like Zipkin or Prometheus</li>
157+
<li>Purchase a license to one of the few monitoring tools that support gRPC and Node.js.</li>
158+
</ul>
159+
160+
<a href='https://derekquoc.medium.com/monitoring-node-js-grpc-microservices-with-chronos-deac9b227122'>Version 8.0 Medium Article</a>
161+
162+
</ul>
163+
</details>
164+
165+
<details><summary>Chronos 7.0</summary>
166+
<ul>
167+
<div>
168+
169+
Contributors:
170+
[Yang Song](https://github.com/curiousyang),
171+
[Giovanni Floreslovo](https://github.com/gfloresl),
172+
[James Edwards](https://github.com/Fredwards),
173+
[Alex Kolb](https://github.com/alexkolb1)
174+
175+
</div>
176+
Updates:
177+
<ul>
178+
<li>Ability to filter out specific metrics using a query tool</li>
179+
<li>Increased the number of metrics available from 12 to 100+</li>
180+
<li>Options to filter metrics by category</li>
181+
<li>Apache Kafka monitoring capabilities</li>
182+
<li>Bug fixes and UI improvements</li>
183+
</ul>
184+
185+
<a href='https://medium.com/@hannahsantoyo/introducing-chronos-7-a-complete-health-monitoring-tool-for-microservices-apache-kafka-clusters-f1ebad038074'>Version 7.0 Medium Article</a>
186+
187+
</ul>
188+
</details>
26189

27190
### With Chronos 13.0
28191

@@ -32,13 +195,6 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
32195

33196
<br>
34197

35-
**Previously implemented updates:**
36-
37-
- Enhanced metrics visualization by integrating more interactive and adaptable Grafana charts for Docker and Kubernetes use cases.
38-
- Achieved an 80% boost in test coverage by formulating comprehensive unit, integration, and end-to-end tests employing Jest and Selenium.
39-
- Streamlined operational effectiveness by coordinating CI/CD pipelines, automating testing workflows, and establishing deployment protocols, ultimately leading to accelerated development cycles and heightened dependability.
40-
- Updated the Docker and Kubernetes example READMEs with detailed instructions on configuring Prometheus and Grafana seamlessly.
41-
42198
## Overview of the CodeBase
43199

44200
- Instead of the typical folders & files view, a visual representation of the code is created. Below, it's showing the same repository, but instead of a directory structure, each file and folder as a circle: the circle’s color is the type of file, and the circle’s size represents the size of the file. See live demo <a href='https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=oslabs-beta%2FChronos'>here</a>.
@@ -207,173 +363,6 @@ Development of Chronos is open source on GitHub through the tech accelerator OS
207363

208364
Read our [contributing README](CONTRIBUTING.md) to learn how you can take part in improving Chronos.
209365

210-
### **Iteration Log**
211-
212-
<details><summary>Chronos 13.0</summary>
213-
<ul>
214-
<div>
215-
216-
Contributors:
217-
[Elsa Holmgren](https://github.com/ekh88),
218-
[Mckenzie Morris](https://github.com/mckenzie-morris),
219-
[Kelly Chandler](https://github.com/kchandler44),
220-
[Sean Simson](https://github.com/seantokuzo),
221-
[Zhongyan Liang](https://github.com/ZhongyanLiang)
222-
223-
</div>
224-
Updates:
225-
<ul>
226-
<li>TBD</li>
227-
</ul>
228-
229-
<a href=''>Version 13.0 Medium Article</a>
230-
231-
</ul>
232-
</details>
233-
234-
<details><summary>Chronos 12.0</summary>
235-
<ul>
236-
<div>
237-
238-
Contributors:
239-
[Haoyu Liu](https://github.com/HaoyL666),
240-
[Edwin Leong](https://github.com/edwinlny),
241-
[Eisha Kaushal](https://github.com/eishakaushal),
242-
[Tyler Coryell](https://github.com/Tcoryell)
243-
244-
</div>
245-
Updates:
246-
<ul>
247-
<li>Grafana charting and visualizer</li>
248-
<li>Increase in Prometheus and cAdvisor integration span</li>
249-
<li>Increased testing coverage to include unit testing and Selenium-based, end-to-end testing</li>
250-
<li>Integrated CI/CD which automates GitHub Action to run testing suites in order and create a publishing action to NPM Registry</li>
251-
</ul>
252-
253-
<a href='https://medium.com/@coryelltyler/grafana-charting-improved-testing-and-ci-cd-with-chronos-12-0-6a1156cae456'>Version 12.0 Medium Article</a>
254-
255-
</ul>
256-
</details>
257-
258-
<details><summary>Chronos 11.0</summary>
259-
<ul>
260-
<div>
261-
262-
Contributors:
263-
[Brisa Zhu](https://github.com/beezoo10),
264-
[Lucie Seidler](https://github.com/LucieSeidler),
265-
[Justin Poirier](https://github.com/jcpoirier20),
266-
[Jeffrey Na](https://github.com/jeffreyNa),
267-
[Kelsi Webb](https://github.com/kelsicw)
268-
269-
</div>
270-
Updates:
271-
<ul>
272-
<li>Interactive charting which can display and compare metrics in rendered graphs</li>
273-
<li>Increased user database security with user authorization to connect multiple</li>
274-
<li>services and databases and have instances persist without having to reconnect</li>
275-
<li>Improved documentation by adding ReadMes about how to initialize the app, how to use the given examples, and how to update config files</li>
276-
<li>Updated NPM Package to ‘increase reliability and ease of navigation</li>
277-
<li>Fixed bugs and improved test coverage</li>
278-
</ul>
279-
280-
<a href='https://medium.com/@zhu.brisa/interactive-charting-increases-user-engagement-with-chronos-11-0-61b6b8b7399b'>Version 11.0 Medium Article</a>
281-
282-
</ul>
283-
</details>
284-
285-
<details><summary>Chronos 10.0</summary>
286-
<ul>
287-
<div>
288-
289-
Contributors:
290-
[Brian Lim](https://github.com/brianlim89),
291-
[Claire Tischuk](https://github.com/BoopdiBop),
292-
[Lennon Stewart](https://github.com/noahoo7),
293-
[Victor Ye](https://github.com/vctorye),
294-
295-
</div>
296-
Updates:
297-
<ul>
298-
<li>Full user authentication integrating with a functional database which enables users to securely save their profile and data</li>
299-
<li>Updated microservices, gRPC, and Dockerized app examples</li>
300-
</ul>
301-
302-
<a href='https://medium.com/@br.lim89/taking-chronos-to-the-next-level-with-eks-monitoring-c9102a450b3c'>Version 10.0 Medium Article</a>
303-
304-
</ul>
305-
</details>
306-
307-
<details><summary>Chronos 9.0</summary>
308-
<ul>
309-
<div>
310-
311-
Contributors:
312-
[Brian Lim](https://github.com/brianlim89),
313-
[Claire Tischuk](https://github.com/BoopdiBop),
314-
[Lennon Stewart](https://github.com/eishakaushal),
315-
[Victor Ye](https://github.com/vctorye)
316-
317-
</div>
318-
Updates:
319-
<ul>
320-
<li>Added AWS - Users of Chronos are now able to monitor and visualize containers running in Amazon’s Elastic Kubernetes Service (EKS)~Medium</li>
321-
<li>Ability to monitor cost metrics through Opencast integration</li>
322-
</ul>
323-
324-
<a href='https://medium.com/@br.lim89/taking-chronos-to-the-next-level-with-eks-monitoring-c9102a450b3c'>Version 9.0 Medium Article</a>
325-
326-
</ul>
327-
</details>
328-
329-
<details><summary>Chronos 8.0</summary>
330-
<ul>
331-
<div>
332-
333-
Contributors:
334-
[Vince Ho](https://github.com/brianlim89),
335-
[Matt Giant](https://github.com/BoopdiBop),
336-
[Derek Lam](https://github.com/eishakaushal),
337-
[Kit Loong Yee](https://github.com/vctorye)
338-
339-
</div>
340-
Updates:
341-
<ul>
342-
<li>Rewrite microservice in a language with a higher level of support such as GO or Java</li>
343-
<li>Use packages such as OpenTelementry to record data and export said data to an additional application like Zipkin or Prometheus</li>
344-
<li>Purchase a license to one of the few monitoring tools that support gRPC and Node.js.</li>
345-
</ul>
346-
347-
<a href='https://derekquoc.medium.com/monitoring-node-js-grpc-microservices-with-chronos-deac9b227122'>Version 8.0 Medium Article</a>
348-
349-
</ul>
350-
</details>
351-
352-
<details><summary>Chronos 7.0</summary>
353-
<ul>
354-
<div>
355-
356-
Contributors:
357-
[Yang Song](https://github.com/curiousyang),
358-
[Giovanni Floreslovo](https://github.com/gfloresl),
359-
[James Edwards](https://github.com/Fredwards),
360-
[Alex Kolb](https://github.com/alexkolb1)
361-
362-
</div>
363-
Updates:
364-
<ul>
365-
<li>Ability to filter out specific metrics using a query tool</li>
366-
<li>Increased the number of metrics available from 12 to 100+</li>
367-
<li>Options to filter metrics by category</li>
368-
<li>Apache Kafka monitoring capabilities</li>
369-
<li>Bug fixes and UI improvements</li>
370-
</ul>
371-
372-
<a href='https://medium.com/@hannahsantoyo/introducing-chronos-7-a-complete-health-monitoring-tool-for-microservices-apache-kafka-clusters-f1ebad038074'>Version 7.0 Medium Article</a>
373-
374-
</ul>
375-
</details>
376-
377366
#### Past [Contributors](contributors.md)
378367

379368
#

0 commit comments

Comments
 (0)