refactor(): refactor agent interface

Author: dszakallas

lib/agent/index.js

@@ -12,7 +12,7 @@ var consts = require('../consts')
 var ReservoirSampler = require('./reservoir_sampler')
 
 var REQUEST_ID = 'request-id'
-var SPAN_ID = 'span-id'
+var PARENT_COMM_ID = 'parent-comm-id'
 var MUST_COLLECT_LIMIT = 100
 
 function Agent (options) {
@@ -90,18 +90,18 @@ Agent.prototype.getConfig = function () {
 
 Agent.prototype.serverReceive = function (data) {
   this.totalRequestCount++
-  var spanId = data.spanId
-  var span = this.openSpan(data)
-  var parentId
+  var parentCommId = data.parentCommId
+  var span = this.openSpan(data.requestId)
+  var parentServiceId
 
-  if (!isNaN(data.parentId)) {
-    parentId = parseInt(data.parentId, 10)
+  if (!isNaN(data.parentServiceId)) {
+    parentServiceId = parseInt(data.parentServiceId, 10)
   }
 
   var transportDelay = data.time - data.originTime
 
   this.incomingEdgeMetrics.report({
-    serviceKey: data.parentId,
+    serviceKey: data.parentServiceId,
     protocol: data.protocol,
     transportDelay: transportDelay
   })
@@ -110,29 +110,29 @@ Agent.prototype.serverReceive = function (data) {
     time: data.time || microtime.now(),
     type: Agent.SERVER_RECV,
     data: {
-      rpcId: spanId,
+      rpcId: parentCommId,
       endpoint: data.url,
       method: data.method,
-      parent: parentId,
+      parent: parentServiceId,
       originTime: data.originTime
     }
   })
 }
 
 Agent.prototype.serverSend = function (data) {
-  var spanId = data.spanId
-  var span = this.findSpan(data.id)
+  var parentCommId = data.parentCommId
+  var span = this.findSpan(data.requestId)
 
   if (!span) {
-    debug('span was not found for serverSend - it shouldn\'t happen', data.id, data.spanId)
+    debug('span was not found for serverSend - it shouldn\'t happen', data.requestId, data.parentCommId)
     return
   }
 
   span.events.push({
     time: data.time || microtime.now(),
     type: Agent.SERVER_SEND,
     data: {
-      rpcId: spanId,
+      rpcId: parentCommId,
       statusCode: data.statusCode
     }
   })
@@ -143,11 +143,11 @@ Agent.prototype.serverSend = function (data) {
     this.reservoirSampler.addReturnsSuccess(span)
   }
 
-  delete this.partials[data.id]
+  delete this.partials[data.requestId]
 }
 
 Agent.prototype.clientSend = function (data) {
-  var span = this.findSpan(data.id)
+  var span = this.findSpan(data.requestId)
 
   if (!span) {
     return
@@ -165,7 +165,7 @@ Agent.prototype.clientSend = function (data) {
     assign(event, {
       type: Agent.ERROR,
       data: {
-        rpcId: data.spanId,
+        rpcId: data.childCommId,
         type: data.err.type,
         message: data.err.message,
         raw: data.err.raw
@@ -175,7 +175,7 @@ Agent.prototype.clientSend = function (data) {
     assign(event, {
       type: Agent.CLIENT_SEND,
       data: {
-        rpcId: data.spanId,
+        rpcId: data.childCommId,
         host: data.host,
         endpoint: data.url,
         method: data.method
@@ -195,12 +195,12 @@ Agent.prototype.clientSend = function (data) {
 
   // for now worker requests are not supported, clean them up
   if (!hasServerReceive && hasClientSend) {
-    delete this.partials[data.id]
+    delete this.partials[data.requestId]
   }
 }
 
 Agent.prototype.clientReceive = function (data) {
-  var span = this.findSpan(data.id)
+  var span = this.findSpan(data.requestId)
 
   // report external edges only if service is not instrumented by Trace
   if (typeof data.targetServiceKey === 'undefined') {
@@ -224,15 +224,15 @@ Agent.prototype.clientReceive = function (data) {
     time: data.time,
     type: Agent.CLIENT_RECV,
     data: {
-      rpcId: data.spanId,
+      rpcId: data.childCommId,
       statusCode: data.statusCode
     }
   })
 }
 
 Agent.prototype.onCrash = function (data) {
-  var span = this.findSpan(this.getTransactionId())
-  var spanId = this.getSpanId()
+  var span = this.findSpan(this.getRequestId())
+  var parentCommId = this.getParentCommId()
 
   if (!span) {
     return
@@ -244,7 +244,7 @@ Agent.prototype.onCrash = function (data) {
     time: microtime.now(),
     type: Agent.ERROR,
     data: {
-      rpcId: spanId,
+      rpcId: parentCommId,
       type: 'system-error',
       message: data.stackTrace.message,
       raw: {
@@ -261,9 +261,9 @@ Agent.prototype.onCrash = function (data) {
 }
 
 Agent.prototype.report = function (name, data, error) {
-  var traceId = this.getTransactionId()
-  var spanId = this.getSpanId()
-  var span = this.findSpan(traceId)
+  var requestId = this.getRequestId()
+  var parentCommId = this.getParentCommId()
+  var span = this.findSpan(requestId)
 
   if (!span) {
     return
@@ -276,7 +276,7 @@ Agent.prototype.report = function (name, data, error) {
     assign(event, {
       type: Agent.ERROR,
       data: {
-        rpcId: spanId,
+        rpcId: parentCommId,
         name: name,
         type: 'user-sent-error',
         message: data.message,
@@ -287,7 +287,7 @@ Agent.prototype.report = function (name, data, error) {
     assign(event, {
       type: Agent.USER_SENT,
       data: {
-        rpcId: spanId,
+        rpcId: parentCommId,
         name: name,
         raw: data
       }
@@ -301,7 +301,7 @@ Agent.prototype.report = function (name, data, error) {
 
   if (!isFound) {
     span.events.push(event)
-    this.partials[traceId] = span
+    this.partials[requestId] = span
   } else {
     debug('Already has a user-sent event with the name "%s"', name)
   }
@@ -311,15 +311,15 @@ Agent.prototype.reportError = function (errorName, errorData) {
   this.report(errorName, errorData, true)
 }
 
-Agent.prototype.findSpan = function (transactionId) {
+Agent.prototype.findSpan = function (requestId) {
   var span
   // check if we have a partial with the id
-  if (!transactionId || !this.partials[transactionId] || !this.partials[transactionId].events) {
-    debug('missing transaction', transactionId)
+  if (!requestId || !this.partials[requestId] || !this.partials[requestId].events) {
+    debug('missing transaction', requestId)
     return
   }
 
-  span = this.partials[transactionId]
+  span = this.partials[requestId]
   // check if we had an SR before, if not, discard the span
   var hasServerReceive = span.events.some(function (event) {
     return event.type === Agent.SERVER_RECV
@@ -333,9 +333,7 @@ Agent.prototype.findSpan = function (transactionId) {
   return span
 }
 
-Agent.prototype.openSpan = function (data) {
-  var requestId = data.id
-
+Agent.prototype.openSpan = function (requestId) {
   if (!requestId) {
     return
   }
@@ -350,23 +348,23 @@ Agent.prototype.openSpan = function (data) {
   return this.partials[requestId]
 }
 
-Agent.prototype.setTransactionId = function (value) {
+Agent.prototype.setRequestId = function (value) {
   return this.cls.set(REQUEST_ID, value)
 }
 
-Agent.prototype.getTransactionId = function () {
+Agent.prototype.getRequestId = function () {
   return this.cls.get(REQUEST_ID)
 }
 
-Agent.prototype.setSpanId = function (value) {
-  return this.cls.set(SPAN_ID, value)
+Agent.prototype.setParentCommId = function (value) {
+  return this.cls.set(PARENT_COMM_ID, value)
 }
 
-Agent.prototype.getSpanId = function () {
-  return this.cls.get(SPAN_ID)
+Agent.prototype.getParentCommId = function () {
+  return this.cls.get(PARENT_COMM_ID)
 }
 
-Agent.prototype.clearTransaction = function (requestId) {
+Agent.prototype.clearRequest = function (requestId) {
   delete this.partials[requestId]
 }
 
@@ -378,7 +376,11 @@ Agent.prototype.bindEmitter = function (emitter) {
   return this.cls.bindEmitter(emitter)
 }
 
-Agent.prototype.generateSpanId = function () {
+Agent.prototype.generateCommId = function () {
+  return this.generateId()
+}
+
+Agent.prototype.generateRequestId = function () {
   return this.generateId()
 }