Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 4.25 KB

README.md

File metadata and controls

77 lines (54 loc) · 4.25 KB
Raw

Socket Logger: Real-time, JSON-parsable logging for Socket.IO

The code is really simple and fairly trivial right now, but is enough for my immediate needs. See notes below for where I want to take it.

By default, socket logger is a simple logger that you can use with your Socket.IO-based node server.

It's a little different from other loggers in that you can log not just connections and disconnections, but also each message. Also, the log format is not Apache Common Log Format, but instead JSON-parsable strings. So, you log JS objects, not strings.

The secret sauce of socket-logger is how easy it makes it to set up a web client that gets information about your server. Simply create a Socket.IO client that connects to your server with a specified auth token, and now your client gets JSON messages about all the socket connections and messages your server is handling. I'll have an example client up soon.

How to use

You will need to install Socket.IO-node and have a socket-io server running. Then, clone this repo. Now put this in your server and smoke it:

var http = require('http'), 
    logger = require('./path/to/socket-logger'),
	io = require('./path/to/socket.io'),

server = http.createServer(function(req, res){
});

server.listen(8080);
// socket.io, I choose you
var socket = io.listen(server);
var AUTH_TOKEN = 'my_secret_token_for_the_dashboard_client';

socket.on('connection', function(client){
    logger.log({'action' : 'connection', 'client' : client.sessionId});
    client.on('message', function(message) { 
    logger.log({'action' : 'message', 'client' : client.sessionId, 'body' : message});
    var parsedMsg = JSON.parse(message);
    if (parsedMsg.auth_token === AUTH_TOKEN)
        logger.socketLogger = client;
    });
    client.on('disconnect', function() {
        logger.log({'action' : 'disconnect', 'client' : client.sessionId});
    });
});

Running the demo

  1. Clone this repository. Be sure to use the --recursive flag.
  2. Run "node server.js" in the example folder
  3. Open example/client/index.html in your browser
  4. Open example/dashboard/index.html in another windew
  5. Start tying in the client asd watch the dashboard.

Screenshots of demo

Client

Client

Dashboard

Dashboard

Caveats and Notes

This is very very early alpha software with an API that I definitely want to change. Eventually, you won't have to make any explicit log calls at all - socket-logger will just act as a middleware for your Socket.IO server and automatically log incomming connections and messages (something like how Connect or JSGI works). However, you should still have the ability to log whatever custom calls you want too.

Even more eventually, it'd be kind of cool to have the client-side be some kind of web service. Real-time socket-based analytics for all?

License

(The MIT License)

Copyright (c) 2010 Saikat Chakrabarti saikat@gomockingbird.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.