Merge pull request #6 from oslabs-beta/npm-package

Add files via upload

Author: nmczormick

Communication.js

@@ -17,6 +17,6 @@ mongoose.model('Communication', {
     type: String,
   },
   timeSent: {
-    type: Date,
+    type: Date
   }
 })

MicroserviceHealth.js

@@ -3,54 +3,44 @@ const mongoose = require("mongoose");
 mongoose.model("MicroserviceHealth", {
   currentMicroservice: {
     type: String,
-    required: true
   },
   cpuCurrentSpeed: {
     type: Number,
-    required: true
   },
   cpuTemperature: {
     type: Number,
-    required: true
+  },
+  cpuCurrentLoadMemoryPercentage: {
+    type: Number,
   },
   totalMemory: {
     type: Number,
-    required: true
   },
   freeMemory: {
     type: Number,
-    required: true
   },
   usedMemory: {
     type: Number,
-    required: true
   },
   activeMemory: {
     type: Number,
-    required: true
   },
   totalNumProcesses: {
     type: Number,
-    required: true
   },
   numRunningProcesses: {
     type: Number,
-    required: true
   },
   numBlockedProcesses: {
     type: Number,
-    required: true
   },
   numSleepingProcesses: {
     type: Number,
-    required: true
   },
   latency: {
     type: Number,
-    required: true
   },
   timestamp: {
     type: Date,
-    required: true
   }
 });

README.md

@@ -1 +1,34 @@
-# Chronos
+##Chronos Microservice Debugger
+Chronos Microservice Debugger consists of an npm package with an optional Electron front end to visualize and monitor your microservices.
+
+##Install
+```javascript
+npm install chronos-microservice-debugger
+```
+
+##Usage
+There are two main aspects to Chronos-Microservice-Debugger
+*Communication Monitor: Listens in on all microservice-microservice and microservice-client communication and monitors the response statuses and messages to ensure communications are making it to the correct destination successfully.
+*Health Monitor: The health monitor checks the status of your microservice every second and sends this health information to an optional electron frontend where it is visualized for easier use.
+
+
+```javascript
+app.use('/', chronos-microservice-debgugger.microCom('microserviceName', 'databaseType', 'databaseURL'))
+chronos-microservice-debugger.microHealth('microserviceName', databaseType, databaseURL))
+```
+Chronos uses a user-owned and provided database to ensure that your private data stays private. We currently support MongoDB and SQL/PostgresQL databases.
+
+##Things in the Works
+*gRPC support
+*Ability to determine how often your microservice health is monitored (currently every second)
+*'Time Travel' to see how your microservices have changed over time
+*Docker health information for containerized microservices
+*Implement additional unit testing
+
+##Links
+*Chronos Website: http://chronos.ninja
+*Gitub Page: http://https://github.com/oslabs-beta/Chronos
+
+##Contact Us
+For questions, requests, or more information, please contact us at teammicronos@gmail.com
+

chronos.js

@@ -0,0 +1,71 @@
+const mongoMiddleware = require('./mwMongo.js')
+const sqlMiddleware = require('./mwSQL.js')
+
+const chronos = {}
+  chronos.microHealth = (microserviceName, databaseType, userOwnedDB) => {
+    microserviceName.toLowerCase();
+    databaseType.toLowerCase();
+
+    if (!microserviceName || !databaseType || !userOwnedDB) {
+      throw new Error(
+        "Please verify that you have provided all three required parameters"
+      );
+    }
+
+    if (
+      typeof microserviceName !== "string" ||
+      typeof databaseType !== "string" ||
+      typeof userOwnedDB !== "string"
+    ) {
+      throw new Error(
+        "Please verify that the parameters you entered are all strings"
+      );
+    }
+
+    if (databaseType === "mongo" || databaseType === "mongodb") {
+      return mongoMiddleware.microHealth(userOwnedDB, microserviceName);
+    } else if (databaseType === "sql" || databaseType === "postgresql") {
+      return sqlMiddleware.microHealth(userOwnedDB, microserviceName);
+    } else {
+      throw new Error (
+        'Chronos currently only supports Mongo and SQL/PostgresQL databases. Please enter "mongo" or "sql'
+      );
+    }
+  },
+    chronos.microCom = (microserviceName, databaseType, userOwnedDB, req, res, next) => {
+      microserviceName.toLowerCase();
+      databaseType.toLowerCase();
+
+      if (!microserviceName || !databaseType || !userOwnedDB) {
+        throw new Error(
+          "Please verify that you have provided all three required parameters"
+        );
+      }
+
+      if (
+        typeof microserviceName !== "string" ||
+        typeof databaseType !== "string" ||
+        typeof userOwnedDB !== "string"
+      ) {
+        throw new Error(
+          "Please verify that the parameters you entered are all strings"
+        );
+      }
+
+      if (databaseType === "mongo" || databaseType === "mongodb") {
+        return mongoMiddleware.microCom(userOwnedDB, microserviceName);
+      } else if (databaseType === "sql" || databaseType === "postgresql") {
+        return sqlMiddleware.microCom(userOwnedDB, microserviceName);
+      } else {
+        throw new Error(
+          'Chronos currently only supports Mongo and SQL/PostgresQL databases. Please enter "mongo" or "sql'
+        );
+      }
+};
+
+
+module.exports = chronos;
+
+
+
+