#40. Net statistics support

Author: asilvas-godaddy

README.md

@@ -3,13 +3,15 @@
 [![Build Status](https://travis-ci.org/godaddy/node-cluster-service.png)](https://travis-ci.org/godaddy/node-cluster-service) [![NPM version](https://badge.fury.io/js/cluster-service.png)](http://badge.fury.io/js/cluster-service) [![Dependency Status](https://gemnasium.com/godaddy/node-cluster-service.png)](https://gemnasium.com/godaddy/node-cluster-service) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/godaddy/node-cluster-service/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 
+
 ## Install
 
 	npm install cluster-service
 
 https://npmjs.org/package/cluster-service
 
 
+
 ## About
 
 The short answer:
@@ -35,6 +37,7 @@ Stability:
 	with either a deprecation schedule, or documented as a breaking change if necessary.
 
 
+ 
 ## Getting Started
 
 Turning your single process node app/service into a fault-resilient multi-process service with all of the bells and whistles has never been easier!
@@ -99,6 +102,7 @@ You can even pipe raw JSON, which can be processed by the caller:
 Check out ***Cluster Commands*** for more details.
 
 
+
 ## Start Options
 
 When initializing your service, you have a number of options available:
@@ -151,6 +155,8 @@ Or within your node app:
   extension. If the module exposes the "id" property, that will be the name of the command,
   otherwise the filename (minus the extension) will be used as the name of the command. If relative
   paths are provided, they will be resolved from process.cwd().
+* `servers` - One (object) or more (array of objects) `Net` objects to listen for ***Net Stats***.
+  
 
 
 ## Console & REST API
@@ -193,6 +199,7 @@ Commands may be disabled by overriding them.
 * `upgrade all|pid workerPath { [cwd] [timeout:60] }` - Gracefully upgrade service, one worker at a time. (continuous deployment support).
 * `workers` - Returns list of active worker processes.
 * `health` - Returns health of service. Can be overidden by service to expose app-specific data.
+* `info` - Returns summary of process & workers.
 
 
 
@@ -256,7 +263,7 @@ Additionally, a worker may optionally perform cleanup tasks prior to exit, via:
 ## Access Control
 
 Commands may be granted "inproc" (high risk), "local" (low risk), or "remote" (no risk). Setting
-access control at compile time can be done within the command, like so:
+access control can be done within the command, like so:
 
 ```javascript
 // exit.js
@@ -291,6 +298,24 @@ different location. This capability is still a work in progress, but initial tes
 * Upgrade reports success
 
 
+  
+## Net Stats
+
+As of v0.8, you may optionally collect network statistics within cservice. To enable this feature,
+you must provide all Net object servers (tcp, http, https, etc) in one of two ways:
+
+  var server = require("http").createServer(onRequest);
+  require("cluster-service").netStats(server); // listen to net stats
+
+Or you can provide the net server objects via the ```servers``` option:
+
+  var server = require("http").createServer(onRequest);
+  require("cluster-service").workerReady({ servers: [server] }); // listen to net stats
+  
+Net statistics summary may be found via the ```info``` command, and individual process
+net statistics may be found via the ```workers``` command.
+ 
+ 
 
 ## Tests & Code Coverage
 

cluster-service.js

@@ -52,6 +52,7 @@ if (cluster.isMaster === true) {
 }
 
 exports.start = require("./lib/start");
+exports.netStats = require("./lib/net-stats");
 
 if (
   cluster.isWorker === true

lib/commands/info.js

@@ -0,0 +1,42 @@
+var cservice = require("../../cluster-service");
+
+module.exports = function(evt, cb, cmd) {
+  cservice.trigger("workers", function(err, results) {
+    if (err) {
+      cb(err);
+      return;
+    }
+
+    var workers = results.workers;
+    var summary = {
+      workers: { active: workers.length },
+      memory: { rss: 0, heapTotal: 0, heapUsed: 0 },
+      net: { connections: 0, connectionsOpen: 0, requests: 0 }
+    };
+    
+    for (var i = 0; i < workers.length; i++) {
+      var w = workers[i];
+      var p = w.process;
+      summary.memory.rss += p.memory.rss;
+      summary.memory.heapTotal += p.memory.heapTotal;
+      summary.memory.heapUsed += p.memory.heapUsed;
+      summary.net.connections += p.net.connections;
+      summary.net.connectionsOpen += p.net.connectionsOpen;
+      summary.net.requests += p.net.requests;
+    }
+    
+    cb(null, summary);
+  }, "simple");
+};
+
+module.exports.more = function(cb) {
+  cb(null, {
+    command: "info",
+    info: "Returns summary of process & workers."
+  });
+};
+
+module.exports.control = function() {
+  return "remote"; // consistent with "workers" command,
+                   // but may be locked down in the future
+};

lib/commands/workers.js

@@ -47,7 +47,6 @@ function getProcessDetails(worker) {
         cb("processDetails not returned");
         return; // end
       }
-
       worker.processDetails = msg.processDetails;
       cb(null, worker);
     });

lib/defaults.js

@@ -4,6 +4,7 @@ module.exports = exports = {
   firstTime: true,
   events: {},
   workers: {},
+  stats: { net: { requests: 0, connections: 0, connectionsOpen: 0 } },
   state: 0, // 0-not running, 1-starting, 2-running
   isAttached: false, // attached to CLI over REST
   workerReady: undefined,

lib/net-stats.js

@@ -0,0 +1,17 @@
+var cservice = require("../cluster-service");
+
+module.exports = exports = netStats;
+
+function netStats(server) {
+  server.on("connection", function(connection) {
+    cservice.locals.stats.net.connections++;
+    cservice.locals.stats.net.connectionsOpen++;
+    connection.on("close", function() {
+      cservice.locals.stats.net.connectionsOpen--;
+    });
+  });
+
+  server.on("request", function() {
+    cservice.locals.stats.net.requests++;
+  });
+}

lib/worker-ready.js

@@ -1,5 +1,6 @@
 var cservice = require("../cluster-service"),
   cluster = require("cluster"),
+  util = require("util"),
   onWorkerStop = null;
 
 module.exports = exports = workerReady;
@@ -23,6 +24,15 @@ function workerReady(options, forceIsWorker) {
 
   options = options || {};
 
+  if (options.servers) {
+    if (util.isArray(options.servers) === false) {
+      options.servers = [options.servers];
+    }
+    for (var i = 0; i < options.servers.length; i++) {
+      require("./net-stats")(options.servers[i]);
+    }
+  }
+  
   onWorkerStop = options.onWorkerStop;
 
   process.on("message", onMessageFromMaster);

lib/workers.js

@@ -1,4 +1,5 @@
-var cluster = require("cluster");
+var cservice = require("../cluster-service"),
+  cluster = require("cluster");
 
 exports.get = get;
 exports.monitor = monitor;
@@ -47,7 +48,8 @@ function monitor() {
         process.send({
           cservice: "processDetails",
           processDetails: {
-            memoryUsage: process.memoryUsage(),
+            net: cservice.locals.stats.net,
+            memory: process.memoryUsage(),
             title: process.title,
             uptime: process.uptime(),
             hrtime: process.hrtime()

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cluster-service",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "author": {
     "name": "Aaron Silvas",
     "email": "[email protected]"

vs/node-cluster-service.njsproj

@@ -16,6 +16,10 @@
   <PropertyGroup Condition="'$(Configuration)' == 'Debug'" />
   <PropertyGroup Condition="'$(Configuration)' == 'Release'" />
   <ItemGroup>
+    <Compile Include="lib\commands\info.js" />
+    <Compile Include="lib\commands\workerExit.js" />
+    <Compile Include="lib\commands\workerStart.js" />
+    <Compile Include="lib\net-stats.js" />
     <Compile Include="test\bin.js" />
     <Compile Include="test\commands2\custom-name.js" />
     <Compile Include="test\commands\custom.js" />