feat(monitoring): Add metrics endpoint for Prometheus

Author: D34THWINGS

.gitlab-ci.yml

@@ -29,7 +29,7 @@ deploy_production:
     - ssh-add <(echo "$SSH_PRIVATE_KEY")
     - mkdir -p ~/.ssh
     - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config'
-    - ssh linkvalue@62.4.5.247 "rm -rf lvconnect && git clone git@gitlab.com:LinkValue/Lab/LvConnect.git lvconnect && cd lvconnect && yarn install"
+    - ssh linkvalue@62.4.5.247 "rm -rf lvconnect && git clone git@gitlab.com:LinkValue/Lab/LvConnect.git lvconnect && cd lvconnect && yarn install && pm2 restart all"
   only:
     - tags
   when: manual

config/test.js

@@ -9,13 +9,13 @@ module.exports = {
     },
   },
   mongodb: {
-    host: 'mongo',
+    host: 'localhost',
     port: 27017,
     database: 'lvconnect_test',
   },
   kue: {
     redis: {
-      host: 'redis',
+      host: 'localhost',
       port: 6379,
       db: 0,
     },

package.json

@@ -51,6 +51,7 @@
     "node-trello": "^1.1.2",
     "ovh": "2.0.1",
     "pmx": "^1.2.0",
+    "prom-client": "^9.0.0",
     "request": "^2.79.0",
     "request-promise": "^4.1.1",
     "uuid": "^3.0.1",

server/create-server.js

@@ -0,0 +1,101 @@
+const Glue = require('glue');
+const config = require('config');
+
+const globalRoutes = require('./global-routes');
+
+const manifest = {
+  server: {
+    cache: config.server.cache,
+  },
+  registrations: [{
+    plugin: {
+      register: 'good',
+      options: config.logs,
+    },
+  }, {
+    plugin: 'hapi-auth-cookie',
+  }, {
+    plugin: 'hapi-auth-basic',
+  }, {
+    plugin: 'hapi-auth-bearer-token',
+  }, {
+    plugin: {
+      register: 'crumb',
+      options: config.csrf,
+    },
+  }, {
+    plugin: 'vision',
+  }, {
+    plugin: 'inert',
+  }, {
+    plugin: {
+      register: './mongodb',
+      options: config.mongodb,
+    },
+  }, {
+    plugin: {
+      register: './mailjet',
+      options: config.mailjet,
+    },
+  }, {
+    plugin: './monitoring',
+  }, {
+    plugin: './users',
+  }, {
+    plugin: {
+      register: './login',
+      options: config.login,
+    },
+  }, {
+    plugin: {
+      register: './oauth',
+      options: config.oauth,
+    },
+  }, {
+    plugin: './dashboard',
+  }, {
+    plugin: {
+      register: './tasks',
+      options: config.kue,
+    },
+  }],
+  connections: [{
+    host: config.host.hostname,
+    port: config.host.port,
+    routes: {
+      cors: {
+        origin: ['*'],
+      },
+    },
+  }],
+};
+
+function createServer() {
+  return Glue.compose(manifest, {
+    relativeTo: __dirname,
+  });
+}
+
+function createAndInitServer() {
+  createServer()
+    .then(server => server.start().then(() => server))
+    .then((server) => {
+      server.log('info', `Server started on port ${server.connections[0].info.uri}`);
+
+      server.route(globalRoutes);
+
+      // Handle uncaught promise rejections
+      process.on('unhandledRejection', (reason) => {
+        server.log('error', `Unhandled rejection: ${reason.stack}`);
+      });
+    })
+    .catch((err) => {
+      console.error(err.stack); // eslint-disable-line no-console
+      process.exit(1);
+    });
+}
+
+module.exports = {
+  createServer,
+  createAndInitServer,
+};

server/dashboard/index.js

@@ -1,5 +1,4 @@
 const Boom = require('boom');
-const uuid = require('uuid');
 const handlebars = require('handlebars');
 const routes = require('./routes');
 

server/dashboard/layouts/default.hbs

@@ -5,8 +5,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1">
 
     <!-- Material Design Lite -->
-    <link rel="stylesheet" href="/mdl/material-icons.css">
-    <link rel="stylesheet" href="/mdl/material.blue-light_blue.min.css">
+    <link rel="stylesheet" href="/assets/material-icons.css">
+    <link rel="stylesheet" href="/assets/material.blue-light_blue.min.css">
+    <script defer async src="/assets/material.min.js"></script>
 
     <!-- LvConnect -->
     <link rel="stylesheet" href="/dashboard/assets/css/dashboard.css">
@@ -45,6 +46,5 @@
         {{{content}}}
       </main>
     </div>
-    <script defer async src="/mdl/material.min.js"></script>
   </body>
 </html>

server/global-routes.js

@@ -2,7 +2,7 @@ const path = require('path');
 
 module.exports = [{
   method: 'GET',
-  path: '/mdl/{param*}',
+  path: '/assets/{param*}',
   config: {
     auth: false,
   },

server/index.js

@@ -1,118 +1,3 @@
-const pmx = require('pmx');
+const { createAndInitServer } = require('./create-server');
 
-let pmxProbe;
-if (require.main === module && process.env.NODE_ENV === 'production') {
-  pmxProbe = pmx.init({
-    http: true,
-    errors: true,
-    custom_probes: true, // Auto expose JS Loop Latency and HTTP req/s as custom metrics
-    network: true, // Network monitoring at the application level
-    ports: true, // Shows which ports your app is listening on (default: false)
-  });
-}
-
-const Glue = require('glue');
-const config = require('config');
-
-const globalRoutes = require('./global-routes');
-
-const manifest = {
-  server: {
-    cache: config.server.cache,
-  },
-  registrations: [{
-    plugin: {
-      register: 'good',
-      options: config.logs,
-    },
-  }, {
-    plugin: 'hapi-auth-cookie',
-  }, {
-    plugin: 'hapi-auth-basic',
-  }, {
-    plugin: 'hapi-auth-bearer-token',
-  }, {
-    plugin: {
-      register: 'crumb',
-      options: config.csrf,
-    },
-  }, {
-    plugin: 'vision',
-  }, {
-    plugin: 'inert',
-  }, {
-    plugin: {
-      register: './mongodb',
-      options: config.mongodb,
-    },
-  }, {
-    plugin: {
-      register: './mailjet',
-      options: config.mailjet,
-    },
-  }, {
-    plugin: './users',
-  }, {
-    plugin: {
-      register: './login',
-      options: config.login,
-    },
-  }, {
-    plugin: {
-      register: './oauth',
-      options: config.oauth,
-    },
-  }, {
-    plugin: './dashboard',
-  }, {
-    plugin: {
-      register: './tasks',
-      options: config.kue,
-    },
-  }],
-  connections: [{
-    host: config.host.hostname,
-    port: config.host.port,
-    routes: {
-      cors: {
-        origin: ['*'],
-      },
-    },
-  }],
-};
-
-function createServer() {
-  return Glue.compose(manifest, {
-    relativeTo: __dirname,
-  });
-}
-
-module.exports = createServer;
-
-if (require.main === module) {
-  createServer()
-    .then(server => server.start().then(() => server))
-    .then((server) => {
-      server.log('info', `Server started on port ${server.connections[0].info.uri}`);
-
-      server.route(globalRoutes);
-
-      // Handle uncaught promise rejections
-      process.on('unhandledRejection', (reason) => {
-        server.log('error', `Unhandled rejection: ${reason.stack}`);
-      });
-
-      // Error probing
-      if (pmxProbe) {
-        server.on('log', (event, { error }) => {
-          if (error) {
-            pmxProbe.notify(event.data);
-          }
-        });
-      }
-    })
-    .catch((err) => {
-      console.error(err.stack); // eslint-disable-line no-console
-      process.exit(1);
-    });
-}
+createAndInitServer();

server/mailjet/index.js

@@ -34,16 +34,6 @@ exports.register = (server, { apiKey, apiToken }, next) => {
       .catch(err => server.log('error', err));
   });
 
-  server.route({
-    method: 'GET',
-    path: '/test',
-    config: { auth: false },
-    handler(req, res) {
-      req.server.plugins.mailjet.sendAccountCreationMail();
-      res('Hello');
-    },
-  });
-
   next();
 };
 

server/monitoring/index.js

@@ -0,0 +1,33 @@
+const client = require('prom-client');
+
+const requestCounter = new client.Counter({
+  name: 'http_requests_total',
+  help: 'HTTP Requests per seconds',
+  labelNames: ['method', 'path'],
+});
+const collectDefaultMetrics = client.collectDefaultMetrics;
+collectDefaultMetrics(5000);
+
+exports.register = (server, config, next) => {
+  server.route({
+    method: 'GET',
+    path: '/metrics',
+    handler(req, res) {
+      res(client.register.metrics())
+        .type(client.register.contentType);
+    },
+  });
+
+  server.on({ name: 'request-internal', filter: 'received' }, (req) => {
+    if (!/\/assets\//.test(req.path)) {
+      requestCounter.labels(req.method, req.path).inc();
+    }
+  });
+
+  next();
+};
+
+exports.register.attributes = {
+  name: 'monitoring',
+  version: '0.0.1',
+};