Package Exports

polo

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (polo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Polo

Polo is a zero configuration service discovery module written completely in Javascript. It's available through npm:

npm install polo

What problem does it solve?

Polo allows your servers/programs to discover eachother without having to talk to a central server and without the use of any static configuration as long as they are connected to the same local network.

Usage

First create a polo instance:

var polo = require('polo');
var apps = polo();

Now let's add a service to the app repository:

apps.put({
    name:'hello-world', // required - the name of the service
    host:'example.com', // defaults to the network ip of the machine
    port: 8080          // we are listening on port 8080. 
});

If you put multiple services with the same name Polo will load balance them for you by choosing a random service. Now spin up another node process and polo will automatically distribute information about this service:

// in another process
var polo = require('polo');
var apps = polo();

apps.once('up', function(name, service) {           // up fires everytime some service joins
    console.log(apps.get('hello-world'));           // should print out the joining service
    console.log(apps.get('http://{hello-world}/')); // shorthand for formatting the address
                                                    // of a service into a string
});

Additionally there is a down event which fires when a services leaves the repository - it's that easy!

Options

Per default Polo will discover all services running on a network using UDP multicast. When developing it can often be very useful to disable this. To do so either provide multicast: false or set your NODE_ENV=development environment variable

var apps = polo({
    multicast: false // disables network multicast
});

or using development mode from the shell

$ NODE_ENV=development node my-polo-app.js # also disables network multicast

Example

Let's create an HTTP service. Try to run the program below on different machines in the same network:

var http = require('http');
var polo = require('polo');
var apps = polo();

var server = http.createServer(function(req, res) {
    if (req.url !== '/') {
        res.writeHead(404);
        res.end();
        return;
    }

    res.end('hello-http is available at http://'+apps.get('hello-http').address); 
});

server.listen(0, function() {
    var port = server.address().port; // let's find out which port we binded to
    
    apps.put({
        name: 'hello-http',
        port: port
    });

    console.log('visit: http://localhost:'+port);
});