Logging information from quai platform to MongoDB
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENCE
README.md
formatMessage.js
index.js
package.json
test.js

README.md

Quai Mongo

This module provide logging for Quai Platform. It inserts messages to MongoDB.
Click here for more details

Index

Examples

Install as a library:
npm install git+ssh://git@github.com:yp-engineering/quai-mongo.git

Exapmle 1 - not using callbacks

'use strict';

var db = require('quai-mongo');
var message = {foo: 'bar'}

var insert = db('mongodb://localhost/quai');
// wait a bit for db connection
setTimeout(function(){
  insert(message);
}, 100);

// =>
// connected to mongoDB mongodb://localhost/quai
// Saved to MongoDB. message: {"foo":"bar","_id":"51a908865dc559285f000001"}

example 2 - using callbacks

'use strict';

var db = require('quai-mongo');
var message = {foo: 'bar'}

var insert = db('mongodb://localhost/quai', function(err){ 
  if (err) { console.error(err); return 1; };
  console.log('Connected.');

  insert(message, function(err){
    if (err) { console.error(err); return 1; };

    console.log('Saved. message: ', message);
  });
});

// =>
// Connected.
// Saved. message:  { foo: 'bar' }

Methods

var db = require('./index.js');

db(mongoUrl, cb);

Connet to a MongoDB at mongoUrl. cb is optional callback. It returns a function that insert a message(see below).
when connection established, cb(err) fires.

var insert = db('mongodb://localhost/quai');

insert(message, cb);

Inserts message to MongoDB.
When Insert is complete cb(err) is fired.

Install

as a library

	npm install git+ssh://git@github.com:yp-engineering/quai-mongo.git

and require('quai-mongo'); in your code

for development

	git clone git@github.com:yp-engineering/quai-mongo.git
npm install

node test.js

Misc

Coding Guidlines

  • Style Guide - http://nodeguide.com/style.html
  • Avoid frameworks/abstractions (web, test, control flow) untill you feel a pain
  • "use strict" at the top of every js file
  • Process monitoring - I like forever
  • GET /health end-point
  • Single entry point for dependencies and using Mocks during unit tests
  • App should be able to run as a command line app. app = require('./app')
  • Use Callbacks when you want to know if something has finished. app.init(doneInit); app.start(readyToServe);
  • Use Event Emitter when you want to notify someone multiple times or when you have many listeners