refactor code and readme

Author: HaoyL666

README.md

@@ -27,14 +27,14 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
 
 ### With Chronos 12.0:
 
-- Improved metrics visualization by embedding more interactive and flexible Grafana charts for Docker and Kubernetes examples.
-- Increased test coverage up to 80% by crafting comprehensive unit, integration, and end-to-end tests using Jest and Selenium.
-- Fixed Docker example for not being able to display metrics correctly.
-- Designed an interactive 3D visualization showcasing the infrastructure of Kubernetes clusters (Namespace, Service, Pod), providing enhanced insights into the intricate resource distribution and configuration within the cluster for developers and users.
-- Engineered workflow efficiencies by orchestrating CI/CD pipelines, automating testing, and establishing deployment procedures, resulting in accelerated development cycles and higher reliability.
-- Increased Typescript coverage for better code quality and application robustness.
-- Updated README instructions within the provided Docker and Kubernetes examples for how to configure Prometheus and Grafana in a smooth and easy way. 
-- Revised README instructions for the `@chronosmicro/tracker` NPM package for how to use this package to monitor their own applications.
+- Enhanced metrics visualization by integrating more interactive and adaptable Grafana charts, particularly for Docker and Kubernetes use cases.
+- Achieved an 80% boost in test coverage by formulating comprehensive unit, integration, and end-to-end tests employing Jest and Selenium.
+- Rectified issues with the Docker example, ensuring accurate metric display.
+- Devised an immersive 3D visualization that effectively illustrates the Kubernetes cluster infrastructure, encompassing Namespace, Service, and Pod entities. This dynamic visualization provides developers and users with heightened insights into intricate resource allocation and configuration within the cluster.
+- Streamlined operational effectiveness by coordinating CI/CD pipelines, automating testing workflows, and establishing deployment protocols, ultimately leading to accelerated development cycles and heightened dependability.
+- Expanded Typescript coverage to enhance code quality and bolster application resilience.
+- Updated the Docker and Kubernetes example READMEs with detailed instructions on configuring Prometheus and Grafana seamlessly.
+- Enhanced clarity of instructions in the `@chronosmicro/tracker` NPM package's README, offering comprehensive guidance on utilizing the package to monitor individual applications effectively.
 
 
 **Previously implemented updates:**

chronos_npm_package/server/server.js

@@ -76,4 +76,4 @@ app.use((err, req, res, next) => {
     return res.status(errorObj.status).json(errorObj.message);
 });
 
-app.listen(port, () => console.log(`Example app listening on port ${port}! chronos_npm_package Server Loaded`))
+app.listen(port, () => console.log(`🤖 Example app listening on port ${port}! chronos_npm_package Server Loaded 🎉`))

contributors.md

@@ -1,5 +1,8 @@
 ## People
-
+[Tyler Coryell](https://github.com/Tcoryell),
+[Edwin Leong](https://github.com/edwinlny),
+[Eisha Kaushal](https://github.com/eishakaushal),
+[Haoyu Liu](https://github.com/HaoyL666),
 [Snow X. Bai](https://github.com/xueapp),
 [Taylor Zhang](https://github.com/taylrzhang),
 [Tim Lee](https://github.com/timlee12),
@@ -33,8 +36,4 @@
 [Jeffrey Na](https://github.com/jeffreyNa),
 [Brisa Zhu](https://github.com/beezoo10),
 [Kelsi Webb](https://github.com/kelsicw),
-[Justin Poirier](https://github.com/jcpoirier20),
-[Tyler Coryell](https://github.com/Tcoryell),
-[Edwin Leong](https://github.com/edwinlny),
-[Eisha Kaushal](https://github.com/eishakaushal),
-[Haoyu Liu](https://github.com/HaoyL666),
+[Justin Poirier](https://github.com/jcpoirier20)

examples/docker/README.md

@@ -27,7 +27,7 @@ For additional details on how Chronos works this example, please review the Dock
 
 ## Grafana API KEY
 
-1. Run docker compose command below (LN 64) to start your Grafana container before you can access your service account token.
+1. Run docker compose command below (LN 61) to start your Grafana container before you can access your service account token.
 
 2. In your browser, go to `localhost:32000`, which will be the login page of grafana. Use `admin` as both username and password to login. You can change the password after login.
 
@@ -51,15 +51,12 @@ CHRONOS_GRAFANA_API_KEY = Bearer [the access token you created in above section
 
 2.  Verify that `@chronosmicro/tracker` is a dependency in each of the _books_, _customers_, _frontend_, and _orders_ folders (see the `package.json` in each folder).
 
-    - If the @chronosmicro/tracker dependency is listed as a **remote** npm package (i.e. `"@chronosmicro/tracker": "^12.0.1"`) and you've ran `npm install`, no further work is needed continue to step 3.  **However, confirm that the "@chronosmicro/tracker" you've installed from npm has the correct database names you will query later because the database automation will build from the npm installed version
+    - If the @chronosmicro/tracker dependency is listed as a **remote** npm package (i.e. `"@chronosmicro/tracker": "^12.0.1"`) and you've ran `npm install`, no further work is needed continue to step 3.  **However, confirm that the "@chronosmicro/tracker" you've installed from npm has the correct information which you will query later because the database automation will build from the npm installed version NOT the root directory level "chronos_npm_package"**
 
-    - If you have the dependency as
-      `"@chronosmicro/tracker": "file:./chronos_npm_package"`, which is a **local** file, make sure to change the version from `"file:./chronos_npm_package"` to `"^12.0.1"` and run npm install.
+    - If you have the dependency as `"@chronosmicro/tracker": "file:./chronos_npm_package"`, which is a **local** file, make sure to change the version from `"file:./chronos_npm_package"` to `"^12.0.1"` and run npm install.  **Unless you are wanting to test local copies of the "Chronos_npm_package" file**
 
 3.  With the terminal navigated to the the _examples/docker_ folder, run the command:
 
-> > > No working, installing VSC docker ext<<< --must have docker installed for this command to run
-
 ```
 docker-compose -f docker-compose.yml up
 ```
@@ -99,11 +96,17 @@ Use `docker compose down` to remove.
   <img alt="docker containers removed" src="../../assets/examples_docker_removed.png">
 </p>
 
-## Contributing
-
-Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
+## Insight for how to migrate this example to your own app
+To configure Prometheus and Grafana, you can simply copy the below yaml files to your own app.
+```
 
-Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
+prometheus.yml
+datasource.yml
+dashboard.yml
+10619_rev1.json 
+**(Please note dashboard.yml and 10619_rev1.json is just one of many dashboards available on https://grafana.com/grafana/dashboards/)**
+```
+Then configure Prometheus and Grafana with your own application's deployments using images.
 
 ## License