onweek commit, please do not remove

Author: devcorpio

package-lock.json

@@ -46,6 +46,7 @@
     "enquirer": "^2.3.6",
     "esbuild": "^0.16.10",
     "expect": "^28.1.3",
+    "glob-to-regexp": "^0.4.1",
     "http-proxy": "^1.18.1",
     "kleur": "^4.1.5",
     "micromatch": "^4.0.5",

package.json

@@ -123,6 +123,10 @@ program
     {}
   )
   .option('--no-throttling', 'Turns off default network throttling.')
+  .option(
+    '--trace-url-patterns <strings delimited by ,>',
+    'each of these strings correspond to url patterns that will receive the baggage header containing monitorid and checkgroup'
+  )
   .addOption(playwrightOpts)
   .version(version)
   .description('Run synthetic tests')

src/cli.ts

@@ -225,6 +225,7 @@ export type CliArgs = BaseArgs & {
   sandbox?: boolean;
   richEvents?: boolean;
   capability?: Array<string>;
+  traceUrlPatterns?: string;
   ignoreHttpsErrors?: boolean;
 };
 
@@ -238,6 +239,9 @@ export type RunOptions = BaseArgs & {
   playwrightOptions?: PlaywrightOptions;
   networkConditions?: NetworkConditions;
   reporter?: BuiltInReporterName | ReporterInstance;
+  apm?: ApmOptions;
+  monitorId?: string;
+  checkgroup?: string;
 };
 
 export type PushOptions = Partial<ProjectSettings> & {
@@ -254,12 +258,17 @@ export type ProjectSettings = {
   space: string;
 };
 
+export type ApmOptions = {
+  traceUrlPatterns: Array<string | RegExp>;
+};
+
 export type PlaywrightOptions = LaunchOptions & BrowserContextOptions;
 export type SyntheticsConfig = {
   params?: Params;
   playwrightOptions?: PlaywrightOptions;
   monitor?: MonitorConfig;
   project?: ProjectSettings;
+  apm?: ApmOptions;
 };
 
 /** Runner Payload types */

src/common_types.ts

@@ -109,12 +109,13 @@ export class Gatherer {
    */
   static async beginRecording(driver: Driver, options: RunOptions) {
     log('Gatherer: started recording');
-    const { network, metrics } = options;
+    const { network, metrics, apm } = options;
     const pluginManager = new PluginManager(driver);
     pluginManager.registerAll(options);
     const plugins = [await pluginManager.start('browserconsole')];
     network && plugins.push(await pluginManager.start('network'));
     metrics && plugins.push(await pluginManager.start('performance'));
+    apm && plugins.push(await pluginManager.start('apm'));
     await Promise.all(plugins);
     return pluginManager;
   }

src/core/gatherer.ts

@@ -26,6 +26,7 @@
 import merge from 'deepmerge';
 import { createOption } from 'commander';
 import { readConfig } from './config';
+import globToRegExp from 'glob-to-regexp';
 import { getNetworkConditions, DEFAULT_THROTTLING_OPTIONS } from './helpers';
 import type { CliArgs, RunOptions, ThrottlingOptions } from './common_types';
 
@@ -42,7 +43,10 @@ export function normalizeOptions(cliArgs: CliArgs): RunOptions {
   const options: RunOptions = {
     ...cliArgs,
     environment: process.env['NODE_ENV'] || 'development',
+    monitorId: process.env['MONITOR_ID'],
+    checkgroup: process.env['CHECKGROUP'],
   };
+
   /**
    * Group all events that can be consumed by heartbeat and
    * eventually by the Synthetics UI.
@@ -55,6 +59,16 @@ export function normalizeOptions(cliArgs: CliArgs): RunOptions {
     options.quietExitCode = true;
   }
 
+  if (cliArgs.traceUrlPatterns) {
+    const urlPatterns = cliArgs.traceUrlPatterns.split(',').map(pattern => {
+      return globToRegExp(pattern);
+    });
+
+    options.apm = {
+      traceUrlPatterns: urlPatterns,
+    };
+  }
+
   if (cliArgs.capability) {
     const supportedCapabilities = [
       'trace',

src/options.ts

@@ -0,0 +1,59 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2020-present, Elastic NV
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+import { Request, Route } from 'playwright-core';
+import { ApmOptions, Driver } from '../common_types';
+
+export class Apm {
+  constructor(
+    private driver: Driver,
+    private options: ApmOptions,
+    private monitorId: string,
+    private checkgroup: string
+  ) {}
+
+  async traceHandler(route: Route, request: Request) {
+    const baggage = `monitor.id:${this.monitorId};monitor.check_group:${this.checkgroup}`;
+    const headers = {
+      ...(await request.allHeaders()),
+      baggage,
+    };
+    route.continue({
+      headers,
+    });
+  }
+
+  async start() {
+    for (const pattern of this.options.traceUrlPatterns) {
+      await this.driver.context.route(pattern, this.traceHandler.bind(this));
+    }
+  }
+
+  async stop() {
+    for (const pattern of this.options.traceUrlPatterns) {
+      await this.driver.context.unroute(pattern, this.traceHandler.bind(this));
+    }
+  }
+}

src/plugins/apm.ts

@@ -23,7 +23,7 @@
  *
  */
 
-import { PluginOutput, Driver } from '../common_types';
+import { PluginOutput, Driver, RunOptions } from '../common_types';
 import {
   BrowserConsole,
   NetworkManager,
@@ -32,10 +32,25 @@ import {
   TraceOptions,
 } from './';
 import { Step } from '../dsl';
+import { Apm } from './apm';
 
-type PluginType = 'network' | 'trace' | 'performance' | 'browserconsole';
-type Plugin = NetworkManager | Tracing | PerformanceManager | BrowserConsole;
-type PluginOptions = TraceOptions;
+type PluginType =
+  | 'network'
+  | 'trace'
+  | 'performance'
+  | 'browserconsole'
+  | 'apm';
+type Plugin =
+  | NetworkManager
+  | Tracing
+  | PerformanceManager
+  | BrowserConsole
+  | Apm;
+type PluginOptions = TraceOptions & {
+  apm?: RunOptions['apm'];
+  monitorId?: RunOptions['monitorId'];
+  checkgroup?: RunOptions['checkgroup'];
+};
 
 export class PluginManager {
   protected plugins = new Map<PluginType, Plugin>();
@@ -44,6 +59,7 @@ export class PluginManager {
     'trace',
     'performance',
     'browserconsole',
+    'apm',
   ];
   constructor(private driver: Driver) {}
 
@@ -62,6 +78,14 @@ export class PluginManager {
       case 'browserconsole':
         instance = new BrowserConsole(this.driver);
         break;
+      case 'apm':
+        instance = new Apm(
+          this.driver,
+          options.apm,
+          options.monitorId,
+          options.checkgroup
+        );
+        break;
     }
     instance && this.plugins.set(type, instance);
     return instance;