changefeed

node-sdc-changefeed

Provides support for publishing and listening to change feeds in SmartDataCenter / Triton via Node.js libraries and a CLI.

Installation

$ npm install changefeed

Development

Before committing be sure to, at least run:

$ make check      # lint and style checks
$ make test       # run tests

Test

Simple tests (requires a running CoaL) can be run using:

$ make test

CLI

$ changefeedsnoop -h 127.0.0.1 -p 8080 -r vm -s nic,alias | bunyan --color

Setup

Publisher

var mod_bunyan = require('bunyan');
var mod_changefeed = require('changefeed');
var mod_restify = require('restify');

var options = {
    backoff: {
        maxTimeout: Infinity,
        minTimeout: 10,
        retries: Infinity
    },
    log: mod_bunyan.createLogger({
        name: 'publisher_test',
        level: process.env['LOG_LEVEL'] || 'trace',
        stream: process.stderr
    }),
    maxAge: 2000,
    moray: {
        bucketName: 'pub_change_bucket',
        host: '10.99.99.17',
        resolvers: {
            resolvers: ['10.99.99.11']
        },
        timeout: 200,
        minTimeout: 1000,
        maxTimeout: 2000,
        port: 2020
    }
    restifyServer: server,
    resources: resources
};

var publisher = mod_changefeed.createPublisher(options);

Listener

var mod_bunyan = require('bunyan');
var mod_changefeed = require('changefeed');

var options = {
    backoff: {
        maxTimeout: Infinity,
        minTimeout: 10,
        retries: Infinity
    },
    log: mod_bunyan.createLogger({
        name: 'listener_test',
        level: process.env['LOG_LEVEL'] || 'error',
        stream: process.stderr
    }),
    url: 'http://localhost',
    instance: 'uuid goes here',
    service: 'tcns',
    changeKind: {
        resource: 'vm',
        subResources: ['nic', 'alias']
    }
};

var listener = mod_changefeed.createListener(options);

Documentation

Detailed documentation is located at docs/index.md.

See RFD 0005 Triton Change Feed Support for current design and architecture decisions.

License

"node-sdc-changefeed" is licensed under the Mozilla Public License version 2.0. See the file LICENSE.

Changelog

1.1.0

• Switch to using restify-clients for the listener. This is to take advantage of the backoff functionality and built in bunyan tracing.
• The host and port options properties are now deprecated and have been replaced by the url options property. The host and port properties will continue to work, but they will go away in a future version.
• A backoff object has been added as an optional part of the options object. This lets the publisher and listener handle unavailability at init.