[#233] Support SpanChunk and AsyncSpanChunk

* Implement TraceRoot class for tracing functionality * Support SpanChunk and AsyncSpanChunk * Support ChildTrace * Fix node@16 test failure
pinpoint-apm · Dec 8, 2024 · ccdc0ec · ccdc0ec
1 parent 63736d7
commit ccdc0ec
Show file tree

Hide file tree

Showing 83 changed files with 1,866 additions and 1,590 deletions.
diff --git a/lib/agent.js b/lib/agent.js
@@ -67,7 +67,7 @@ class Agent {
   }
 
   createTraceObject(requestData) {
-    return this.traceContext.makeTrace(requestData)
+    return this.traceContext.newTraceObject2()
   }
 
   currentTraceObject() {
@@ -79,7 +79,15 @@ class Agent {
   }
 
   createAgentInfo(config, agentStartTime) {
-    return AgentInfo.create(config, agentStartTime)
+    return AgentInfo.create(config, '' + agentStartTime)
+  }
+
+  getAgentInfo() {
+    return this.agentInfo
+  }
+
+  getTraceContext() {
+    return this.traceContext
   }
 
   startSchedule(agentId, agentStartTime) {
@@ -91,6 +99,11 @@ class Agent {
     }
     this.pingScheduler = new PinScheduler(this.dataSender)
   }
+
+  shutdown() {
+    this.mainScheduler?.stop()
+    this.pingScheduler?.stop()
+  }
 }
 
 module.exports = Agent
diff --git a/lib/client/data-sender-factory.js b/lib/client/data-sender-factory.js
@@ -9,9 +9,8 @@
 const GrpcDataSender = require('./grpc-data-sender')
 const DataSender = require('./data-sender')
 
-let dataSender
 const create = (config, agentInfo) => {
-  dataSender = new DataSender(config, new GrpcDataSender(
+  const dataSender = new DataSender(config, new GrpcDataSender(
     config.collectorIp,
     config.collectorTcpPort,
     config.collectorStatPort,
@@ -22,11 +21,6 @@ const create = (config, agentInfo) => {
   return dataSender
 }
 
-const setDataSender = (sender) => {
-  dataSender = sender
-}
-
 module.exports = {
   create,
-  setDataSender
 }
diff --git a/lib/client/data-sender.js b/lib/client/data-sender.js
@@ -17,6 +17,7 @@ const SqlUidMetaData = require('./sql-uid-meta-data')
 
 class DataSender {
   constructor(config, dataSender) {
+    this.config = config
     this.enabledDataSending = config.enabledDataSending
     this.dataSender = dataSender
   }
@@ -46,8 +47,12 @@ class DataSender {
       this.dataSender.sendStringMetaInfo(data)
     } else if (data instanceof Span) {
       this.dataSender.sendSpan(data)
+    } else if (data?.isSpan?.()) {
+      this.dataSender.sendSpan(data)
     } else if (data instanceof SpanChunk) {
       this.dataSender.sendSpanChunk(data)
+    } else if (data?.isAsyncSpanChunk?.()) {
+      this.dataSender.sendSpanChunk(data)
     } else if (data instanceof SqlMetaData) {
       this.dataSender.sendSqlMetaInfo(data)
     } else if (data instanceof SqlUidMetaData) {
@@ -75,7 +80,7 @@ class DataSender {
 
   // TODO Remove it after implementing grpc
   sendActiveThreadCountRes() {
-    
+
   }
 }
 

diff --git a/lib/client/grpc-data-sender.js b/lib/client/grpc-data-sender.js
@@ -316,7 +316,7 @@ class GrpcDataSender {
 
   sendSpan(span) {
     try {
-      const pSpan = span.spanMessage
+      const pSpan = span.toProtocolBuffer()
       if (log.isDebug()) {
         log.debug(`sendSpan pSpan: ${pSpan}`)
       }
@@ -330,7 +330,7 @@ class GrpcDataSender {
 
   sendSpanChunk(spanChunk) {
     try {
-      const pSpanChunk = spanChunk.spanMessage
+      const pSpanChunk = spanChunk.toProtocolBuffer()
       if (log.isDebug()) {
         log.debug(`sendSpanChunk spanChunk: ${JSON.stringify(spanChunk)}`)
       }

diff --git a/lib/context/async-id.js b/lib/context/async-id.js
@@ -7,6 +7,7 @@
 'use strict'
 
 const SequenceGenerator = require('./sequence-generator')
+const spanMessages = require('../data/v1/Span_pb')
 
 // ref: DefaultAsyncId.java
 class AsyncId {
@@ -43,11 +44,22 @@ class AsyncId {
 
   sequenceNextLocalAsyncId() {
     if (this === AsyncId.nonAsyncId) {
-      return this.nextLocalAsyncId() 
+      return this.nextLocalAsyncId()
     }
 
     return new AsyncId(this.asyncId, this.sequence + 1)
   }
+
+  toProtocolBuffer() {
+    const pLocalAsyncId = new spanMessages.PLocalAsyncId()
+    pLocalAsyncId.setAsyncid(this.getAsyncId())
+    pLocalAsyncId.setSequence(this.getSequence())
+    return pLocalAsyncId
+  }
+
+  tosString() {
+    return `AsyncId(asyncId=${this.asyncId}, sequence=${this.sequence})`
+  }
 }
 
 module.exports = AsyncId
diff --git a/lib/context/disable-span-event-recorder.js b/lib/context/disable-span-event-recorder.js
@@ -6,6 +6,8 @@
 
 'use strict'
 
+const disableAsyncId = require('./trace/disable-async-id')
+
 class DisableSpanEventRecorder {
   constructor() {
     this.nextAsyncId = null
@@ -59,7 +61,8 @@ class DisableSpanEventRecorder {
     this.ended = true
   }
 
-  getLocalAsyncId() {
+  getNextAsyncId() {
+    return disableAsyncId
   }
 }
 

diff --git a/lib/context/disable-span-recorder.js b/lib/context/disable-span-recorder.js
@@ -21,9 +21,13 @@ class DisableSpanRecorder {
 
     recordEndPoint() {}
 
-    recordRemoteAddr() {}
+    recordRemoteAddress() {}
 
     recordException() {}
+
+    recordAcceptorHost() {}
+
+    recordParentApplication() {}
 }
 
 module.exports = DisableSpanRecorder
diff --git a/lib/context/disable-trace.js b/lib/context/disable-trace.js
@@ -16,25 +16,23 @@ class DisableTrace {
         this.spanRecorder = new DisableSpanRecorder()
     }
 
-    getTraceRoot() {
-        return this.traceRoot
-    }
 
     traceBlockBegin() {
         return new DisableSpanEventRecorder()
     }
 
     traceBlockEnd() {}
 
-    completeSpanEvent() {
+    getSpanRecorder() {
+        return this.spanRecorder
     }
 
-    canSampled() {
-        return false
+    getTraceRoot() {
+        return this.traceRoot
     }
 
-    getStartTime() {
-        return 0
+    canSampled() {
+        return false
     }
 
     close() {

diff --git a/lib/context/remote-trace-root-builder.js b/lib/context/remote-trace-root-builder.js
@@ -6,17 +6,13 @@
 
 'use strict'
 
-const TraceRootBuilder = require('./trace-root-builder')
+const TraceRoot = require('./trace/trace-root')
 const TraceIdBuilder = require('./trace/trace-id-builder')
 
-class RemoteTraceRoot {
-    constructor(traceId, traceRoot) {
+class RemoteTraceRoot extends TraceRoot {
+    constructor(traceId, agentId, transactionId) {
+        super(agentId, Date.now(), transactionId)
         this.traceId = traceId
-        this.traceRoot = traceRoot
-    }
-
-    getTraceStartTime() {
-        return this.traceRoot.getTraceStartTime()
     }
 
     isSampled() {
@@ -26,6 +22,10 @@ class RemoteTraceRoot {
     getTraceId() {
         return this.traceId
     }
+
+    toString() {
+        return `RemoteTraceRoot{traceId=${this.traceId.toString()}, ${super.toString()}}`
+    }
 }
 
 class RemoteTraceRootBuilder {
@@ -46,11 +46,11 @@ class RemoteTraceRootBuilder {
     build() {
         const agentId = this.agentInfo.getAgentId()
         if (this.isNewTraceRoot()) {
-            const traceId = new TraceIdBuilder(this.agentInfo, this.transactionId).build()
-            return new RemoteTraceRoot(traceId, new TraceRootBuilder(agentId, this.transactionId).build())
+            const traceId = new TraceIdBuilder(this.agentInfo.getAgentId(), this.agentInfo.getAgentStartTime(), this.transactionId).build()
+            return new RemoteTraceRoot(traceId, agentId, this.transactionId)
         }
 
-        return new RemoteTraceRoot(this.traceId, new TraceRootBuilder(agentId, this.transactionId).build())
+        return new RemoteTraceRoot(this.traceId, agentId, this.transactionId)
     }
 
     isNewTraceRoot() {

diff --git a/lib/context/span-builder.js b/lib/context/span-builder.js
@@ -6,6 +6,7 @@
 
 'use strict'
 
+const spanMessages = require('../data/v1/Span_pb')
 class Span {
     constructor(traceRoot) {
         this.traceRoot = traceRoot
@@ -14,6 +15,57 @@ class Span {
     isSpan() {
         return true
     }
+
+    toProtocolBuffer() {
+        const pSpanMessage = new spanMessages.PSpanMessage()
+        const pSpan = new spanMessages.PSpan()
+        pSpan.setVersion(1)
+
+        const pTransactionId = this.traceRoot.getTraceId().toProtocolBuffer()
+        pSpan.setTransactionid(pTransactionId)
+
+        pSpan.setSpanid(this.traceRoot.getTraceId().getSpanId())
+        pSpan.setParentspanid(this.traceRoot.getTraceId().getParentSpanId())
+        pSpan.setStarttime(this.startTime)
+        pSpan.setElapsed(this.elapsedTime)
+        pSpan.setApiid(this.apiId)
+        pSpan.setServicetype(this.serviceType)
+
+        const pAcceptEvent = new spanMessages.PAcceptEvent()
+        pAcceptEvent.setRpc(this.rpc)
+        pAcceptEvent.setEndpoint(this.endPoint ?? 'UNKNOWN')
+        pAcceptEvent.setRemoteaddr(this.remoteAddress ?? 'UNKNOWN')
+
+        const pParentInfo = new spanMessages.PParentInfo()
+        if (this.parentApplicationType) {
+            pParentInfo.setParentapplicationtype(this.parentApplicationType)
+        }
+        if (this.parentApplicationName) {
+            pParentInfo.setParentapplicationname(this.parentApplicationName)
+        }
+        if (this.acceptorHost) {
+            pParentInfo.setAcceptorhost(this.acceptorHost)
+        }
+        pAcceptEvent.setParentinfo(pParentInfo)
+        pSpan.setAcceptevent(pAcceptEvent)
+
+        pSpan.setFlag(this.traceRoot.getTraceId().getFlags())
+
+        if (this.traceRoot.hasErrorCode()) {
+            pSpan.setErr(this.traceRoot.getShared().getErrorCode())
+        }
+
+        if (this.applicationServiceType) {
+            pSpan.setApplicationservicetype(this.applicationServiceType)
+        }
+        // TODO: SpanMessageMapperImpl.java: spanTraceRootSharedLoggingInfo loggingTransactionInfo
+
+        this.spanEventList.forEach(spanEvent => pSpan.addSpanevent(spanEvent.toProtocolBuffer()))
+        this.annotations.forEach(annotation => pSpan.addAnnotation(annotation.pAnnotation()))
+
+        pSpanMessage.setSpan(pSpan)
+        return pSpanMessage
+    }
 }
 
 class SpanBuilder {
@@ -23,6 +75,15 @@ class SpanBuilder {
         this.startTime = traceRoot.getTraceStartTime()
     }
 
+    setServiceType(serviceType) {
+        this.serviceType = serviceType
+        return this
+    }
+
+    getStartTime() {
+        return this.startTime
+    }
+
     setApiId(apiId) {
         this.apiId = apiId
         return this
@@ -72,9 +133,26 @@ class SpanBuilder {
         return this.traceRoot
     }
 
+    setSpanEventList(spanEventList) {
+        this.spanEventList = spanEventList
+        return this
+    }
+
+    setApplicationServiceType(applicationServiceType) {
+        this.applicationServiceType = applicationServiceType
+        return this
+    }
+
+    markAfterTime() {
+        this.elapsedTime = Date.now() - this.startTime
+        return this
+    }
+
     build() {
         const span = new Span(this.traceRoot)
-        this.startTime = this.startTime || Date.now()
+        span.serviceType = this.serviceType
+        span.startTime = this.startTime || Date.now()
+        span.elapsedTime = this.elapsedTime
         span.apiId = this.apiId
         span.rpc = this.rpc
         span.endPoint = this.endPoint
@@ -84,6 +162,8 @@ class SpanBuilder {
         span.acceptorHost = this.acceptorHost
         span.parentApplicationName = this.parentApplicationName
         span.parentApplicationType = this.parentApplicationType
+        span.spanEventList = this.spanEventList ?? []
+        span.applicationServiceType = this.applicationServiceType
         return span
     }
 }