feat: metrics (WIP) - feat: Dockerfile - fix/feat: various other things

Author: mkg20001

.gitignore

@@ -7,6 +7,7 @@ test/setup/tmp-disposable-nodes-addrs.json
 dist
 coverage
 **/*.swp
+**/*.bak
 examples/sub-module/**/bundle.js
 examples/sub-module/**/*-minified.js
 examples/sub-module/*-bundle.js

Dockerfile

@@ -0,0 +1,6 @@
+FROM node:8
+COPY . /src
+WORKDIR /src
+RUN npm i --production
+CMD ["npm", "start"]
+EXPOSE 9090

package.json

@@ -7,7 +7,8 @@
     "websockets-star": "src/bin.js"
   },
   "scripts": {
-    "rendezvous": "node sig-server/src/bin.js",
+    "rendezvous": "node src/bin.js",
+    "start": "node src/bin.js",
     "lint": "aegir-lint",
     "test": "aegir-test --env node",
     "release": "aegir-release --env no-build",
@@ -26,6 +27,7 @@
     "async": "^2.5.0",
     "data-queue": "0.0.2",
     "debug": "^3.0.1",
+    "epimetheus": "^1.0.54",
     "hapi": "^16.6.0",
     "inert": "^4.2.1",
     "libp2p-crypto": "^0.10.3",
@@ -36,6 +38,7 @@
     "once": "^1.4.0",
     "peer-id": "^0.10.1",
     "peer-info": "^0.11.0",
+    "prom-client": "^10.1.0",
     "socket.io": "^2.0.3",
     "socket.io-client": "^2.0.3",
     "socket.io-pull-stream": "^0.1.1",

src/bin.js

@@ -11,7 +11,8 @@ signalling.start({
   port: argv.port || argv.p || process.env.PORT || 9090,
   host: argv.host || argv.h || process.env.HOST || '0.0.0.0',
   cryptoChallenge: !(argv.disableCryptoChallenge || process.env.DISABLE_CRYPTO_CHALLENGE),
-  strictMultiaddr: !(argv.disableStrictMultiaddr || process.env.DISABLE_STRICT_MULTIADDR)
+  strictMultiaddr: !(argv.disableStrictMultiaddr || process.env.DISABLE_STRICT_MULTIADDR),
+  metrics: true
 }, (err, _server) => {
   if (err) {
     throw err

src/config.js

@@ -19,5 +19,6 @@ module.exports = {
   },
   refreshPeerListIntervalMS: 10000,
   cryptoChallenge: true,
-  strictMultiaddr: true
+  strictMultiaddr: false,
+  metrics: false
 }

src/index.js

@@ -3,6 +3,7 @@
 const Hapi = require('hapi')
 const merge = require('merge-recursive').recursive
 const path = require('path')
+const epimetheus = require('epimetheus')
 
 exports = module.exports
 
@@ -53,5 +54,7 @@ exports.start = (options, callback) => {
     })
   })
 
+  if (config.metrics) epimetheus.instrument(http)
+
   return http
 }

src/routes.js

@@ -4,11 +4,20 @@ const SocketIO = require('socket.io')
 const sp = require('socket.io-pull-stream')
 const util = require('./utils')
 const uuid = require('uuid')
+const client = require("prom-client")
+const fake = {
+  gauge: {
+    set: () => {}
+  },
+  counter: {
+    inc: () => {}
+  }
+}
 
 module.exports = (config, http) => {
   const log = config.log
   const io = new SocketIO(http.listener)
-  const proto = new util.Protocol(config.log)
+  const proto = new util.Protocol(log)
 
   proto.addRequest('ss-join', ['multiaddr', 'string', 'function'], join)
   proto.addRequest('ss-leave', ['multiaddr'], leave)
@@ -18,17 +27,21 @@ module.exports = (config, http) => {
 
   log('create new server', config)
 
-  const peers = this._peers = {}
+  this._peers = {}
   const nonces = {}
 
+  const peers_metric = config.metrics ? new client.Gauge({ name: 'rendezvous_peers', help: 'peers online now' }) : fake.gauge
+  const dials_success_total = config.metrics ? new client.Counter({ name: 'rendezvous_dials_total_success', help: 'sucessfully completed dials since server started' }) : fake.counter
+  const dials_failure_total = config.metrics ? new client.Counter({ name: 'rendezvous_dials_total_failure', help: 'failed dials since server started' }) : fake.counter
+  const dials_total = config.metrics ? new client.Counter({ name: 'rendezvous_dials_total', help: 'all dials since server started' }) : fake.counter
+
   const getPeers = () => this._peers
+  const refreshMetrics = () => peers_metric.set(Object.keys(getPeers()).length)
 
-  this.peers = () => {
-    return peers
-  }
+  this.peers = () => getPeers()
 
   function safeEmit (addr, event, arg) {
-    const peer = peers[addr]
+    const peer = getPeers()[addr]
     if (!peer) {
       log('trying to emit %s but peer is gone', event)
       return
@@ -95,6 +108,7 @@ module.exports = (config, http) => {
   function joinFinalize (socket, multiaddr, cb) {
     const log = config.log.bind(config.log, '[' + socket.id + ']')
     getPeers()[multiaddr] = socket
+    refreshMetrics()
     socket.addrs.push(multiaddr)
     log('registered as', multiaddr)
 
@@ -104,6 +118,7 @@ module.exports = (config, http) => {
 
     socket.once('ss-leave', function handleLeave (ma) {
       if (ma === multiaddr) {
+        refreshMetrics()
         socket.addrs = socket.addrs.filter(m => m !== ma)
         stopSendingPeers()
       } else {
@@ -136,41 +151,48 @@ module.exports = (config, http) => {
   }
 
   function leave (socket, multiaddr) {
-    if (peers[multiaddr]) {
-      delete peers[multiaddr]
+    if (getPeers()[multiaddr]) {
+      delete getPeers()[multiaddr]
     }
   }
 
   function disconnect (socket) {
-    Object.keys(peers).forEach((mh) => {
-      if (peers[mh].id === socket.id) {
-        delete peers[mh]
+    Object.keys(getPeers()).forEach((mh) => {
+      if (getPeers()[mh].id === socket.id) {
+        delete getPeers()[mh]
       }
     })
+    refreshMetrics()
   }
 
   function dial (socket, from, to, dialId, cb) {
     const log = config.log.bind(config.log, '[' + dialId + ']')
     const s = socket.addrs.filter((a) => a === from)[0]
 
+    dials_total.inc()
+
     if (!s) {
-      return cb(new Error('Not authorized for this address'))
+      dials_failure_total.inc()
+      return cb('Not authorized for this address')
     }
 
     log(from, 'is dialing', to)
-    const peer = peers[to]
+    const peer = getPeers()[to]
 
     if (!peer) {
-      return cb(new Error('Peer not found'))
+      dials_failure_total.inc()
+      return cb('Peer not found')
     }
 
     socket.createProxy(dialId + '.dialer', peer)
 
     peer.emit('ss-incomming', dialId, from, err => {
       if (err) {
+        dials_failure_total.inc()
         return cb(err)
       }
 
+      dials_success_total.inc()
       peer.createProxy(dialId + '.listener', socket)
       cb()
     })

test/rendezvous.spec.js

@@ -58,7 +58,8 @@ describe('rendezvous', () => {
       port: 12345,
       refreshPeerListIntervalMS: 1000,
       cryptoChallenge: false,
-      strictMultiaddr: false
+      strictMultiaddr: false,
+      metrics: true
     }
 
     rendezvous.start(options, (err, server) => {