feat(metrics): Added additional user info on statsd messages

Author: vbudhram

lib/metrics/statsd.js

@@ -3,10 +3,37 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 var StatsD = require('node-statsd')
+var uaParser = require('ua-parser')
 
 var STATSD_PREFIX = 'fxa.auth.'
 var TIMING_SUFFIX = '.time'
 
+function getGenericTags(info) {
+  var tags = []
+  if (info.userAgent) {
+    var agent = uaParser.parse(info.userAgent)
+    if (agent) {
+      if (agent.ua) {
+        tags = tags.concat([
+            'agent_ua_family:' + agent.ua.family, // -> "Safari"
+            'agent_ua_version:' + agent.ua.toVersionString(), // -> "5.0.1"
+            'agent_ua_version_major:' + agent.ua.major // -> "5"
+        ])
+      }
+
+      if (agent.os) {
+        tags = tags.concat([
+            'agent_os_version:' + agent.os.toVersionString(), // -> "5.1"
+            'agent_os_family:' + agent.os.family, // -> "iOS"
+            'agent_os_major:' + agent.os.major // -> "5"
+        ])
+      }
+    }
+  }
+
+  return tags
+}
+
 function StatsDCollector(log) {
   if (! log) {
     throw new Error('Log is required')
@@ -53,7 +80,8 @@ StatsDCollector.prototype = {
    * @param {Object} info
    */
   write: function (info) {
-    this.increment(info.event)
+    var tags = getGenericTags(info)
+    this.increment(info.event, tags)
   },
 
   increment: function (name, tags) {

test/local/statsd_tests.js

@@ -51,7 +51,8 @@ test(
           t.equal(name, 'fxa.auth.some-event')
           t.equal(value, 1)
           t.ok(sampleRate)
-          t.notOk(tags)
+          t.equal(Array.isArray(tags), true)
+          t.equal(tags.length, 0)
           t.end()
         }
       }
@@ -67,6 +68,40 @@ test(
   }
 )
 
+test(
+  'statsd write with tags',
+  function (t) {
+    function StatsDMock() {
+      return {
+        socket: {},
+        increment: function (name, value, sampleRate, tags) {
+          t.equal(name, 'fxa.auth.some-event')
+          t.equal(value, 1)
+          t.ok(sampleRate)
+          t.deepEquals(tags, [
+              'agent_ua_family:Firefox',
+              'agent_ua_version:43.0',
+              'agent_ua_version_major:43',
+              'agent_os_version:10.11',
+              'agent_os_family:Mac OS X',
+              'agent_os_major:10'
+          ])
+          t.end()
+        }
+      }
+    }
+
+    var statsd = new StatsDCollector(mockLog)
+    statsd.init()
+    statsd.client = new StatsDMock()
+    statsd.write({
+      event: 'some-event',
+      uid: 'id',
+      userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:43.0) Gecko/20100101 Firefox/43.0'
+    })
+  }
+)
+
 test(
   'statsd write via log.increment',
   function (t) {
@@ -77,7 +112,8 @@ test(
           t.equal(name, 'fxa.auth.some-event')
           t.equal(value, 1)
           t.ok(sampleRate)
-          t.notOk(tags)
+          t.equal(Array.isArray(tags), true)
+          t.equal(tags.length, 0)
           t.end()
         }
       }
@@ -191,5 +227,3 @@ test(
     t.end()
   }
 )
-
-