Update README

Add gRPC setup instructions
Modify config instructions
Update current features

Co-authored-by: Derek <[email protected]>

Author: hodesza

README.md

@@ -56,10 +56,9 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
   - Distributed tracing across network request
   - Currently chronos gRPC tracing for Mongodb and PostgresQL
 
-## Ver 5.0 Features 
+## Ver 6.0 Features 
 
 - Distributed tracing enabled across microservices applications
-- Supports <a href="#"><img src="./app/assets/http-logo-color.png" alt="HTTP" title="HTTP" align="center" height="20" /></a> protocol, with <img src="./app/assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="20" /></a> _coming soon_
 - Compatible with <img src="./app/assets/graphql-logo-color.png" alt="GraphQL" title="GraphQL" align="center" height="20" /></a>
 - Provides <a href="#"><img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /></a> container stats (e.g. ID, memory usage %, CPU usage %, running processes, etc.)
 - 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
@@ -101,7 +100,7 @@ To use Chronos in your existing application, download and install the following
 npm install chronos-tracker
 ```
 
-### Configure Chronos for REST
+### Configure Chronos for REST or gRPC
 
 Similarly, in the **root directory** of _each of your microservice applications_, create a `chronos-config.js` file with properties listed below:
 
@@ -147,9 +146,10 @@ The `notifications` property is optional. Jump to the section below, [Notificati
 Wherever you create an instance of your server (see example below),
 
 ```js
-// Example 
+// 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.
@@ -165,10 +165,110 @@ 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>
 
+
 ### Initialize Chronos for gRPC
 
+Wherever you create an instance of your server (see example below),
+
+
+```js
+  // Example of gRPC server
+  const server = new grpc.Server();
+
+  server.bindAsync("127.0.0.1:30044", grpc.   ServerCredentials.createInsecure(), () => {
+    server.start();
+    console.log("Server running at http://127.0.0.1:30044");
+});
+```
+you will also need to require Chronos-tracker, Chronos-config, and dotenv.config(if this is used). For health data simply use Chronos.track()
+
+
+
+```js
+//track health data
+const chronos = require('chronos-tracker');
+require('./chronos-config');
+require('dotenv').config(); // set up environment variables in .env
+const BookModel = require('./BookModel');
+
+chronos.track()
+```
+To trace requests, first wrap the gRPC client using Chronos
+```js
+const grpc = require('@grpc/grpc-js');
+const protoLoader = require('@grpc/proto-loader');
+const chronos = require('chronos');
+
+const PROTO_PATH = './order.proto';
+
+const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
+  keepCase: true,
+  longs: String,
+  enums: String,
+  arrays: true,
+});
+const OrderToBookService = grpc.loadPackageDefinition(packageDefinition).OrderToBook;
+const bookClient = new OrderToBookService('localhost:30044', grpc.credentials.createInsecure());
+
+const ClientWrapper = chronos.ClientWrapper(bookClient, OrderToBookService);
+```
+Next wrap the gRPC server  using Chronos 
+```js
+
+  const ServerWrapper = chronos.ServerWrapper(server,  Proto.protoname.service, {
+    AddBook: (call, callback) => {
+    // console.log(call.metadata)
+    // get the properties from the gRPC client call
+      const { title, author, numberOfPages, publisher, bookID } = call.request;
+    // create a book in our book collection
+      BookModel.create({
+        title,
+        author,
+        numberOfPages,
+        publisher,
+        bookID,
+      });
+      callback(null, {});
+    },
+  });
+})
+```
+For any request you wish to trace, require uuidv4 and write the following code where the initial gRPC request begins,
+```js
+const require { v4: uuidv4} = require('uuid')
+const createMeta = () => {
+  const meta = new grpc.Metadata();
+  meta.add('id', uuidvd());
+  return meta
+}
+```
+and then invoke createMeta as a third argument to any client method that is the beginning of the request path.
+
+```js
+orderClient.AddOrder(
+    order,
+    (err, data) => {
+      if (err !== null) {
+        console.log(err);
+        // could not add order because bookID does not exist
+        return res.sendStatus(404);
+      }
+      console.log('addOrder response: ', data);
+      return res.sendStatus(200);
+    },
+    createMeta()
+  );
+
+```
+Finally, on all servers that will be involved in the request path, invoke `chronos.link` with parameters of `client` and `ServerWrapper` in the server wrapper.
+
+```js
+chronos.link(client, ServerWrapper);
+```
+
 ### Docker Configuration
 
 Again, this step is **only applicable** if you are currently using <a href="#"><img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /></a> containers for your microservices. 
@@ -304,7 +404,7 @@ The **'gRPC'** branch is the current codebase for the <a href="#"><img src="./ap
 - <a href="#"><img src="./app/assets/node-logo-color.png" alt="Node" title="Node" align="center" height="30" /></a>
 - <a href="#"><img src="./app/assets/express-logo-color.png" alt="Express" title="Express" align="center" height="30" /></a>
 - <a href="#"><img src="./app/assets/http-logo-color.png" alt="HTTP" title="HTTP" align="center" height="30" /></a>
-- <a href="#"><img src="./app/assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="30" /></a> _coming soon_
+- <a href="#"><img src="./app/assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="30" /></a> 
 - <a href="#"><img src="./app/assets/graphql-logo-color.png" alt="GraphQL" title="GraphQL" align="center" height="30" /></a>
 - <a href="#"><img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="30" /></a>
 - <a href="#"><img src="./app/assets/aws-logo-color.png" alt="AWS" title="AWS" align="center" height="30" /></a>