[pinpoint-apm#253] Support async spanEvent tracing after ChildTrace c…

…losed [pinpoint-apm#251] Fix SQL-ID not found sqlId:1 bug * GrpcDataSender fixtures close resources * Functional Test port number * spanChunk Trace by asyncId
feelform · Dec 26, 2024 · 0232239 · 0232239
1 parent 9adf4d7
commit 0232239
Show file tree

Hide file tree

Showing 23 changed files with 358 additions and 302 deletions.
diff --git a/lib/agent.js b/lib/agent.js
@@ -11,6 +11,7 @@ const TraceContext = require('./context/trace-context')
 const log = require('./utils/logger')
 const stringMetaService = require('./context/string-meta-service')
 const apiMetaService = require('./context/api-meta-service')
+const sqlMetadataService = require('./instrumentation/sql/sql-metadata-service')
 const Scheduler = require('./utils/scheduler')
 const AgentStatsMonitor = require('./metric/agent-stats-monitor')
 const { initializeConfig, getConfig } = require('./config')
@@ -37,14 +38,13 @@ class Agent {
     const agentStartTime = Date.now()
     this.agentInfo = this.createAgentInfo(this.config, agentStartTime)
 
-    this.initializeDataSender()
-    this.initializePinpointClient()
+    const dataSender = this.makeDataSender()
+    this.dataSender = dataSender
+    this.initializeDataSender(dataSender)
+    this.initializePinpointClient(dataSender)
 
     this.traceContext = new TraceContext(this.agentInfo, this.dataSender, this.config)
 
-    stringMetaService.init(this.dataSender)
-    apiMetaService.init(this.dataSender)
-
     this.startSchedule(agentId, agentStartTime)
     this.initializeSupportModules()
 
@@ -53,17 +53,23 @@ class Agent {
     log.warn('[Pinpoint Agent][' + agentId + '] Init Completed')
   }
 
-  initializeDataSender() {
-    this.dataSender = dataSenderFactory.create(this.config, this.agentInfo)
-    this.dataSender.send(this.agentInfo)
+  makeDataSender() {
+    return dataSenderFactory.create(this.config, this.agentInfo)
+  }
+
+  initializeDataSender(dataSender) {
+    dataSender.send(this.agentInfo)
+    stringMetaService.init(dataSender)
+    apiMetaService.init(dataSender)
+    sqlMetadataService.setDataSender(dataSender)
   }
 
   initializeSupportModules() {
     this.moduleHook = new ModuleHook(this)
   }
 
-  initializePinpointClient() {
-    this.pinpointClient = new PinpointClient(this.config, this.agentInfo, this.dataSender)
+  initializePinpointClient(dataSender) {
+    this.pinpointClient = new PinpointClient(this.config, this.agentInfo, dataSender)
   }
 
   createTraceObject(requestData) {

diff --git a/lib/client/data-sender-factory.js b/lib/client/data-sender-factory.js
@@ -10,15 +10,14 @@ const GrpcDataSender = require('./grpc-data-sender')
 const DataSender = require('./data-sender')
 
 const create = (config, agentInfo) => {
-  const dataSender = new DataSender(config, new GrpcDataSender(
+  return new DataSender(config, new GrpcDataSender(
     config.collectorIp,
     config.collectorTcpPort,
     config.collectorStatPort,
     config.collectorSpanPort,
     agentInfo,
     config
   ))
-  return dataSender
 }
 
 module.exports = {

diff --git a/lib/client/pinpoint-client.js b/lib/client/pinpoint-client.js
@@ -7,7 +7,6 @@
 'use strict'
 
 const CommandType = require('../constant/commaned-type').CommandType
-const log = require('../utils/logger')
 
 class PinpointClient {
   constructor(config, agentInfo, dataSender) {

diff --git a/lib/context/disable-trace.js b/lib/context/disable-trace.js
@@ -14,11 +14,12 @@ class DisableTrace {
     constructor(traceRoot) {
         this.traceRoot = traceRoot
         this.spanRecorder = new DisableSpanRecorder()
+        this.spanEventRecorder = new DisableSpanEventRecorder()
     }
 
 
     traceBlockBegin() {
-        return new DisableSpanEventRecorder()
+        return this.spanEventRecorder
     }
 
     traceBlockEnd() {}

diff --git a/lib/context/span-event-recorder.js b/lib/context/span-event-recorder.js
@@ -11,7 +11,7 @@ const StringMetaService = require('./string-meta-service')
 const AsyncId = require('./async-id')
 const AnnotationKeyUtils = require('./annotation-key-utils')
 const log = require('../utils/logger')
-const sqlMetaDataService = require('../instrumentation/sql/sql-metadata-service')
+const sqlMetadataService = require('../instrumentation/sql/sql-metadata-service')
 const Annotations = require('../instrumentation/context/annotation/annotations')
 
 // https://github.com/pinpoint-apm/pinpoint/blob/master/bootstraps/bootstrap-core/src/main/java/com/navercorp/pinpoint/bootstrap/context/SpanEventRecorder.java
@@ -157,7 +157,7 @@ class SpanEventRecorder {
       return
     }
 
-    const parsingResult = sqlMetaDataService.cacheSql(sql)
+    const parsingResult = sqlMetadataService.cacheSql(sql)
     this.recordSqlParsingResult(parsingResult, bindString)
     return parsingResult
   }

diff --git a/lib/context/trace/child-trace-builder.js b/lib/context/trace/child-trace-builder.js
@@ -29,19 +29,20 @@ class ChildTraceBuilder {
     }
 
     traceBlockBegin(stackId = StackId.default) {
-        if (this.closed) {
-            return SpanEventRecorder.nullObject(this.traceRoot)
-        }
-
         return this.callStack.makeSpanEventRecorder(stackId)
     }
 
     traceBlockEnd(spanEventRecorder) {
         if (this.closed) {
-            return
+            // If ChildTraceBuilder is closed, aync spanEvent was popped in the previous call.
+            // So, increase the depth of the next spanEvent.
+            const spanEventBuilder = spanEventRecorder.getSpanEventBuilder()
+            spanEventBuilder.setDepth(spanEventBuilder.getDepth() + 1)
         }
-
         this.endSpanEventBuilder(spanEventRecorder.getSpanEventBuilder())
+        if (this.closed) {
+            this.repository.flush()
+        }
     }
 
     endSpanEventBuilder(builder) {

diff --git a/lib/context/trace/disable-child-trace.js b/lib/context/trace/disable-child-trace.js
@@ -22,6 +22,10 @@ class DisableChildTrace {
 
   traceBlockEnd() {}
 
+  getSpanRecorder() {
+    return this.spanRecorder
+  }
+
   getTraceRoot() {
     return this.traceRoot
   }

diff --git a/lib/context/trace/span-event-builder.js b/lib/context/trace/span-event-builder.js
@@ -113,6 +113,10 @@ class SpanEventBuilder {
         return this
     }
 
+    getDepth() {
+        return this.depth
+    }
+
     getStartTime() {
         return this.startTime
     }

diff --git a/lib/context/trace/span-event-recorder2.js b/lib/context/trace/span-event-recorder2.js
@@ -11,7 +11,7 @@ const Annotations = require('../../instrumentation/context/annotation/annotation
 const SpanEventBuilder = require('./span-event-builder')
 const log = require('../../utils/logger')
 const AnnotationKeyUtils = require('../annotation-key-utils')
-const sqlMetaDataService = require('../../instrumentation/sql/sql-metadata-service')
+const sqlMetadataService = require('../../instrumentation/sql/sql-metadata-service')
 const stringMetaService = require('../string-meta-service')
 const AsyncId = require('../async-id')
 
@@ -127,7 +127,7 @@ class SpanEventRecorder {
             return
         }
 
-        const parsingResult = sqlMetaDataService.cacheSql(sql)
+        const parsingResult = sqlMetadataService.cacheSql(sql)
         this.recordSqlParsingResult(parsingResult, bindString)
         return parsingResult
     }

diff --git a/lib/instrumentation/instrument-arrow-function.js b/lib/instrumentation/instrument-arrow-function.js
@@ -9,6 +9,7 @@
 const shimmer = require('@pinpoint-apm/shimmer')
 const HookFunctionArguments = require('./hook-function-arguments')
 const localStorage = require('./context/local-storage')
+// const log = require('../utils/logger')
 
 // ref: SpanEventSimpleAroundInterceptorForPlugin.java
 class InstrumentArrowFunction {
@@ -65,6 +66,13 @@ class InstrumentArrowFunction {
                     return original.apply(this, arguments)
                 }
 
+                // if (log.isInfo()) {
+                //     if (typeof method !== 'symbol') {
+                //         log.info(`target: ${JSON.stringify(target)}, method: ${method}, original: ${original} InstrumentArrowFunction.addChildTraceInterceptor`)
+                //     } else {
+                //         log.info(`target: ${JSON.stringify(target)}, symbol method, original: ${original} InstrumentArrowFunction.addChildTraceInterceptor`)
+                //     }
+                // }
                 const childTraceBuilder = traceContext.continueAsyncContextTraceObject(trace.getTraceRoot(), asyncId.nextLocalAsyncId2())
                 return localStorage.run(childTraceBuilder, () => {
                     const result = original.apply(this, arguments)

diff --git a/lib/instrumentation/sql/sql-metadata-service.js b/lib/instrumentation/sql/sql-metadata-service.js
@@ -8,17 +8,13 @@ const SimpleCache = require('../../utils/simple-cache')
 const SqlParser = require('./sql-parser')
 const ParsingResult = require('./parsing-result')
 
-class SqlMetaDataService {
+class SqlMetadataService {
     constructor() {
         this.cache = new SimpleCache(1024)
     }
 
-    set dataSender(dataSender) {
-        this._dataSender = dataSender
-    }
-
-    get dataSender() {
-        return this._dataSender
+    setDataSender(dataSender) {
+        this.dataSender = dataSender
     }
 
     cacheSql(sql) {
@@ -38,10 +34,8 @@ class SqlMetaDataService {
     }
 
     send(sqlMetaData) {
-        if (this.dataSender && typeof this.dataSender.send === 'function') {
-            this.dataSender.send(sqlMetaData)
-        }
+        this.dataSender?.send?.(sqlMetaData)
     }
 }
 
-module.exports = new SqlMetaDataService()
+module.exports = new SqlMetadataService()
diff --git a/test/client/data-sender.test.js b/test/client/data-sender.test.js
@@ -6,7 +6,7 @@
 
 const test = require('tape')
 
-require('../support/agent-singleton-mock')
+const agent = require('../support/agent-singleton-mock')
 const { fixture } = require('../test-helper')
 const dataSenderMock = require('../support/data-sender-mock')
 const dataSender = dataSenderMock()
@@ -18,6 +18,7 @@ const defaultPredefinedMethodDescriptorRegistry = require('../../lib/constant/de
 
 test('Should send agent info', function (t) {
   t.plan(1)
+  agent.bindHttp()
 
   dataSender.send(agentInfo)
 
@@ -26,6 +27,7 @@ test('Should send agent info', function (t) {
 
 test('Should send api meta info', function (t) {
   t.plan(1)
+  agent.bindHttp()
 
   const methodDescriptor = defaultPredefinedMethodDescriptorRegistry.nodeServerMethodDescriptor
   const apiMetaInfo = ApiMetaInfo.create(methodDescriptor)
@@ -36,6 +38,7 @@ test('Should send api meta info', function (t) {
 
 test('Should send string meta info', function (t) {
   t.plan(1)
+  agent.bindHttp()
 
   const stringMetaInfo = StringMetaInfo.create('1', 'test string')
   dataSender.send(stringMetaInfo)

diff --git a/test/client/grpc-data-sender.test.js b/test/client/grpc-data-sender.test.js
@@ -20,10 +20,10 @@ const AsyncSpanChunkBuilder = require('../../lib/context/trace/async-span-chunk-
 const SpanRepository = require('../../lib/context/trace/span-repository')
 const ChildTraceBuilder = require('../../lib/context/trace/child-trace-builder')
 const serviceType = require('../../lib/context/service-type')
-const makeMockDataSender = require('../fixtures/mock-data-sender')
 const SpanChunkBuilder = require('../../lib/context/span-chunk-builder')
 const Trace = require('../../lib/context/trace/trace2')
 const defaultPredefinedMethodDescriptorRegistry = require('../../lib/constant/default-predefined-method-descriptor-registry')
+const dataSenderMock = require('../support/data-sender-mock')
 
 let sendSpanMethodOnDataCallback
 function sendSpan(call) {
@@ -70,7 +70,7 @@ test('Should send span', function (t) {
   server.bindAsync('localhost:0', grpc.ServerCredentials.createInsecure(), (error, port) => {
     const grpcDataSender = beforeSpecificOne(port, DataSource)
     const traceRoot = new RemoteTraceRootBuilder(agent.agentInfo, '5').build()
-    dataSender = makeMockDataSender(agent.config, grpcDataSender)
+    dataSender = dataSenderMock(agent.config, grpcDataSender)
     const spanBuilder = new SpanBuilder(traceRoot)
     spanBuilder.setServiceType(1400)
     spanBuilder.setEndPoint('localhost:3000')
@@ -167,7 +167,7 @@ test('sendSpanChunk redis.SET.end', function (t) {
     const grpcDataSender = beforeSpecificOne(port, DataSource)
     const traceRoot = new RemoteTraceRootBuilder(agent.agentInfo, '5').build()
     const asyncId = AsyncId.make()
-    dataSender = makeMockDataSender(agent.config, grpcDataSender)
+    dataSender = dataSenderMock(agent.config, grpcDataSender)
     const spanChunkBuilder = new AsyncSpanChunkBuilder(traceRoot, asyncId)
     const repository = new SpanRepository(spanChunkBuilder, dataSender, agent.agentInfo)
     const childTraceBuilder = new ChildTraceBuilder(traceRoot, repository, asyncId)
@@ -245,7 +245,7 @@ test('sendSpanChunk redis.GET.end', (t) => {
     const grpcDataSender = beforeSpecificOne(port, DataSource)
     const traceRoot = new RemoteTraceRootBuilder(agent.agentInfo, '5').build()
     const asyncId = AsyncId.make()
-    dataSender = makeMockDataSender(agent.config, grpcDataSender)
+    dataSender = dataSenderMock(agent.config, grpcDataSender)
     const spanChunkBuilder = new AsyncSpanChunkBuilder(traceRoot, asyncId)
     const repository = new SpanRepository(spanChunkBuilder, dataSender, agent.agentInfo)
     const childTraceBuilder = new ChildTraceBuilder(traceRoot, repository, asyncId)
@@ -315,7 +315,7 @@ test('sendSpan', (t) => {
   server.bindAsync('localhost:0', grpc.ServerCredentials.createInsecure(), (error, port) => {
     const grpcDataSender = beforeSpecificOne(port, DataSource)
     const traceRoot = new RemoteTraceRootBuilder(agent.agentInfo, '5').build()
-    dataSender = makeMockDataSender(agent.config, grpcDataSender)
+    dataSender = dataSenderMock(agent.config, grpcDataSender)
     const spanBuilder = new SpanBuilder(traceRoot)
     const spanChunkBuilder = new SpanChunkBuilder(traceRoot)
     const repository = new SpanRepository(spanChunkBuilder, dataSender, agent.agentInfo)