feat: SMs for browser connect response

Author: ellisong

docs/supportability-metrics.md

@@ -439,3 +439,11 @@ EventBuffer/soft_navigations/Dropped/Bytes
 * rrweb/node/3/bytes
 <!-- node type 4 = Meta -->
 * rrweb/node/4/bytes
+
+### Browser Connect Response Metrics
+<!--- HTTP status code of failed browser connect response --->
+* Browser/Supportability/BCS/Error/StatusCode
+<!--- Total dropped payload size of failed browser connect response --->
+* Browser/Supportability/BCS/Error/Dropped/Bytes
+<!--- Response time of failed browser connect response --->
+* Browser/Supportability/BCS/Error/Duration/Ms

src/features/page_view_event/aggregate/index.js

@@ -17,6 +17,9 @@ import { timeToFirstByte } from '../../../common/vitals/time-to-first-byte'
 import { now } from '../../../common/timing/now'
 import { TimeKeeper } from '../../../common/timing/time-keeper'
 import { applyFnToProps } from '../../../common/util/traverse'
+import { send } from '../../../common/harvest/harvester'
+import { FEATURE_NAMES, FEATURE_TO_ENDPOINT } from '../../../loaders/features/features'
+import { getSubmitMethod } from '../../../common/util/submit-data'
 
 export class Aggregate extends AggregateBase {
   static featureName = CONSTANTS.FEATURE_NAME
@@ -136,6 +139,54 @@ export class Aggregate extends AggregateBase {
 
     if (status >= 400 || status === 0) {
       warn(18, status)
+
+      // Get estimated payload size of our backlog
+      const textEncoder = new TextEncoder()
+      const payloadSize = Object.values(newrelic.ee.backlog).reduce((acc, value) => {
+        if (!value) return acc
+
+        const encoded = textEncoder.encode(value)
+        return acc + encoded.byteLength
+      }, 0)
+
+      // Send SMs about failed RUM request
+      const body = {
+        sm: [{
+          params: {
+            name: 'Browser/Supportability/BCS/Error/StatusCode'
+          },
+          stats: {
+            c: 1,
+            t: status
+          }
+        },
+        {
+          params: {
+            name: 'Browser/Supportability/BCS/Error/Dropped/Bytes'
+          },
+          stats: {
+            c: 1,
+            t: payloadSize
+          }
+        },
+        {
+          params: {
+            name: 'Browser/Supportability/BCS/Error/Duration/Ms'
+          },
+          stats: {
+            c: 1,
+            t: rumEndTime - this.rumStartTime
+          }
+        }]
+      }
+
+      send(this.agentRef, {
+        endpoint: FEATURE_TO_ENDPOINT[FEATURE_NAMES.metrics],
+        payload: { body },
+        submitMethod: getSubmitMethod(),
+        featureName: FEATURE_NAMES.metrics
+      })
+
       // Adding retry logic for the rum call will be a separate change; this.blocked will need to be changed since that prevents another triggerHarvestFor()
       this.ee.abort()
       return

tests/specs/rum/supportability-metrics.e2e.js

@@ -0,0 +1,54 @@
+import { testRumRequest, testMetricsRequest } from '../../../tools/testing-server/utils/expect-tests'
+
+describe('basic pve capturing', () => {
+  let rumCapture
+  let metricsCapture
+
+  beforeEach(async () => {
+    [rumCapture, metricsCapture] = await browser.testHandle.createNetworkCaptures('bamServer', [
+      { test: testRumRequest },
+      { test: testMetricsRequest }
+    ])
+  })
+
+  it('should report SMs when RUM call fails to browser connect service', async () => {
+    // will reply with http status 500 to fake error response from browser connect service
+    await browser.testHandle.scheduleReply('bamServer', {
+      test: testRumRequest,
+      statusCode: 500
+    })
+
+    // visit the webpage, not waiting for agent load since we don't expect the rum feature to load properly
+    await browser.url(await browser.testHandle.assetURL('instrumented.html'))
+
+    // wait for rum response harvest
+    const rumHarvest = await rumCapture.waitForResult({ totalCount: 1 })
+
+    // RUM harvest should have the expected http status code from the bam server
+    expect(rumHarvest[0].reply.statusCode).toBe(500)
+
+    // wait for supportability metrics harvest
+    const smHarvest = await metricsCapture.waitForResult({ totalCount: 1 })
+
+    // check for expected properties on status code supportability metric
+    const smHarvestStatusCode = smHarvest[0].request.body.sm.find(sm => sm.params.name === 'Browser/Supportability/BCS/Error/StatusCode')
+    expect(smHarvestStatusCode).toBeDefined()
+    expect(smHarvestStatusCode.stats).toBeDefined()
+    expect(smHarvestStatusCode.stats.c).toBe(1)
+    expect(smHarvestStatusCode.stats.t).toBe(500)
+
+    // check for expected properties on dropped bytes supportability metric
+    const smHarvestDroppedBytes = smHarvest[0].request.body.sm.find(sm => sm.params.name === 'Browser/Supportability/BCS/Error/Dropped/Bytes')
+    expect(smHarvestDroppedBytes).toBeDefined()
+    expect(smHarvestDroppedBytes.stats).toBeDefined()
+    expect(smHarvestDroppedBytes.stats.c).toBe(1)
+    expect(smHarvestDroppedBytes.stats.t).toBeGreaterThan(0)
+
+    // check for expected properties on response time supportability metric
+    const smHarvestResponseTime = smHarvest[0].request.body.sm.find(sm => sm.params.name === 'Browser/Supportability/BCS/Error/Duration/Ms')
+    expect(smHarvestResponseTime).toBeDefined()
+    expect(smHarvestResponseTime.stats).toBeDefined()
+    expect(smHarvestResponseTime.stats.c).toBe(1)
+    expect(smHarvestResponseTime.stats.t).toBeGreaterThan(0)
+  })
+})