feat(tracing): Add ioredis support

closes #30

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## Unreleased
+ - - Add ioredis instrumentation.
+
 ## 1.32.0
  - Include details about uncaught errors in express handlers.
 

package.json

@@ -62,6 +62,7 @@
  "eslint": "1.7.2",
  "eslint-config-airbnb": "0.1.0",
  "express": "4.14.0",
+ "ioredis": "^3.2.2",
  "kafka-node": "^1.0.7",
  "lodash": "^4.15.0",
  "mocha": "2.3.3",

src/tracing/index.js

@@ -29,6 +29,7 @@ exports.init = function(_config) {
  require('./instrumentation/mysql.js').init(config);
  require('./instrumentation/redis.js').init(config);
  require('./instrumentation/express.js').init(config);
+ require('./instrumentation/ioredis.js').init(config);
  }
  }
 };
@@ -88,6 +89,7 @@ exports.activate = function() {
  require('./instrumentation/kafka.js').activate();
  require('./instrumentation/mysql.js').activate();
  require('./instrumentation/redis.js').activate();
+ require('./instrumentation/ioredis.js').activate();
  require('./instrumentation/express.js').activate();
  }
  }
@@ -104,6 +106,7 @@ exports.deactivate = function() {
  require('./instrumentation/httpServer.js').deactivate();
  require('./instrumentation/httpClient.js').deactivate();
  require('./instrumentation/redis.js').deactivate();
+ require('./instrumentation/ioredis.js').deactivate();
  require('./instrumentation/express.js').deactivate();
  }
 

src/tracing/instrumentation/ioredis.js

@@ -0,0 +1,115 @@
+'use strict';
+
+var shimmer = require('shimmer');
+
+var requireHook = require('../../util/requireHook');
+var transmission = require('../transmission');
+var tracingUtil = require('../tracingUtil');
+var cls = require('../cls');
+
+var isActive = false;
+
+exports.activate = function() {
+ isActive = true;
+};
+
+exports.deactivate = function() {
+ isActive = false;
+};
+
+exports.init = function() {
+ requireHook.on('ioredis', instrument);
+};
+
+
+function instrument(ioredis) {
+ shimmer.wrap(ioredis.prototype, 'sendCommand', instrumentIoredisSendCommand);
+}
+
+function instrumentIoredisSendCommand(original) {
+ return function wrappedInternalSendCommand(command) {
+ var client = this;
+
+ if (command.promise == null ||
+ typeof command.name !== 'string' ||
+ !isActive ||
+ !cls.isTracing()) {
+ return original.apply(this, arguments);
+ }
+
+ var callback;
+ var parentSpan = cls.getCurrentSpan();
+ if (cls.isExitSpan(parentSpan)) {
+ // multi commands could actually be recorded as multiple spans, but we only want to record one
+ // batched span
+ if (parentSpan.n === 'redis' && parentSpan.data.redis.command === 'multi') {
+ var parentSpanSubCommands = parentSpan.data.redis.subCommands = parentSpan.data.redis.subCommands || [];
+ parentSpanSubCommands.push(command.name);
+
+ if (command.name.toLowerCase() === 'exec') {
+ callback = cls.ns.bind(getMultiCommandEndCall(parentSpan));
+ command.promise.then(
+ // make sure that the first parameter is never truthy
+ callback.bind(null, null),
+ callback);
+ }
+ }
+ return original.apply(this, arguments);
+ }
+
+ var span = cls.startSpan('redis');
+ span.stack = tracingUtil.getStackTrace(wrappedInternalSendCommand);
+ span.data = {
+ redis: {
+ connection: client.options.host + ':' + client.options.port,
+ command: command.name.toLowerCase()
+ }
+ };
+
+ callback = cls.ns.bind(onResult);
+ command.promise.then(
+ // make sure that the first parameter is never truthy
+ callback.bind(null, null),
+ callback);
+ return original.apply(this, arguments);
+
+ function onResult(error) {
+ // multi commands are ended by exec. Wait for the exec result
+ if (command.name === 'pipeline') {
+ return;
+ }
+
+ span.d = Date.now() - span.ts;
+
+ if (error) {
+ span.error = true;
+ span.ec = 1;
+ span.data.redis.error = error.message;
+ }
+
+ transmission.addSpan(span);
+ }
+ };
+}
+
+function getMultiCommandEndCall(span) {
+ return function multiCommandEndCallback(error) {
+ span.d = Date.now() - span.ts;
+
+ var subCommands = span.data.redis.subCommands;
+ var commandCount = subCommands ? subCommands.length : 1;
+
+ span.b = {
+ s: commandCount,
+ u: false
+ };
+
+ if (error) {
+ span.error = true;
+ span.ec = commandCount;
+ span.data.redis.error = error.message;
+ }
+
+ transmission.addSpan(span);
+ };
+}