init

Author: didil

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.idea/
+test-data/

README.md

@@ -0,0 +1,53 @@
+# pm2-postgres
+PostgreSQL module for Keymetrics
+
+![pm2-postgres screenshot](https://raw.githubusercontent.com/pm2-hive/pm2-postgres/master/pm2-postgres.jpg)
+
+## Description
+
+PM2 module to monitor key PostgreSQL server metrics:
+
+* 
+* 
+* 
+*
+
+## Requirements
+
+This module requires a PostgreSQL install (tested against v9.4).
+
+## Install
+
+```bash
+$ npm install pm2 -g
+
+$ pm2 install pm2-postgres
+```
+
+## Config
+
+The default connection details are :    
+"hostname": "localhost"  
+"port": 5432  
+"username": "guest"  
+"password": "guest"  
+"database": "postgres"  
+
+To modify the config values you can use the commands:
+```bash
+$ pm2 set pm2-postgres:hostname localhost
+$ pm2 set pm2-postgres:port 5432
+$ pm2 set pm2-postgres:username guest
+$ pm2 set pm2-postgres:password guest
+$ pm2 set pm2-postgres:database postgres
+```
+
+## Uninstall
+
+```bash
+$ pm2 uninstall pm2-postgres
+```
+
+# License
+
+MIT

app.js

@@ -0,0 +1,49 @@
+var pmx = require('pmx');
+var pgClientFactory = require('./lib/clientFactory.js');
+var pgStats = require('./lib/stats.js');
+var pgActions = require('./lib/actions.js');
+
+pmx.initModule({
+
+  pid: pmx.resolvePidPaths(['/var/run/postgresql/9.4-main.pid', '/var/run/postgresql/9.3-main.pid']),
+
+  // Options related to the display style on Keymetrics
+  widget: {
+
+    // Logo displayed
+    logo: 'http://www.inquidia.com/sites/default/files/postgresql_logo%5B1%5D.png',
+
+    // Module colors
+    // 0 = main element
+    // 1 = secondary
+    // 2 = main border
+    // 3 = secondary border
+    theme: ['#141A1F', '#222222', '#FC6400', '#807C7C'],
+
+    // Section to show / hide
+    el: {
+      probes: true,
+      actions: true
+    },
+
+    // Main block to show / hide
+    block: {
+      actions: true,
+      issues: true,
+      meta: true,
+
+      // Custom metrics to put in BIG
+      main_probes: ['Tables', 'Indexes']
+    }
+
+  }
+
+}, function (err, conf) {
+  var pgClient = pgClientFactory.build(conf);
+
+  // Init metrics refresh loop
+  pgStats.init(pgClient);
+
+  // Init actions
+  pgActions.init(pgClient);
+});

lib/actions.js

@@ -0,0 +1,12 @@
+var pmx = require('pmx');
+
+function initActions(pgClient) {
+
+
+}
+
+function init(pgClient) {
+  initActions(pgClient);
+}
+
+module.exports.init = init;

lib/clientFactory.js

@@ -0,0 +1,36 @@
+var pg = require('pg');
+var pmx = require('pmx');
+
+function build(conf) {
+  var pgClient = {};
+
+  var connectionString = "postgres://" + conf.username + ":" + conf.password + "@" + conf.hostname + ":" + conf.port + "/" + conf.database;
+
+  pgClient.query = function (queryString, cb) {
+    pg.connect(connectionString, function (err, client, done) {
+      if (err) {
+        // A connection error occurred, remove the client from the connection pool.
+        if (client) {
+          done(client);
+        }
+        return pmx.notify("Couldn't connect to postgres: " + err);
+      }
+
+      client.query(queryString, function (err, result) {
+        if (err) {
+          // return client to the connection pool
+          done();
+          return cb(err);
+        }
+
+        // return client to the connection pool
+        done();
+        return cb(null, result);
+      });
+    });
+  };
+
+  return pgClient;
+}
+
+module.exports.build = build;

lib/stats.js

@@ -0,0 +1,111 @@
+var pmx = require('pmx');
+
+var metrics = {};
+var REFRESH_RATE = 10000; // ms
+var probe = pmx.probe();
+
+// Init metrics with default values
+function initMetrics() {
+  metrics.tableCount = probe.metric({
+    name: 'Tables',
+    value: 'N/A'
+  });
+  metrics.indexCount = probe.metric({
+    name: 'Indexes',
+    value: 'N/A'
+  });
+  metrics.transactionsCommitted = probe.metric({
+    name: 'Transactions Committed',
+    value: 'N/A'
+  });
+  metrics.transactionsRollback = probe.metric({
+    name: 'Transactions Rollback',
+    value: 'N/A'
+  });
+  metrics.tuplesFetched = probe.metric({
+    name: 'Tuples Fetched',
+    value: 'N/A'
+  });
+  metrics.tuplesInserted = probe.metric({
+    name: 'Tuples Inserted',
+    value: 'N/A'
+  });
+  metrics.tuplesUpdated = probe.metric({
+    name: 'Tuples Updated',
+    value: 'N/A'
+  });
+  metrics.tuplesDeleted = probe.metric({
+    name: 'Tuples Deleted',
+    value: 'N/A'
+  });
+}
+
+// Refresh metrics
+function refreshMetrics(pgClient) {
+  refreshTableCount(pgClient);
+  refreshIndexCount(pgClient);
+  refreshTransactionMetrics(pgClient);
+}
+
+function refreshTableCount(pgClient) {
+  var queryString = "SELECT count(1) as relations FROM pg_class WHERE relkind IN ('r', 't');";
+  pgClient.query(queryString, function (err, results) {
+    if (err) {
+      return pmx.notify("Table Query Error: " + err);
+    }
+
+    // # of Tables
+    metrics.tableCount.set(results.rows[0].relations);
+  });
+}
+
+function refreshIndexCount(pgClient) {
+  var queryString = "SELECT count(1) as indexes FROM pg_class WHERE relkind = 'i';";
+  pgClient.query(queryString, function (err, results) {
+    if (err) {
+      return pmx.notify("Index Query Error: " + err);
+    }
+
+    // # of Indexes
+    metrics.indexCount.set(results.rows[0].indexes);
+  });
+}
+
+function refreshTransactionMetrics(pgClient) {
+  var queryString = "SELECT sum(xact_commit) AS transactions_committed,"
+    + " sum(xact_rollback) AS transactions_rollback, sum(blks_read) AS blocks_read,"
+    + " sum(blks_hit) AS blocks_hit, sum(tup_returned) AS tuples_returned,"
+    + " sum(tup_fetched) AS tuples_fetched, sum(tup_inserted) AS tuples_inserted,"
+    + " sum(tup_updated) AS tuples_updated, sum(tup_deleted) AS tuples_deleted"
+    + " FROM pg_stat_database;";
+  pgClient.query(queryString, function (err, results) {
+    if (err) {
+      return pmx.notify("Transaction Query Error: " + err);
+    }
+
+    // Transactions Committed
+    metrics.transactionsCommitted.set(results.rows[0].transactions_committed);
+
+    // Transactions Rollback
+    metrics.transactionsRollback.set(results.rows[0].transactions_rollback);
+
+    // Tuples Fetched
+    metrics.tuplesFetched.set(results.rows[0].tuples_fetched);   
+     
+    // Tuples Inserted
+    metrics.tuplesInserted.set(results.rows[0].tuples_inserted);
+    
+    // Tuples Updated
+    metrics.tuplesUpdated.set(results.rows[0].tuples_updated);
+
+    // Tuples Deleted
+    metrics.tuplesDeleted.set(results.rows[0].tuples_deleted);
+  });
+}
+
+function init(pgClient) {
+  initMetrics();
+  setInterval(refreshMetrics.bind(this, pgClient), REFRESH_RATE);
+}
+
+module.exports.init = init;

package.json

@@ -0,0 +1,31 @@
+{
+  "name": "pm2-postgres",
+  "version": "0.0.1",
+  "description": "PM2 PostgreSQL Module",
+  "main": "app.js",
+  "dependencies": {
+    "pg": "^4.4.2",
+    "pmx": ">=0.5.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pm2-hive/pm2-postgres.git"
+  },
+  "config": {
+    "hostname": "localhost",
+    "port": 5432,
+    "username": "guest",
+    "password": "guest",
+    "database": "postgres"
+  },
+  "apps": [
+    {
+      "merge_logs": true,
+      "max_memory_restart": "200M",
+      "script": "app.js"
+    }
+  ],
+  "author": "Keymetrics Inc.",
+  "license": "MIT",
+  "devDependencies": {}
+}