Merge pull request #18 from oslabs-beta/justin/screen_recording

Justin/screen recording

Author: beezoo10

examples/microservices/README.md

@@ -4,32 +4,36 @@ Microservices architecture for testing [Chronos](https://github.com/open-source-
 
 ## Purpose and Design
 This sample microservices architecture allows developers to explore the functionality of Chronos. It consists of four microservices, which are contained within the directories:
-- Reverse Proxy
-- Books
-- Customers
-- Orders
+- books
+- customers
+- orders
+- reverse_proxy
 
 Each microservice has its own server, which receives requests from both the client and from other microservices. Books, Customers, and Orders also have their own databases, which they can query to respond to those requests.
 
-## Steps to Run Example
-1. Create a single .env file in the *examples/microservices* folder with the following key/value pairs:
+## To Set Up Database for Storing/Retrieving Metrics
+Create a single .env file in the *examples/microservices* folder with the following key/value pairs:
 - `CHRONOS_DB`: `MongoDB` or `PostgreSQL`
-- `CHRONOS_URI`: The URI to the desired MongoDB or PostgreSQL database to save health metrics via **Chronos**
-- `BOOK_URI`: A **MongoDB** URI for the bookserver microservice to use
-- `CUSTOMER_URI`: A **MongoDB** URI for the customerserver microservice to use
-- `ORDER_URI`:  A **MongoDB** URI for the orderserver microservice to use
+- `CHRONOS_URI`: The URI to the desired MongoDB or PostgreSQL database to save health metrics via **Chronos NPM Package**
+- `BOOK_URI`: A **MongoDB** URI for the `books` microservice to use
+- `CUSTOMER_URI`: A **MongoDB** URI for the `customers` microservice to use
+- `ORDER_URI`:  A **MongoDB** URI for the `orders` microservice to use
 
+Note: The `CHRONOS_URI` and all microservice `_URI`'s can be the same URI if you use MongoDB. You may run out of space in your database if the services run for an extended period of time. You can temporarily solve this by creating separate databases, or manually deleting the collection from the database regularly using a UI such as MongoDB Compass. When running, the microservices will create new collections if none are found in the database.
 
-Peform the following steps in each of the *books*, *customers*, *orders*, and *reverse proxy* directories
+## Start the Microservices
+Peform the following steps in each of the *books*, *customers*, *orders*, and *reverse_proxy* directories
 1. `cd` into the folder
 2. Look at `package.json` to note where `@chronosmicro/tracker` is being imported from. Verify that it is coming from the desired location (whether the published remote from npm or from local directory).
 3. Run `npm install`
 4. Run `npm run start`
 
+**Mac Users:** Alternative to the above list of steps, `cd` into the `scripts` folder and run the `startMicroservices.sh` script
+
 #
-Then open a web browser to `localhost:3000` and verify that the simple webpage application is operational.
+Then open a web browser to `localhost:3000` and verify that the simple webpage application is operational. You can use the web app if you wish, but it is not necessary for retrieving and visualizing health metrics in Chronos.
 
-Your microservice health metrics can now be viewed at the given `CHRONOS_URI` or, preferrably, in the Electron.js desktop application.
+Your microservice health metrics can now be viewed in the given `CHRONOS_URI` database, or, preferrably, in the Electron.js desktop application.
 #
 
 ## Contributing

examples/microservices/books/BookModel.js

@@ -6,8 +6,11 @@ require('dotenv').config({
 const mongoose = require('mongoose');
 const { Schema } = mongoose;
 
-// UNCOMMENT THE LINE BELOW AND REPLACE WITH AN ACTUAL MONGODB URI FOR YOUR "CUSTOMERS" DATABASE
-require('./chronos-config'); // Bring in config file
+require('./chronos-config');
+/**
+ * Your .env file's BOOK_URI will be referenced here to connect the 
+ * `books` microservice metrics to your database.
+ */
 const myURI = process.env.BOOK_URI;
 
 mongoose.connect(myURI, { useNewUrlParser: true, useUnifiedTopology: true })

examples/microservices/customers/CustomerModel.js

@@ -6,7 +6,11 @@ require('dotenv').config({
 const mongoose = require('mongoose');
 const { Schema } = mongoose;
 
-require('./chronos-config'); // Bring in config file
+require('./chronos-config');
+/**
+ * Your .env file's CUSTOMER_URI will be referenced here to connect the 
+ * `customers` microservice metrics to your database.
+ */
 const myURI = process.env.CUSTOMER_URI;
 
 mongoose.connect(myURI, { useNewUrlParser: true, useUnifiedTopology: true })

examples/microservices/orders/OrderModel.js

@@ -6,10 +6,12 @@ require('dotenv').config({
 const mongoose = require('mongoose');
 const { Schema } = mongoose;
 
-// UNCOMMENT THE LINE BELOW AND REPLACE WITH AN ACTUAL MONGODB URI FOR YOUR "ORDERS" DATABASE
-require('./chronos-config'); // Bring in config file
+require('./chronos-config');
+/**
+ * Your .env file's ORDER_URI will be referenced here to connect the 
+ * `orders` microservice metrics to your database.
+ */
 const myURI = process.env.ORDER_URI;
-// const myURI = 'mongodb+srv://johndoe:[email protected]/';
 
 mongoose.connect(myURI, { useNewUrlParser: true, useUnifiedTopology: true })
   .then(() => console.log('Connected!!!********* Order Database is live!!!'))

examples/microservices/reverse proxy/chronos-config.js renamed to examples/microservices/reverse_proxy/chronos-config.js

@@ -0,0 +1,24 @@
+#!/bin/bash
+cd ../books
+dir=$(pwd)
+com="cd $dir && npm install && npm run start"
+echo Starting books microservice. A Mac Terminal App should be open and contains more information.
+osascript -e "tell app \"Terminal\" to do script \"$com\""
+
+cd ../customers
+dir=`pwd`
+com="cd $dir && npm install && npm run start"
+echo Starting customers microservice. A Mac Terminal App should be open and contains more information.
+osascript -e "tell app \"Terminal\" to do script \"$com\""
+
+cd ../orders
+dir=$(pwd)
+com="cd $dir && npm install && npm run start"
+echo Starting orders microservice. A Mac Terminal App should be open and contains more information.
+osascript -e "tell app \"Terminal\" to do script \"$com\""
+
+cd ../reverse_proxy
+dir=$(pwd)
+com="cd $dir && npm install && npm run start"
+echo Starting reverse_proxy microservice. A Mac Terminal App should be open and contains more information.
+osascript -e "tell app \"Terminal\" to do script \"$com\""