feat(context): use TraceContext in spans and transactions

Author: Stephen Belanger

lib/instrumentation/context.js

@@ -9,17 +9,17 @@ function toHex (buffer) {
 }
 
 class TraceContext {
-  constructor (opts = {}) {
+  constructor ({ version, traceId, id, flags, parentId } = {}) {
     // 1 byte
-    this.version = opts.version
+    this.version = version
     // 16 bytes
-    this.traceId = opts.traceId
+    this.traceId = traceId
     // 8 bytes
-    this.id = opts.id
+    this.id = id
     // 1 byte
-    this.flags = opts.flags
+    this.flags = flags
     // 8 bytes
-    this.parentId = opts.parentId
+    this.parentId = parentId
   }
 
   static create () {

lib/instrumentation/span.js

@@ -2,7 +2,6 @@
 
 var afterAll = require('after-all-results')
 var Value = require('async-value-promise')
-var uuid = require('uuid')
 
 var parsers = require('../parsers')
 var stackman = require('../stackman')
@@ -13,7 +12,7 @@ const TEST = process.env.ELASTIC_APM_TEST
 module.exports = Span
 
 function Span (transaction) {
-  this.id = uuid.v4()
+  this.context = transaction.context.child()
   this.transaction = transaction
   this.started = false
   this.ended = false
@@ -24,6 +23,12 @@ function Span (transaction) {
   this._stackObj = null
   this._agent = transaction._agent
 
+  Object.defineProperty(this, 'id', {
+    get () {
+      return this.context.id.toString('hex')
+    }
+  })
+
   this._agent.logger.debug('init span %o', {id: this.transaction.id})
 }
 
@@ -145,8 +150,11 @@ Span.prototype._encode = function (cb) {
       self._agent.logger.warn('could not capture stack trace for span %o', {id: self.transaction.id, name: self.name, type: self.type, err: err.message})
     }
 
+    var context = self.context.toJSON()
+
     var payload = {
-      id: self.id,
+      id: context.id,
+      traceId: context.traceId,
       transactionId: self.transaction.id,
       timestamp: self.transaction.timestamp,
       name: self.name,

lib/instrumentation/transaction.js

@@ -1,9 +1,9 @@
 'use strict'
 
 var truncate = require('unicode-byte-truncate')
-var uuid = require('uuid')
 
 var config = require('../config')
+var TraceContext = require('./context')
 var getPathFromRequest = require('./express-utils').getPathFromRequest
 var parsers = require('../parsers')
 var Span = require('./span')
@@ -58,7 +58,13 @@ function Transaction (agent, name, type) {
     }
   })
 
-  this.id = uuid.v4()
+  Object.defineProperty(this, 'id', {
+    get () {
+      return this.context.id.toString('hex')
+    }
+  })
+
+  this.context = TraceContext.create()
   this._defaultName = name || ''
   this._customName = ''
   this._user = null

test/instrumentation/index.js

@@ -24,7 +24,7 @@ test('basic', function (t) {
     t.equal(data.spans.length, 4)
 
     data.transactions.forEach(function (trans, index) {
-      t.ok(/[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}/.test(trans.id))
+      t.ok(/[\da-f]{16}/.test(trans.id))
       t.equal(trans.name, 'foo' + index)
       t.equal(trans.type, 'bar' + index)
       t.ok(trans.duration > 0, 'duration should be >0ms')
@@ -374,7 +374,7 @@ test('unsampled transactions do not include spans', function (t) {
     t.equal(data.transactions.length, 1)
 
     data.transactions.forEach(function (trans) {
-      t.ok(/[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}/.test(trans.id))
+      t.ok(/[\da-f]{16}/.test(trans.id))
       t.ok(trans.duration > 0, 'duration should be >0ms')
       t.ok(trans.duration < 100, 'duration should be <100ms')
       t.notOk(Number.isNaN((new Date(trans.timestamp)).getTime()))

test/instrumentation/modules/http2.js

@@ -340,7 +340,8 @@ isSecure.forEach(secure => {
   })
 })
 
-var matchId = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
+// var matchId = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
+var matchId = /^[0-9a-f]{16}/
 var matchTimestamp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$/
 
 function assertPath (t, trans, secure, port, path) {

test/instrumentation/span.js

@@ -108,7 +108,7 @@ test('#_encode() - ended unnamed', function myTest1 (t) {
   span.end()
   span._encode(function (err, payload) {
     t.error(err)
-    t.deepEqual(Object.keys(payload), ['id', 'transactionId', 'timestamp', 'name', 'type', 'start', 'duration', 'stacktrace'])
+    t.deepEqual(Object.keys(payload), ['id', 'traceId', 'transactionId', 'timestamp', 'name', 'type', 'start', 'duration', 'stacktrace'])
     t.equal(typeof payload.id, 'string')
     t.equal(payload.id, span.id)
     t.equal(payload.transactionId, trans.id)
@@ -130,7 +130,7 @@ test('#_encode() - ended named', function myTest2 (t) {
   span.end()
   span._encode(function (err, payload) {
     t.error(err)
-    t.deepEqual(Object.keys(payload), ['id', 'transactionId', 'timestamp', 'name', 'type', 'start', 'duration', 'stacktrace'])
+    t.deepEqual(Object.keys(payload), ['id', 'traceId', 'transactionId', 'timestamp', 'name', 'type', 'start', 'duration', 'stacktrace'])
     t.equal(payload.transactionId, trans.id)
     t.equal(payload.timestamp, trans.timestamp)
     t.notOk(Number.isNaN(Date.parse(payload.timestamp)))
@@ -152,7 +152,7 @@ test('#_encode() - disabled stack traces', function (t) {
   span.end()
   span._encode(function (err, payload) {
     t.error(err)
-    t.deepEqual(Object.keys(payload), ['id', 'transactionId', 'timestamp', 'name', 'type', 'start', 'duration'])
+    t.deepEqual(Object.keys(payload), ['id', 'traceId', 'transactionId', 'timestamp', 'name', 'type', 'start', 'duration'])
     t.equal(payload.transactionId, trans.id)
     t.equal(payload.timestamp, trans.timestamp)
     t.notOk(Number.isNaN(Date.parse(payload.timestamp)))