feat: add transaction and span

Author: vigneshshanmugam

examples/todos/basic.journey.ts

@@ -23,3 +23,21 @@ journey('check if input placeholder is correct', ({ page, params }) => {
     );
   });
 });
+
+journey('Synthetics + APM', ({ page }) => {
+  step('go to index page', async () => {
+    await page.goto('http://localhost:8080/index');
+    // make sure RUM request has been successfully sent to APM server
+    await page.waitForResponse(response =>
+      response.url().includes('/rum/events')
+    );
+  });
+
+  step('go to unknown page', async () => {
+    await page.goto('http://localhost:8080/unknown');
+    // make sure RUM request has been successfully sent to APM server
+    await page.waitForResponse(response =>
+      response.url().includes('/rum/events')
+    );
+  });
+});

package-lock.json

@@ -42,6 +42,7 @@
     "commander": "^9.0.0",
     "deepmerge": "^4.2.2",
     "expect": "^27.0.2",
+    "elastic-apm-node": "^3.31.0",
     "http-proxy": "^1.18.1",
     "kleur": "^4.1.4",
     "micromatch": "^4.0.4",

package.json

@@ -0,0 +1,46 @@
+/**
+ * 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 agent from 'elastic-apm-node';
+
+agent.start({
+  serviceName: 'synthetics',
+  instrument: false,
+  metricsInterval: '0',
+  centralConfig: false,
+  captureSpanStackTraces: false,
+  serverUrl: '',
+  secretToken: '',
+});
+
+agent.addFilter(payload => {
+  console.log('Payload', payload);
+});
+
+process.on('exit', () => {
+  agent.flush(() => {
+    console.log('flushed');
+  });
+});

src/apm.ts

@@ -132,6 +132,7 @@ export default class Runner extends EventEmitter {
   hooks: SuiteHooks = { beforeAll: [], afterAll: [] };
   hookError: Error | undefined;
   static screenshotPath = join(CACHE_PATH, 'screenshots');
+  traceparent: string;
 
   static async createContext(options: RunOptions): Promise<JourneyContext> {
     const driver = await Gatherer.setupDriver(options);
@@ -240,6 +241,18 @@ export default class Runner extends EventEmitter {
        * step level plugins
        */
       const traceEnabled = trace || filmstrips;
+      this.traceparent = step.span.traceparent;
+      const handler = (route, request) => {
+        console.log('traceparent', this.traceparent);
+        const headers = {
+          traceparent: this.traceparent,
+          ...request.headers(),
+        };
+        route.continue({
+          headers,
+        });
+      };
+      context.driver.page.route(/index|unknown/, handler);
       pluginManager.onStep(step);
       traceEnabled && (await pluginManager.start('trace'));
       // call the step definition
@@ -256,6 +269,7 @@ export default class Runner extends EventEmitter {
         const traceOutput = await pluginManager.stop('trace');
         Object.assign(data, traceOutput);
       }
+      context.driver.page.unroute(/index|unknown/, handler);
     } catch (error) {
       data.status = 'failed';
       data.error = error;
@@ -309,6 +323,7 @@ export default class Runner extends EventEmitter {
       if (options.pauseOnError && data.error) {
         await new Promise(r => process.stdin.on('data', r));
       }
+      step.span.end();
       results.push(data);
     }
     return results;
@@ -353,6 +368,7 @@ export default class Runner extends EventEmitter {
     }
     // clear screenshots cache after each journey
     await rm(Runner.screenshotPath, { recursive: true, force: true });
+    journey.transaction.end();
   }
 
   /**
@@ -380,6 +396,7 @@ export default class Runner extends EventEmitter {
     if (options.reporter === 'json') {
       await once(this, 'journey:end:reported');
     }
+    journey.transaction.end();
     return result;
   }
 

src/core/runner.ts

@@ -27,6 +27,7 @@ import { Browser, Page, BrowserContext, CDPSession } from 'playwright-chromium';
 import micromatch, { isMatch } from 'micromatch';
 import { Step } from './step';
 import { VoidCallback, HooksCallback, Params, Location } from '../common_types';
+import { startTransaction, Transaction } from 'elastic-apm-node';
 
 export type JourneyOptions = {
   name: string;
@@ -48,6 +49,7 @@ export class Journey {
   name: string;
   id?: string;
   tags?: string[];
+  transaction: Transaction;
   callback: JourneyCallback;
   location?: Location;
   steps: Step[] = [];
@@ -63,6 +65,7 @@ export class Journey {
     this.tags = options.tags;
     this.callback = callback;
     this.location = location;
+    this.transaction = startTransaction(`Journey: ${this.name}`);
   }
 
   addStep(name: string, callback: VoidCallback, location?: Location) {

src/dsl/journey.ts

@@ -24,12 +24,14 @@
  */
 
 import { Location, VoidCallback } from '../common_types';
+import { startSpan, Span } from 'elastic-apm-node';
 
 export class Step {
   name: string;
   index: number;
   callback: VoidCallback;
   location?: Location;
+  span: Span;
 
   constructor(
     name: string,
@@ -41,5 +43,6 @@ export class Step {
     this.index = index;
     this.callback = callback;
     this.location = location;
+    this.span = startSpan(`Step: ${this.name}`);
   }
 }

src/dsl/step.ts

@@ -25,6 +25,7 @@
 
 import { runner } from './core';
 import { RunOptions } from './common_types';
+import './apm';
 
 export async function run(options: RunOptions) {
   return runner.run(options);