feat: add pageLoadParentId configuration (#1521)

* feat(rum): expose pageLoadParentId configuration

* chore: unblock ci

* chore: update configuration doc

* chore: unblock ci

* Review feedback

* Make sure right variable is referenced

* Review feedback

---------

Co-authored-by: Alberto Delgado <[email protected]>

Author: dgieselaar

docs/configuration.asciidoc

@@ -185,6 +185,15 @@ NOTE: After each flush of the queue, the next flush isn't scheduled until an ite
 
 This option overrides the page load transactions trace ID.
 
+[float]
+[[page-load-parent-id]]
+=== `pageLoadParentId`
+
+* *Type:* String
+
+This option allows the creation of the page load transaction as child of an existing one. By default,
+the agent treats it as the root transaction.
+
 
 [float]
 [[page-load-sampled]]

packages/rum-core/src/common/compress.js

@@ -232,6 +232,7 @@ export function compressTransaction(transaction) {
 
   const tr = {
     id: transaction.id,
+    pid: transaction.parent_id,
     tid: transaction.trace_id,
     n: transaction.name,
     t: transaction.type,

packages/rum-core/src/common/config-service.js

@@ -85,6 +85,7 @@ class Config {
       pageLoadTraceId: '',
       pageLoadSpanId: '',
       pageLoadSampled: false,
+      pageLoadParentId: '',
       pageLoadTransactionName: '',
       propagateTracestate: false,
       transactionSampleRate: 1.0,

packages/rum-core/src/performance-monitoring/navigation/capture-navigation.js

@@ -95,6 +95,17 @@ function captureNavigation(transaction) {
       }
     )
 
+
+    /**
+    * Set the parent id of the transaction to the page load parent ID.
+    * This means that the backend transaction will be the parent of
+    * the page load transaction, which is useful for e.g Synthetics.
+    */
+
+    if (transaction.options.pageLoadParentId) {
+      transaction.parentId = transaction.options.pageLoadParentId
+    }
+
     /**
      * Page load marks that are gathered from NavigationTiming API
      */

packages/rum-core/src/performance-monitoring/performance-monitoring.js

@@ -398,6 +398,7 @@ export default class PerformanceMonitoring {
 
     const transactionData = {
       id: transaction.id,
+      parent_id: transaction.parentId,
       trace_id: transaction.traceId,
       session: transaction.session,
       name: transaction.name,

packages/rum-core/src/performance-monitoring/transaction-service.js

@@ -109,7 +109,8 @@ class TransactionService {
           pageLoadTraceId: config.pageLoadTraceId,
           pageLoadSampled: config.pageLoadSampled,
           pageLoadSpanId: config.pageLoadSpanId,
-          pageLoadTransactionName: config.pageLoadTransactionName
+          pageLoadTransactionName: config.pageLoadTransactionName,
+          pageLoadParentId: config.pageLoadParentId
         },
         perfOptions
       )
@@ -283,6 +284,7 @@ class TransactionService {
           if (name === NAME_UNKNOWN && pageLoadTransactionName) {
             tr.name = pageLoadTransactionName
           }
+          
           /**
            * Capture the TBT as span after observing for all long task entries
            * and once performance observer is disconnected

packages/rum-core/test/common/apm-server.spec.js

@@ -301,9 +301,10 @@ describe('ApmServer', function () {
     clock.install()
     apmServer.init()
     spyOn(apmServer, '_postJson')
-    const trs = generateTransaction(2).map(tr =>
-      performanceMonitoring.createTransactionDataModel(tr)
-    )
+    const trs = generateTransaction(2).map((tr, i) => {
+      tr.parentId = 'parent-transaction-id-' + i
+      return performanceMonitoring.createTransactionDataModel(tr)
+    })
     const errors = generateErrors(2).map(err => ({
       name: err.name,
       message: err.message
@@ -321,9 +322,9 @@ describe('ApmServer', function () {
       '{"metadata":{"service":{"name":"test","agent":{"name":"rum-js","version":"N/A"},"language":{"name":"javascript"}}}}',
       '{"error":{"name":"Error","message":"error #0"}}',
       '{"error":{"name":"Error","message":"error #1"}}',
-      '{"transaction":{"id":"transaction-id-0","trace_id":"trace-id-0","name":"transaction #0","type":"transaction","duration":990,"span_count":{"started":1},"sampled":false}}',
+      '{"transaction":{"id":"transaction-id-0","parent_id":"parent-transaction-id-0","trace_id":"trace-id-0","name":"transaction #0","type":"transaction","duration":990,"span_count":{"started":1},"sampled":false}}',
       '{"span":{"id":"span-id-0-1","transaction_id":"transaction-id-0","parent_id":"transaction-id-0","trace_id":"trace-id-0","name":"name","type":"type","subtype":"subtype","sync":false,"start":10,"duration":10}}',
-      '{"transaction":{"id":"transaction-id-1","trace_id":"trace-id-1","name":"transaction #1","type":"transaction","duration":990,"span_count":{"started":1},"sampled":false}}',
+      '{"transaction":{"id":"transaction-id-1","parent_id":"parent-transaction-id-1","trace_id":"trace-id-1","name":"transaction #1","type":"transaction","duration":990,"span_count":{"started":1},"sampled":false}}',
       '{"span":{"id":"span-id-1-1","transaction_id":"transaction-id-1","parent_id":"transaction-id-1","trace_id":"trace-id-1","name":"name","type":"type","subtype":"subtype","sync":false,"start":10,"duration":10}}'
     ]
 
@@ -337,9 +338,10 @@ describe('ApmServer', function () {
     configService.setConfig({ apiVersion: 3 })
     apmServer.init()
     spyOn(apmServer, '_postJson')
-    const trs = generateTransaction(1, true).map(tr =>
-      performanceMonitoring.createTransactionDataModel(tr)
-    )
+    const trs = generateTransaction(1, true).map((tr, i) => {
+      tr.parentId = 'parent-transaction-id-' + i
+      return performanceMonitoring.createTransactionDataModel(tr)
+    })
     const errors = generateErrors(1).map((err, i) => {
       let model = errorLogging.createErrorDataModel(err)
       model.id = 'error-id-' + i
@@ -357,7 +359,7 @@ describe('ApmServer', function () {
     const expected = [
       '{"m":{"se":{"n":"test","a":{"n":"rum-js","ve":"N/A"},"la":{"n":"javascript"}}}}',
       '{"e":{"id":"error-id-0","cl":"(inline script)","ex":{"mg":"error #0","st":[]},"c":null}}',
-      '{"x":{"id":"transaction-id-0","tid":"trace-id-0","n":"transaction #0","t":"transaction","d":990,"c":null,"k":null,"me":[{"y":{"t":"app"},"sa":{"ysc":{"v":1},"yss":{"v":980000}}},{"y":{"t":"type"},"sa":{"ysc":{"v":1},"yss":{"v":10000}}}],"y":[{"id":"span-id-0-1","n":"name","t":"type","s":10,"d":10,"c":null,"sr":0.1,"su":"subtype"}],"yc":{"sd":1},"sm":true,"sr":0.1}}'
+      '{"x":{"id":"transaction-id-0","pid":"parent-transaction-id-0","tid":"trace-id-0","n":"transaction #0","t":"transaction","d":990,"c":null,"k":null,"me":[{"y":{"t":"app"},"sa":{"ysc":{"v":1},"yss":{"v":980000}}},{"y":{"t":"type"},"sa":{"ysc":{"v":1},"yss":{"v":10000}}}],"y":[{"id":"span-id-0-1","n":"name","t":"type","s":10,"d":10,"c":null,"sr":0.1,"su":"subtype"}],"yc":{"sd":1},"sm":true,"sr":0.1}}'
     ]
     expect(payload.split('\n').filter(a => a)).toEqual(expected)
     clock.uninstall()

packages/rum-core/test/performance-monitoring/transaction-service.spec.js

@@ -261,6 +261,28 @@ describe('TransactionService', function () {
     })
   })
 
+  it('should set page load parentId before ending the transaction', function (done) {
+    config.setConfig({
+      pageLoadParentId: 'test-page-load-parent-id'
+    })
+    transactionService = new TransactionService(logger, config)
+
+    const tr = transactionService.startTransaction(undefined, 'page-load', {
+      managed: true
+    })
+
+    tr.detectFinish()
+
+    /**
+     * For page load transaction we set the transaction parentId using
+     * transaction.onEnd
+     */
+    config.events.observe(TRANSACTION_END, tr => {
+      expect(tr.parentId).toBe('test-page-load-parent-id')
+      done()
+    })
+  })
+
   it('should capture resources from navigation timing', function (done) {
     const unMock = mockGetEntriesByType()
 
@@ -362,6 +384,16 @@ describe('TransactionService', function () {
     })
   })
 
+  it('should consider page load parentId', function () {
+    config.setConfig({
+      pageLoadParentId: 'test-page-load-parent-id'
+    })
+
+    transactionService = new TransactionService(logger, config)
+    const tr = sendPageLoadMetrics()
+    expect(tr.options.pageLoadParentId).toBe('test-page-load-parent-id')
+  })
+
   it('should call createCurrentTransaction once per startTransaction', function () {
     spyOn(transactionService, 'createCurrentTransaction').and.callThrough()
     transactionService.startTransaction('test-name', 'test-type', {