middle of writing chronos npm package readme

Author: Fredwards

.gitignore

@@ -6,7 +6,7 @@ build
 release-builds
 coverage
 __tests__/**/__snapshots__
-# .env
+.env
 users.json
 test_users.json
 

__tests__/test_settings.json

@@ -1 +1 @@
-{"setupRequired":false,"services":[["myPostgres","SQL","postgres://zwezmnqm:[email protected]:5432/zwezmnqm","Online bookstore with that keeps track of orders and customers","Jun 28, 2020 4:58 PM"],["ToddDB","MongoDB","mongodb+srv://tdwolf6:[email protected]/Chronos?retryWrites=true&w=majority","Web app deployed on AWS","Jul 3, 2020 7:12AM"],["orders","MongoDB","mongodb+srv://yangsong:[email protected]/orders?retryWrites=true&w=majority","orders","May 31, 2022 5:16 PM"]],"mode":"light mode","splash":true,"landingPage":"dashBoard"}
+{"setupRequired":false,"services":[["myPostgres","SQL","postgres://zwezmnqm:[email protected]:5432/zwezmnqm","Online bookstore with that keeps track of orders and customers","Jun 28, 2020 4:58 PM"],["ToddDB","MongoDB","mongodb+srv://tdwolf6:[email protected]/Chronos?retryWrites=true&w=majority","Web app deployed on AWS","Jul 3, 2020 7:12AM"],["orders","MongoDB","mongodb+srv://yangsong:[email protected]/orders?retryWrites=true&w=majority","orders","May 31, 2022 5:16 PM"],["JamesMongo","MongoDB","mongodb+srv://james:[email protected]/test?retryWrites=true&w=majority","","Jun 15, 2022 10:34 AM"],["JamesPostgres","SQL","postgres://dxdebork:[email protected]/dxdebork","","Jun 15, 2022 11:11 AM"]],"mode":"light mode","splash":true,"landingPage":"dashBoard"}

chronos_npm_package/README.md

@@ -0,0 +1,93 @@
+ # Chronos 7
+
+Chronos is a comprehensive developer tool that monitors the health and web traffic of servers, microservices, and containers. Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
+
+## <div height=22 > What's New? </div>
+- New Features
+  - The ability to monitor an Apache Kafka cluster via the JMX Prometheus Exporter
+  - Added 19 new system-level metrics for monitoring!
+- Overhauled Features
+  - Users can use the new query tool to select the specific metrics that they would 
+    like to monitor
+## Features     
+- Distributed tracing enabled across microservices applications
+- Compatible with <img src="./app/assets/graphql-logo-color.png" alt="GraphQL" title="GraphQL" align="center" height="20" /></a>
+- Supports <a href="#"><img src="./app/assets/postgres-logo-color.png" alt="PostgreSQL" title="PostgreSQL" align="center" height="20" /></a> and <img src="./app/assets/mongo-logo-color.png" alt="MongoDB" title="MongoDB" align="center" height="20" /></a> databases
+- Displays real-time temperature, speed, latency, and memory statistics
+- Display and compare multiple microservice metrics at once
+- Monitor an Apache Kafka cluster via the JMX Prometheus Exporter
+#
+## Installation
+
+To use Chronos in your existing application, download and install the following in the **root directory** of _each of your microservice applications_:
+```
+npm install chronos-tracker-7
+```
+
+### Pre-Installation
+Make sure you're running version 14.16.1 of, which is the most recent LTS (long-term support) version. 
+
+If you need to roll back from <a href="#"><img src="./app/assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" /></a> 16.1.0, make sure to run 
+```npm rebuild```
+in the root directory.
+
+
+<br>
+
+### Configuring Chronos Tracker
+
+Similarly, in the **root directory** of _each of your microservice applications_, create a `chronos-config.js` file with properties listed below:
+
+```js
+// A sample `chronos-config.js` file
+
+const chronos = require('chronos-tracker-7');
+
+chronos.use({
+  microservice: 'payments',
+  interval: 5000,
+  dockerized: true,
+  database: {
+    connection: 'REST',
+    type: 'MongoDB',
+    URI: process.env.URI,
+  },
+  notifications: [],
+});
+```
+
+The `microservice` property takes in a string. This should be the name of your server or microservice. For **Docker** containers, the name of the microservice should be the same as the name of the corresponding Docker container.
+
+The `interval` property is optional and takes in an integer. This controls the Chronos monitoring frequency. If this is omitted, Chronos will default to recording server health every 60000 ms or 60 seconds.
+
+The `dockerized` property is optional and should be specified as `true` if the server is running inside of a Docker container. Otherwise, this should be `false`. If omitted, Chronos will assume this server is not running in a container.
+
+The `database` property is required and takes in the following:
+- `connection` should be a string and only supports 'REST' and 'gRPC'
+- `type` should be a string and only supports 'MongoDB' and 'PostgreSQL'.
+- `URI` should be a connection string to the database where you intend Chronos to write and record data regarding health, HTTP route tracing, and container infomation.
+We reccommend using dotenv  
+
+Wherever you create an instance of your server (see example below),
+
+```js
+// Example for REST
+const express = require('express');
+const app = express();
+
+```
+
+you will also need to require in `chronos-tracker` and initialize Chronos, as well as the `./chronos-config` file. You will then need to invoke `chronos.propagate()` to initiate the route tracing, in addition to implementing `chronos.track()` for all endpoints.
+
+```js
+const chronos = require('chronos-tracker');
+require('./chronos-config'); // Bring in config file
+
+// ...
+
+app.use('/', chronos.track());
+```
+
+You should be good to go! The last step, **Docker Configuration**, is **only applicable** if you need to configure <a href="#"><img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /></a> for your application. 
+
+<br>

chronos_npm_package/chronos-config.js

@@ -0,0 +1,19 @@
+// A sample `chronos-config.js` file
+
+const chronos = require('./chronos.js');
+
+chronos.use({
+  microservice: 'PostGresTest',
+  interval: 1000,
+  dockerized: false,
+  jmxuri: 'http://localhost:12345/metrics',
+  database: {
+    connection: 'REST',
+    type: 'PostgreSQL',
+    URI:
+      'postgres://dxdebork:[email protected]/dxdebork',
+    // type: 'MongoDB',
+    // URI: 'mongodb+srv://james:[email protected]/test?retryWrites=true&w=majority',
+  },
+  notifications: [],
+});

chronos_npm_package/controllers/mongo.js

@@ -110,7 +110,7 @@ chronos.health = ({ microservice, interval }) => {
   setInterval(() => {
     collectHealthData()
       .then(healthMetrics => {
-        console.log('HEALTH METRICS: ', healthMetrics);
+        // console.log('HEALTH METRICS: ', healthMetrics);
         const HealthModel = HealthModelFunc(`${microservice}`);
         return HealthModel.insertMany(healthMetrics);
       })
@@ -219,7 +219,10 @@ KafkaModel.js, and inserts them into the db at the provided uri with insertMany(
 */
 chronos.kafka = function (userConfig) {
   // ensure that kafkametrics exists in the services table
-  const service = new ServicesModel({ service: 'kafkametrics', interval: userConfig.interval });
+  const service = new ServicesModel({
+    microservice: 'kafkametrics',
+    interval: userConfig.interval,
+  });
 
   service
     .save()

chronos_npm_package/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "chronos",
+  "name": "chronos7test",
   "version": "1.1.0",
   "description": "",
   "main": "chronos.js",

examples/microservices/books/.env

@@ -1,2 +1,2 @@
-BOOK_URI = mongodb+srv://alexkolb1:QKiNQxyxsQqBHLpi@cluster0.zmgge.mongodb.net/books?retryWrites=true&w=majority
-CHRONOS_URI = mongodb+srv://alexkolb1:QKiNQxyxsQqBHLpi@cluster0.zmgge.mongodb.net/chronos?retryWrites=true&w=majority
+BOOK_URI = mongodb+srv://james:james@cluster0.kb3y4.mongodb.net/Books?retryWrites=true&w=majority
+CHRONOS_URI = mongodb+srv://james:james@cluster0.kb3y4.mongodb.net/test?retryWrites=true&w=majority

examples/microservices/books/bookserver.js

@@ -1,9 +1,8 @@
-const cmd = require('chronos-microservice-debugger3');
-cmd.propagate();
 require('dotenv').config();
 
 // const chronos = require('chronos-tracker');
-const chronos = require('../../../chronos_npm_package/chronos');
+const myURI = process.env.BOOK_URI;
+const chronos = require('chronos7test');
 require('./chronos-config'); // Bring in config file
 
 chronos.propagate();
@@ -12,12 +11,15 @@ const PORT = 4545;
 const express = require('express');
 const path = require('path');
 const cors = require('cors');
+
 const app = express();
 const bodyParser = require('body-parser');
 const controller = require('./BookController.js');
 
+chronos.kafka();
+
 // UNCOMMENT THE LINE BELOW AND PASS IN YOUR CHOSEN ARGUMENTS
-app.use('/', cmd.microCom('books', 'mongo', process.env.BOOK_URI, 'yes'));
+// app.use('/', cmd.microCom('books', 'mongo', process.env.BOOK_URI, 'yes'));
 app.use('/', chronos.track());
 
 app.use(bodyParser.json());
@@ -55,8 +57,6 @@ function errorHandler(error, req, res, next) {
   res.status(errorObj.status).json(errorObj.message);
 }
 
-
-
 // Open and listen to server on specified port
 app.listen(PORT, () => {
   console.log(`Book server running on port ${PORT} ...`);

examples/microservices/books/chronos-config.js

@@ -1,15 +1,16 @@
 require('dotenv').config();
 // const chronos = require('chronos-tracker');
-const chronos = require('../../../chronos_npm_package/chronos');
+const chronos = require('chronos7test');
 
 chronos.use({
   microservice: 'books',
   interval: 2000,
+  jmxuri: 'http://localhost:12345/metrics',
   // dockerized: true,
   database: {
     connection: 'REST',
     type: 'MongoDB',
     URI: process.env.CHRONOS_URI,
   },
   notifications: [],
-});
+});