#16 make the cluster example runnable

README.md

@@ -40,28 +40,6 @@ The order in which the routes are registered is important, since
 You can use this to your advantage to bypass some of the routes.
 See the example below.
 
-## Usage with Node Cluster
-``` javascript
-if (cluster.isMaster) {
-    const numCPUs = Math.max(2, os.cpus().length);
-    const workers: cluster.Worker[] = [];
-    for (let i=1; i < numCPUs; i++) {
-        const worker = forkWorker();
-        workers.push(worker);
-    }
-    const metricsApp = express();
-    metricsApp.use('/cluster_metrics', promBundle.clusterMetrics());
-    metricsApp.listen(9999);
-    console.log('metrics listening on 9999'); // call localhost:9999/cluster_metrics for aggregated metrics
-} else {
-    const app = express();
-    app.use(promBundle({includeMethod: true});
-    app.use('/api', require('./api'));
-    app.listen(3000);
-}
-```
-The code the master process runs will expose an API with a single endpoint `/cluster_metrics` which returns an aggregate of all metrics from all the workers.
-
 ## Options
 
 Which labels to include in `http_request_duration_seconds` metric:
@@ -192,6 +170,42 @@ app.use(/* your middleware */);
 app.listen(3000);
 ```
 
+## using with cluster
+
+You'll need tp use an additional **clusterMetrics()** middleware.
+
+In the example below the master process will expose an API with a single endpoint `/metrics`
+which returns an aggregate of all metrics from all the workers.
+
+``` javascript
+const cluster = require('cluster');
+const promBundle = require('./src/index');
+const numCPUs = Math.max(2, require('os').cpus().length);
+const express = require('express');
+
+if (cluster.isMaster) {
+    for (let i = 1; i < numCPUs; i++) {
+        cluster.fork();
+    }
+    
+    const metricsApp = express();
+    metricsApp.use('/metrics', promBundle.clusterMetrics());
+    metricsApp.listen(9999);
+    
+    console.log('cluster metrics listening on 9999');
+    console.log('call localhost:9999/metrics for aggregated metrics');
+} else {
+    const app = express();
+    app.use(promBundle({
+        autoregister: false, // disable /metrics for single workers
+        includeMethod: true
+    }));
+    app.use((req, res) => res.send(`hello from pid ${process.pid}\n`));
+    app.listen(3000);
+    console.log(`worker ${process.pid} listening on 3000`);
+}
+```
+
 ## using with kraken.js
 
 Here is meddleware config sample, which can be used in a standard **kraken.js** application.