unitech / godot

Godot is a streaming real-time event processor based on Riemann written in Node.js

godot -- AS : producer patch for dynamic metrics

• Ext Doc

Example for cpu client/server

client.js

var os = require('os');
var godot = require('godot');

godot.createClient({
    type: 'udp',
    producers: [
        // Producer which send loadavg of cpu 1 each sec
    	godot.producer({
	    host: 'app.server.com',
	    description : 'Main root server',
	    service: 'cpu',
	    metric : function() {
		return os.loadavg()[0] * 100
	    },
	    ttl: 1000
	}),
	// Producer for heartbeat
	godot.producer({
            host: 'app.server.com',
            service: 'app.server/health/heartbeat',
            ttl: 1000
      })
    ]
}).connect(1337);

server.js

var godot = require('godot');

var a = godot.createServer({
    type: 'udp',
    reactors: [
        // Reactor will print to console if cpu1 > 10
	godot.reactor()
	    .where('service', 'cpu')
	    .over(10)
	    .console(),
	// Reactor will print if the client is out
	godot.reactor()
	    .where('service', '*/health/heartbeat')
	    .expire(1000)
	    .console()	
    ]
}).listen(1337);

Notes

• email module use sendgrid
• original producer file is static

---

Official doc

Godot is a streaming real-time event processor based on Riemann written in Node.js

• Usage
• Events
• Reactors
  • Primatives
• Producers
• Tests

Usage

Here is a simple example of a Reactor server that will send an email to [email protected] if the Producer server for app.server fails to send a heartbeat after 60 seconds.

  var godot = require('../lib/godot');

  //
  // Reactor server which will email `[email protected]`
  // whenever any service matching /.*\/health\/heartbeat/
  // fails to check in after 60 seconds.
  //
  godot.createServer({
    //
    // Defaults to UDP
    //
    type: 'udp',
    reactors: [
      godot.reactor()
        .where('service', '*/health/heartbeat')
        .expire(1000 * 60)
        .email({ to: '[email protected]' })
    ]
  }).listen(1337);

  //
  // Producer client which sends events for the service
  // `app.server/health/heartbeat` every 15 seconds.
  //
  godot.createClient({
    //
    // Defaults to UDP
    //
    type: 'udp',
    producers: [
      godot.producer({
        host: 'app.server.com',
        service: 'app.server/health/heartbeat',
        ttl: 1000 * 15
      })
    ]
  }).connect(1337);

Events

Similar to Riemann, events in godot are simply JSON sent over UDP or TCP. Each event has these optional fields:

  {
    host:         "A hostname, e.g. 'api1', 'foo.com'"
    service:      "e.g. 'API port 8000 reqs/sec'",
    state:        "Any string less than 255 bytes, e.g. 'ok', 'warning', 'critical'",
    time:         "The time of the event, in unix epoch seconds",
    description:  "Freeform text",
    tags:         "Freeform list of strings, e.g. ['rate', 'fooproduct', 'transient']"
    metric:       "A number associated with this event, e.g. the number of reqs/sec."
    ttl:          "A floating-point time, in seconds, that this event is considered valid for."
  }

Reactors

Reactors in Godot are readable and writable Stream instances which consume Events and produce actions or aggregate data flow.

Primatives

There are several core Reactor primatives available in godot which can be composed to create more complex behavior:

• .aggregate(): Aggregates metric property on events
• .change(key0, key1, ...): Emits events in which any of key0 ... keyN have changed.
• .email(options): Sends an email to the specified options.
• .expire(ttl): Emits an event when no data is received after ttl milliseconds.
• .forward(options): Forwards all events to a remote server located at options.host and options.port.
• .sms(options): Sends an sms to the specified options.
• .where(key, value)|.where(filters): Filters events based on a single key:value pair or a set of key:value filters.

Producers

Producers in Godot are readable Stream instances which produce Events. Events will be emitted by a given Producer every ttl milliseconds.

Tests

All tests are written in vows and can be run with npm:

  npm test

Copyright (C) 2012. Nodejitsu Inc.