Test

Author: amortemousque

benchmark/createBenchmarkTest.ts

@@ -19,6 +19,8 @@ export function createBenchmarkTest(scenarioName: string) {
   return {
     run(runner: TestRunner) {
       const metrics: Record<string, Metrics> = {}
+      let sdkVersion: string
+
       SCENARIO_CONFIGURATIONS.forEach((scenarioConfiguration) => {
         test(`${scenarioName} benchmark ${scenarioConfiguration}`, async ({ page }) => {
           await page.setExtraHTTPHeaders({ 'Accept-Language': 'en-US' })
@@ -33,13 +35,16 @@ export function createBenchmarkTest(scenarioName: string) {
 
           await flushEvents(page)
           metrics[scenarioConfiguration] = await stopProfiling()
+          if (!sdkVersion) {
+            sdkVersion = await getSDKVersion(page)
+          }
         })
       })
 
       test.afterAll(async () => {
-        reportToConsole(metrics)
+        reportToConsole(metrics, sdkVersion)
         if (isContinuousIntegration) {
-          await reportToDatadog(metrics, scenarioName)
+          await reportToDatadog(metrics, scenarioName, sdkVersion)
         }
       })
     },
@@ -66,6 +71,7 @@ async function injectSDK(page: Page, scenarioConfiguration: ScenarioConfiguratio
   await page.addInitScript(
     ({ sdkBundleUrl, scenarioConfiguration, scenarioName, configuration }: PageInitScriptParameters) => {
       function loadSDK() {
+        const browserWindow = window as BrowserWindow
         ;(function (h: any, o: Document, u: string, n: string, d: string) {
           h = h[d] = h[d] || {
             q: [],
@@ -79,12 +85,12 @@ async function injectSDK(page: Page, scenarioConfiguration: ScenarioConfiguratio
           s.src = n
           o.head.appendChild(s)
         })(window, document, 'script', sdkBundleUrl, 'DD_RUM')
-        ;(window as BrowserWindow).DD_RUM?.onReady(function () {
-          ;(window as BrowserWindow).DD_RUM!.setGlobalContextProperty('scenario', {
+        browserWindow.DD_RUM?.onReady(function () {
+          browserWindow.DD_RUM!.setGlobalContextProperty('scenario', {
             configuration: scenarioConfiguration,
             name: scenarioName,
           })
-          ;(window as BrowserWindow).DD_RUM!.init(configuration as RumInitConfiguration)
+          browserWindow.DD_RUM!.init(configuration as RumInitConfiguration)
         })
       }
 
@@ -99,6 +105,10 @@ async function injectSDK(page: Page, scenarioConfiguration: ScenarioConfiguratio
   )
 }
 
+async function getSDKVersion(page: Page) {
+  return await page.evaluate(() => (window as BrowserWindow).DD_RUM?.version || '')
+}
+
 function shouldInjectSDK(scenarioConfiguration: ScenarioConfiguration): boolean {
   return !['none', 'none_with_headers'].includes(scenarioConfiguration)
 }

benchmark/reporters/reportToConsole.ts

@@ -4,7 +4,7 @@ const DURATION_UNITS = ['μs', 'ms', 's']
 const BYTES_UNITS = ['B', 'kB', 'MB']
 const NO_VALUE = ''
 
-export function reportToConsole(metricsTable: Record<string, Metrics>) {
+export function reportToConsole(metricsTable: Record<string, Metrics>, sdkVersion: string) {
   const report: Record<string, Record<string, string>> = {
     'memory (median)': {},
     cpu: {},
@@ -32,6 +32,7 @@ export function reportToConsole(metricsTable: Record<string, Metrics>) {
     report['TBT'][scenarioConfiguration] = metrics.TBT ? formatNumberWithUnit(metrics.TBT, DURATION_UNITS) : NO_VALUE
   }
 
+  console.log(`Results for SDK version: ${sdkVersion}`)
   console.table(report)
 }
 

benchmark/reporters/reportToDatadog.ts

@@ -13,26 +13,29 @@ const METRIC_PREFIX = 'browser_sdk.benchmark'
 
 export async function reportToDatadog(
   metricsTable: Record<string, Metrics>,
-  scenarioName: string
+  scenarioName: string,
+  sdkVersion: string
 ) {
-  const series = convertMetricsToSeries(metricsTable, scenarioName)
+  const series = convertMetricsToSeries(metricsTable, scenarioName, sdkVersion)
   const result = await sendToDatadog(series)
 
   console.log(`✅ Successfully sent ${series.length} metrics to Datadog`)
-  console.log(`📊 View metrics in Datadog: https://app.${DATADOG_SITE}/metric/explorer?query=${METRIC_PREFIX}.*`)
-  console.log(`🏷️  Filter by tags: scenario:${scenarioName}`)
+  console.log(
+    `📊 View metrics in Datadog: https://app.${DATADOG_SITE}/dashboard/m7i-uke-sa9/rum-browser-sdk-performance`
+  )
   return result
 }
 
 function convertMetricsToSeries(
   metricsTable: Record<string, Metrics>,
-  scenarioName: string
+  scenarioName: string,
+  sdkVersion: string
 ): DatadogSeries[] {
   const timestamp = Math.floor(Date.now() / 1000)
   const series: DatadogSeries[] = []
 
   for (const [configuration, metrics] of Object.entries(metricsTable)) {
-    const tags = [`scenario:${scenarioName}`, `configuration:${configuration}`]
+    const tags = [`scenario:${scenarioName}`, `configuration:${configuration}`, `sdk_version:${sdkVersion}`]
 
     for (const [key, value] of Object.entries(metrics)) {
       series.push({