add event to node-dogstatsd

.gitignore

@@ -1 +1,3 @@
 node_modules
+.flowconfig
+flow

README.md

@@ -1,5 +1,7 @@
 # node-dogstatsd
 
+Aaron Brady: A fork of node-dogstatsd to add events. should eventually merge back with that project, just need the module now.
+
 A node.js client for extended StatsD server of [Datadog](http://www.datadoghq.com).
 
 Datadog added new some features(histogram and tags) to their own StatsD implementation.

lib/statsd.js

@@ -1,184 +1,235 @@
-"use strict";
+'use strict';
 
 var dgram = require("dgram");
 var mersenne = require("./mersenne");
 var mt = new mersenne.MersenneTwister19937();
 
 var EPHEMERAL_LIFETIME_MS = 1000;
 
+// http://docs.datadoghq.com/guides/metrics/#tags
+// Tags must start with a letter, and after that may contain alphanumerics, underscores, minuses, 
+// colons, periods and slashes. Other characters will get converted to underscores. Tags can be up
+// to 200 characters long and support unicode. Tags will be converted to lowercase as well.
+function make_str_valid(s) {
+  // leaving uppercase in, letting datadog deal with non letter starting stats
+  return s.replace(/[^-:.A-Za-z0-9]/g,'_');
+}
+
 var Client = function(host, port, socket, options) {
-    this.host = host || "localhost";
-    this.port = port || 8125;
+  this.host = host || "localhost";
+  this.port = port || 8125;
 
-    // optional shared socket
-    this.socket = socket;
+  // optional shared socket
+  this.socket = socket;
 
-    // when a *shared* socked isn't provided, an ephemeral
-    // socket is demand allocated.  This ephemeral socket is closed
-    // after being idle for EPHEMERAL_LIFETIME_MS.
-    this.ephemeral_socket = this.last_used_timer = null;
+  // when a *shared* socked isn't provided, an ephemeral
+  // socket is demand allocated.  This ephemeral socket is closed
+  // after being idle for EPHEMERAL_LIFETIME_MS.
+  this.ephemeral_socket = this.last_used_timer = null;
 
-    options = options || {};
-    this.global_tags = options.global_tags;
+  options = options || {};
+  this.global_tags = options.global_tags;
 };
 
 Client.prototype.timing = function(stat, time, sample_rate, tags) {
-    var self = this;
-    var stats = {};
-    stats[stat] = time + "|ms";
-    self.send(stats, sample_rate, tags);
+  stat = make_str_valid(stat);
+  var self = this;
+  var stats = {};
+  stats[stat] = time + "|ms";
+  self.send(stats, sample_rate, tags);
 };
 
 Client.prototype.increment = function(stats, sample_rate, tags) {
-    var self = this;
-    self.update_stats(stats, 1, sample_rate, tags);
+  var self = this;
+  self.update_stats(stats, 1, sample_rate, tags);
 };
 
 Client.prototype.incrementBy = function(stats, value, tags) {
-    var self = this;
-    if (value === 0) return;
-    self.update_stats(stats, value, undefined, tags);
+  var self = this;
+  if (value === 0) return;
+  self.update_stats(stats, value, undefined, tags);
 };
 
 Client.prototype.decrement = function(stats, sample_rate, tags) {
-    var self = this;
-    self.update_stats(stats, - 1, sample_rate, tags);
+  var self = this;
+  self.update_stats(stats, - 1, sample_rate, tags);
 };
 
 Client.prototype.decrementBy = function(stats, value, tags) {
-    var self = this;
-    if (value === 0) return;
-    self.update_stats(stats, -value, undefined, tags);
+  var self = this;
+  if (value === 0) return;
+  self.update_stats(stats, -value, undefined, tags);
 };
 
 Client.prototype.gauge = function(stat, value, sample_rate, tags) {
-    var self = this;
-    var stats = {};
-    stats[stat] = value + "|g";
-    self.send(stats, sample_rate, tags);
+  var self = this;
+  var stats = {};
+  stats[stat] = value + "|g";
+  self.send(stats, sample_rate, tags);
 };
 
 Client.prototype.histogram = function(stat, value, sample_rate, tags) {
-    var self = this;
-    var stats = {};
-    stats[stat] = value + "|h";
-    self.send(stats, sample_rate, tags);
+  var self = this;
+  var stats = {};
+  stats[stat] = value + "|h";
+  self.send(stats, sample_rate, tags);
 };
 
 Client.prototype.set = function(stat, value, sample_rate, tags) {
-    var self = this;
-    var stats = {};
-    stats[stat] = value + "|s";
-    self.send(stats, sample_rate, tags);
+  var self = this;
+  var stats = {};
+  stats[stat] = value + "|s";
+  self.send(stats, sample_rate, tags);
 };
 
 Client.prototype.update_stats = function(stats, delta, sampleRate, tags) {
-    var self = this;
-    if (typeof(stats) === "string")
-        stats = [stats];
-    if (!delta)
-        delta = 1;
-
-    var data = {};
-    for (var i = 0; i < stats.length; i++)
-        data[stats[i]] = delta + "|c";
-    self.send(data, sampleRate, tags);
+  var self = this;
+  if (typeof(stats) === "string")
+    stats = [stats];
+  if (!delta)
+    delta = 1;
+
+  var data = {};
+  for (var i = 0; i < stats.length; i++)
+    data[make_str_valid(stats[i])] = delta + "|c";
+  self.send(data, sampleRate, tags);
 };
 
 // An internal function update the last time the socket was
 // used.  This function is called when the socket is used
 // and causes demand allocated ephemeral sockets to be closed
 // after a period of inactivity.
 Client.prototype._update_last_used = function () {
-    if (!this.ephemeral_socket)
-        return;
-
-    if (this.last_used_timer)
-        clearTimeout(this.last_used_timer);
-
-    var self = this;
-    this.last_used_timer = setTimeout(function() {
-        if (self.ephemeral_socket)
-            self.ephemeral_socket.close();
-        delete self.ephemeral_socket;
-    }, EPHEMERAL_LIFETIME_MS);
+  if (!this.ephemeral_socket)
+    return;
+
+  if (this.last_used_timer)
+    clearTimeout(this.last_used_timer);
+
+  var self = this;
+  this.last_used_timer = setTimeout(function() {
+    if (self.ephemeral_socket)
+      self.ephemeral_socket.close();
+    delete self.ephemeral_socket;
+  }, EPHEMERAL_LIFETIME_MS);
 };
 
 Client.prototype.send_data = function (buf) {
-    var socket;
-
-    if (!this.socket) {
-        if (!this.ephemeral_socket) {
-            this.ephemeral_socket = dgram.createSocket("udp4");
-            this.ephemeral_socket.on("error", function() {});
-        }
-        socket = this.ephemeral_socket;
-    }
-    else {
-        socket = this.socket;
+  var socket;
+
+  if (!this.socket) {
+    if (!this.ephemeral_socket) {
+      this.ephemeral_socket = dgram.createSocket("udp4");
+      this.ephemeral_socket.on("error", function() {});
     }
+    socket = this.ephemeral_socket;
+  }
+  else {
+    socket = this.socket;
+  }
 
-    this._update_last_used();
+  this._update_last_used();
 
-    socket.send(buf, 0, buf.length, this.port, this.host);
+  socket.send(buf, 0, buf.length, this.port, this.host);
 };
 
-Client.prototype.send = function(data, sample_rate, tags) {
-    if (!tags && Array.isArray(sample_rate)) {
-        tags = sample_rate;
-        sample_rate = undefined;
+function convert_tags_to_array(tags) {
+  if (!tags) {
+    return;
+  }
+  if (Array.isArray(tags)) {
+    return tags;
+  }
+  if (typeof(tags) !== 'object') {
+    return [tags];
+  }
+  var res = [];
+  for (var k in tags) {
+    var v = tags[k];
+    if (typeof(v) === 'object') {
+      v = JSON.stringify(v);
     }
+    res.push(k+':'+v);
+  }
+  return res;
+}
 
-    if (!sample_rate)
-        sample_rate = 1;
-
-    var value;
-    var sampled_data = {};
-    if (sample_rate < 1) {
-        if (mt.genrand_real2(0, 1) <= sample_rate) {
-            for (stat in data) {
-                value = data[stat];
-                sampled_data[stat] = value + "|@" + sample_rate;
-            }
-        }
+Client.prototype.send = function(data, sample_rate, tags) {
+  if (!tags && isNaN(parseFloat(sample_rate)) && !isFinite(sample_rate)) {
+    tags = sample_rate;
+    sample_rate = undefined;
+  }
+  if (tags) {
+    tags = convert_tags_to_array(tags);
+    for (var i = 0; i < tags.length; ++i) {
+      tags[i] = make_str_valid(tags[i]);
     }
-    else
-        sampled_data = data;
+  }
+
+  if (!sample_rate)
+    sample_rate = 1;
+
+  var value;
+  var sampled_data = {};
+  var stat;
+  if (sample_rate < 1) {
+    if (mt.genrand_real2(0, 1) <= sample_rate) {
+      for (stat in data) {
+        value = data[stat];
+        sampled_data[stat] = value + "|@" + sample_rate;
+      }
+    }
+  }
+  else
+    sampled_data = data;
 
-    if (this.global_tags || tags) {
-        var merged_tags = [];
+  if (this.global_tags || tags) {
+    var merged_tags = [];
 
-        if (Array.isArray(this.global_tags))
-          merged_tags = merged_tags.concat(this.global_tags);
+    if (Array.isArray(this.global_tags))
+      merged_tags = merged_tags.concat(this.global_tags);
 
 
-        if (Array.isArray(tags))
-          merged_tags = merged_tags.concat(tags);
+    if (Array.isArray(tags))
+      merged_tags = merged_tags.concat(tags);
 
-        if (merged_tags.length > 0) {
-          var merged_tags_str = merged_tags.join(',');
-          for (stat in sampled_data)
-              sampled_data[stat] = sampled_data[stat] + "|#" + merged_tags_str;
-        }
+    if (merged_tags.length > 0) {
+      var merged_tags_str = merged_tags.join(',');
+      for (stat in sampled_data)
+        sampled_data[stat] = sampled_data[stat] + "|#" + merged_tags_str;
     }
+  }
 
-    for (var stat in sampled_data) {
-        var send_data = stat + ":" + sampled_data[stat];
-        this.send_data(new Buffer(send_data));
-    }
+  for (stat in sampled_data) {
+    var send_data = stat + ":" + sampled_data[stat];
+    this.send_data(new Buffer(send_data));
+  }
+};
+
+Client.prototype.event = function(title, text_opt, tags_opt) {
+  if (typeof(text_opt) == 'object') {
+    tags_opt = text_opt;
+    text_opt = undefined;
+  }
+  var self = this;
+  var text = text_opt || '';
+  var key = '_e{' + title.length + ',' + text.length + '}';
+  var obj = {};
+  obj[key] = title+'|'+text;
+  self.send(obj, undefined, tags_opt);
 };
 
 Client.prototype.close = function() {
-    if (this.socket)
-        this.socket.close();
-    if (this.ephemeral_socket)
-        this.ephemeral_socket.close();
-    if (this.last_used_timer)
-        clearTimeout(this.last_used_timer);
-
-    this.ephemeral_socket =
-    this.last_used_timer =
-    this.socket = null;
+  if (this.socket)
+    this.socket.close();
+  if (this.ephemeral_socket)
+    this.ephemeral_socket.close();
+  if (this.last_used_timer)
+    clearTimeout(this.last_used_timer);
+
+  this.ephemeral_socket =
+  this.last_used_timer =
+  this.socket = null;
 };
 
 exports.StatsD = Client;