[Reporting] APM integration for baseline performance measurements (#5…

…9967) (#65797) * apm stuff * fix cluster_client * fix snapshot * tracker utility for generate_pdf * call apm.startSpan instead of txn.startSpan * Fix async call to end transaction * fix typescript * remove captuureErrors * restore accidental removal * add startTrace lib * fix import * fix imports * ts fix * fix generate_png to not format base64 to buffer and back to base64 * 💅 * revert change to cluster client * fix unused translation Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
elastic · May 8, 2020 · c1e699d · c1e699d
1 parent 32ad39e
commit c1e699d
Show file tree

Hide file tree

Showing 20 changed files with 243 additions and 61 deletions.
diff --git a/...legacy/plugins/reporting/export_types/common/lib/screenshots/get_element_position_data.ts b/...legacy/plugins/reporting/export_types/common/lib/screenshots/get_element_position_data.ts
@@ -6,16 +6,17 @@
 
 import { i18n } from '@kbn/i18n';
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
+import { LevelLogger as Logger, startTrace } from '../../../../server/lib';
 import { LayoutInstance } from '../../layouts/layout';
-import { AttributesMap, ElementsPositionAndAttribute } from './types';
-import { Logger } from '../../../../types';
 import { CONTEXT_ELEMENTATTRIBUTES } from './constants';
+import { AttributesMap, ElementsPositionAndAttribute } from './types';
 
 export const getElementPositionAndAttributes = async (
   browser: HeadlessBrowser,
   layout: LayoutInstance,
   logger: Logger
 ): Promise<ElementsPositionAndAttribute[] | null> => {
+  const endTrace = startTrace('get_element_position_data', 'read');
   const { screenshot: screenshotSelector } = layout.selectors; // data-shared-items-container
   let elementsPositionAndAttributes: ElementsPositionAndAttribute[] | null;
   try {
@@ -69,5 +70,7 @@ export const getElementPositionAndAttributes = async (
     elementsPositionAndAttributes = null;
   }
 
+  endTrace();
+
   return elementsPositionAndAttributes;
 };
diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/get_number_of_items.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/get_number_of_items.ts
@@ -6,7 +6,7 @@
 
 import { i18n } from '@kbn/i18n';
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
-import { LevelLogger } from '../../../../server/lib';
+import { LevelLogger, startTrace } from '../../../../server/lib';
 import { CaptureConfig } from '../../../../server/types';
 import { LayoutInstance } from '../../layouts/layout';
 import { CONTEXT_GETNUMBEROFITEMS, CONTEXT_READMETADATA } from './constants';
@@ -17,6 +17,7 @@ export const getNumberOfItems = async (
   layout: LayoutInstance,
   logger: LevelLogger
 ): Promise<number> => {
+  const endTrace = startTrace('get_number_of_items', 'read');
   const { renderComplete: renderCompleteSelector, itemsCountAttribute } = layout.selectors;
   let itemsCount: number;
 
@@ -70,5 +71,7 @@ export const getNumberOfItems = async (
     itemsCount = 1;
   }
 
+  endTrace();
+
   return itemsCount;
 };
diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/get_screenshots.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/get_screenshots.ts
@@ -6,26 +6,9 @@
 
 import { i18n } from '@kbn/i18n';
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
-import { LevelLogger } from '../../../../server/lib';
+import { LevelLogger, startTrace } from '../../../../server/lib';
 import { Screenshot, ElementsPositionAndAttribute } from './types';
 
-const getAsyncDurationLogger = (logger: LevelLogger) => {
-  return async (description: string, promise: Promise<any>) => {
-    const start = Date.now();
-    const result = await promise;
-    logger.debug(
-      i18n.translate('xpack.reporting.screencapture.asyncTook', {
-        defaultMessage: '{description} took {took}ms',
-        values: {
-          description,
-          took: Date.now() - start,
-        },
-      })
-    );
-    return result;
-  };
-};
-
 export const getScreenshots = async (
   browser: HeadlessBrowser,
   elementsPositionAndAttributes: ElementsPositionAndAttribute[],
@@ -37,21 +20,20 @@ export const getScreenshots = async (
     })
   );
 
-  const asyncDurationLogger = getAsyncDurationLogger(logger);
   const screenshots: Screenshot[] = [];
 
   for (let i = 0; i < elementsPositionAndAttributes.length; i++) {
+    const endTrace = startTrace('get_screenshots', 'read');
     const item = elementsPositionAndAttributes[i];
-    const base64EncodedData = await asyncDurationLogger(
-      `screenshot #${i + 1}`,
-      browser.screenshot(item.position)
-    );
+    const base64EncodedData = await browser.screenshot(item.position);
 
     screenshots.push({
       base64EncodedData,
       title: item.attributes.title,
       description: item.attributes.description,
     });
+
+    endTrace();
   }
 
   logger.info(

diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/get_time_range.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/get_time_range.ts
@@ -5,7 +5,7 @@
  */
 
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
-import { LevelLogger } from '../../../../server/lib';
+import { LevelLogger, startTrace } from '../../../../server/lib';
 import { LayoutInstance } from '../../layouts/layout';
 import { CONTEXT_GETTIMERANGE } from './constants';
 import { TimeRange } from './types';
@@ -15,6 +15,7 @@ export const getTimeRange = async (
   layout: LayoutInstance,
   logger: LevelLogger
 ): Promise<TimeRange | null> => {
+  const endTrace = startTrace('get_time_range', 'read');
   logger.debug('getting timeRange');
 
   const timeRange: TimeRange | null = await browser.evaluate(
@@ -45,5 +46,7 @@ export const getTimeRange = async (
     logger.debug('no timeRange');
   }
 
+  endTrace();
+
   return timeRange;
 };
diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/inject_css.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/inject_css.ts
@@ -7,8 +7,8 @@
 import { i18n } from '@kbn/i18n';
 import fs from 'fs';
 import { promisify } from 'util';
-import { LevelLogger } from '../../../../server/lib';
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
+import { LevelLogger, startTrace } from '../../../../server/lib';
 import { Layout } from '../../layouts/layout';
 import { CONTEXT_INJECTCSS } from './constants';
 
@@ -19,6 +19,7 @@ export const injectCustomCss = async (
   layout: Layout,
   logger: LevelLogger
 ): Promise<void> => {
+  const endTrace = startTrace('inject_css', 'correction');
   logger.debug(
     i18n.translate('xpack.reporting.screencapture.injectingCss', {
       defaultMessage: 'injecting custom css',
@@ -49,4 +50,6 @@ export const injectCustomCss = async (
       })
     );
   }
+
+  endTrace();
 };
diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/observable.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/observable.ts
@@ -4,8 +4,18 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import apm from 'elastic-apm-node';
 import * as Rx from 'rxjs';
-import { catchError, concatMap, first, mergeMap, take, takeUntil, toArray } from 'rxjs/operators';
+import {
+  catchError,
+  concatMap,
+  first,
+  mergeMap,
+  take,
+  takeUntil,
+  tap,
+  toArray,
+} from 'rxjs/operators';
 import { CaptureConfig } from '../../../../server/types';
 import { DEFAULT_PAGELOAD_SELECTOR } from '../../constants';
 import { HeadlessChromiumDriverFactory } from '../../../../types';
@@ -41,13 +51,17 @@ export function screenshotsObservableFactory(
     layout,
     browserTimezone,
   }: ScreenshotObservableOpts): Rx.Observable<ScreenshotResults[]> {
+    const apmTrans = apm.startTransaction(`reporting screenshot pipeline`, 'reporting');
+
+    const apmCreatePage = apmTrans?.startSpan('create_page', 'wait');
     const create$ = browserDriverFactory.createPage(
       { viewport: layout.getBrowserViewport(), browserTimezone },
       logger
     );
 
     return create$.pipe(
       mergeMap(({ driver, exit$ }) => {
+        if (apmCreatePage) apmCreatePage.end();
         return Rx.from(urls).pipe(
           concatMap((url, index) => {
             const setup$: Rx.Observable<ScreenSetupData> = Rx.of(1).pipe(
@@ -81,10 +95,12 @@ export function screenshotsObservableFactory(
                 // allows for them to be displayed properly in many cases
                 await injectCustomCss(driver, layout, logger);
 
+                const apmPositionElements = apmTrans?.startSpan('position_elements', 'correction');
                 if (layout.positionElements) {
                   // position panel elements for print layout
                   await layout.positionElements(driver, logger);
                 }
+                if (apmPositionElements) apmPositionElements.end();
 
                 await waitForRenderComplete(captureConfig, driver, layout, logger);
               }),
@@ -125,7 +141,10 @@ export function screenshotsObservableFactory(
           toArray()
         );
       }),
-      first()
+      first(),
+      tap(() => {
+        if (apmTrans) apmTrans.end();
+      })
     );
   };
 }

diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/open_url.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/open_url.ts
@@ -6,7 +6,7 @@
 
 import { i18n } from '@kbn/i18n';
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
-import { LevelLogger } from '../../../../server/lib';
+import { LevelLogger, startTrace } from '../../../../server/lib';
 import { CaptureConfig } from '../../../../server/types';
 import { ConditionalHeaders } from '../../../../types';
 
@@ -18,6 +18,7 @@ export const openUrl = async (
   conditionalHeaders: ConditionalHeaders,
   logger: LevelLogger
 ): Promise<void> => {
+  const endTrace = startTrace('open_url', 'wait');
   try {
     await browser.open(
       url,
@@ -32,11 +33,10 @@ export const openUrl = async (
     throw new Error(
       i18n.translate('xpack.reporting.screencapture.couldntLoadKibana', {
         defaultMessage: `An error occurred when trying to open the Kibana URL. You may need to increase '{configKey}'. {error}`,
-        values: {
-          configKey: 'xpack.reporting.capture.timeouts.openUrl',
-          error: err,
-        },
+        values: { configKey: 'xpack.reporting.capture.timeouts.openUrl', error: err },
       })
     );
   }
+
+  endTrace();
 };
diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/types.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/types.ts
@@ -30,7 +30,7 @@ export interface ElementsPositionAndAttribute {
 }
 
 export interface Screenshot {
-  base64EncodedData: Buffer;
+  base64EncodedData: string;
   title: string;
   description: string;
 }

diff --git a/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/wait_for_render.ts b/x-pack/legacy/plugins/reporting/export_types/common/lib/screenshots/wait_for_render.ts
@@ -6,7 +6,7 @@
 
 import { i18n } from '@kbn/i18n';
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
-import { LevelLogger } from '../../../../server/lib';
+import { LevelLogger, startTrace } from '../../../../server/lib';
 import { CaptureConfig } from '../../../../server/types';
 import { LayoutInstance } from '../../layouts/layout';
 import { CONTEXT_WAITFORRENDER } from './constants';
@@ -17,6 +17,8 @@ export const waitForRenderComplete = async (
   layout: LayoutInstance,
   logger: LevelLogger
 ) => {
+  const endTrace = startTrace('wait_for_render', 'wait');
+
   logger.debug(
     i18n.translate('xpack.reporting.screencapture.waitingForRenderComplete', {
       defaultMessage: 'waiting for rendering to complete',
@@ -76,5 +78,7 @@ export const waitForRenderComplete = async (
           defaultMessage: 'rendering is complete',
         })
       );
+
+      endTrace();
     });
 };
diff --git a/...k/legacy/plugins/reporting/export_types/common/lib/screenshots/wait_for_visualizations.ts b/...k/legacy/plugins/reporting/export_types/common/lib/screenshots/wait_for_visualizations.ts
@@ -6,7 +6,7 @@
 
 import { i18n } from '@kbn/i18n';
 import { HeadlessChromiumDriver as HeadlessBrowser } from '../../../../server/browsers';
-import { LevelLogger } from '../../../../server/lib';
+import { LevelLogger, startTrace } from '../../../../server/lib';
 import { CaptureConfig } from '../../../../server/types';
 import { LayoutInstance } from '../../layouts/layout';
 import { CONTEXT_WAITFORELEMENTSTOBEINDOM } from './constants';
@@ -29,6 +29,7 @@ export const waitForVisualizations = async (
   layout: LayoutInstance,
   logger: LevelLogger
 ): Promise<void> => {
+  const endTrace = startTrace('wait_for_visualizations', 'wait');
   const { renderComplete: renderCompleteSelector } = layout.selectors;
 
   logger.debug(
@@ -63,4 +64,6 @@ export const waitForVisualizations = async (
       })
     );
   }
+
+  endTrace();
 };
diff --git a/x-pack/legacy/plugins/reporting/export_types/png/server/execute_job/index.test.ts b/x-pack/legacy/plugins/reporting/export_types/png/server/execute_job/index.test.ts
@@ -126,7 +126,7 @@ test(`returns content_type of application/png`, async () => {
   const encryptedHeaders = await encryptHeaders({});
 
   const generatePngObservable = (await generatePngObservableFactory(mockReporting)) as jest.Mock;
-  generatePngObservable.mockReturnValue(Rx.of(Buffer.from('')));
+  generatePngObservable.mockReturnValue(Rx.of('foo'));
 
   const { content_type: contentType } = await executeJob(
     'pngJobId',
@@ -137,10 +137,10 @@ test(`returns content_type of application/png`, async () => {
 });
 
 test(`returns content of generatePng getBuffer base64 encoded`, async () => {
-  const testContent = 'test content';
+  const testContent = 'raw string from get_screenhots';
 
   const generatePngObservable = (await generatePngObservableFactory(mockReporting)) as jest.Mock;
-  generatePngObservable.mockReturnValue(Rx.of({ buffer: Buffer.from(testContent) }));
+  generatePngObservable.mockReturnValue(Rx.of({ base64: testContent }));
 
   const executeJob = await executeJobFactory(mockReporting, getMockLogger());
   const encryptedHeaders = await encryptHeaders({});
@@ -150,5 +150,5 @@ test(`returns content of generatePng getBuffer base64 encoded`, async () => {
     cancellationToken
   );
 
-  expect(content).toEqual(Buffer.from(testContent).toString('base64'));
+  expect(content).toEqual(testContent);
 });
diff --git a/x-pack/legacy/plugins/reporting/export_types/png/server/execute_job/index.ts b/x-pack/legacy/plugins/reporting/export_types/png/server/execute_job/index.ts
@@ -4,6 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import apm from 'elastic-apm-node';
 import * as Rx from 'rxjs';
 import { catchError, map, mergeMap, takeUntil } from 'rxjs/operators';
 import { PNG_JOB_TYPE } from '../../../../common/constants';
@@ -29,6 +30,10 @@ export const executeJobFactory: QueuedPngExecutorFactory = async function execut
   const logger = parentLogger.clone([PNG_JOB_TYPE, 'execute']);
 
   return async function executeJob(jobId: string, job: JobDocPayloadPNG, cancellationToken: any) {
+    const apmTrans = apm.startTransaction('reporting execute_job png', 'reporting');
+    const apmGetAssets = apmTrans?.startSpan('get_assets', 'setup');
+    let apmGeneratePng: { end: () => void } | null | undefined;
+
     const generatePngObservable = await generatePngObservableFactory(reporting);
     const jobLogger = logger.clone([jobId]);
     const process$: Rx.Observable<JobDocOutput> = Rx.of(1).pipe(
@@ -38,6 +43,9 @@ export const executeJobFactory: QueuedPngExecutorFactory = async function execut
       mergeMap(conditionalHeaders => {
         const urls = getFullUrls({ config, job });
         const hashUrl = urls[0];
+        if (apmGetAssets) apmGetAssets.end();
+
+        apmGeneratePng = apmTrans?.startSpan('generate_png_pipeline', 'execute');
         return generatePngObservable(
           jobLogger,
           hashUrl,
@@ -46,11 +54,14 @@ export const executeJobFactory: QueuedPngExecutorFactory = async function execut
           job.layout
         );
       }),
-      map(({ buffer, warnings }) => {
+      map(({ base64, warnings }) => {
+        if (apmGeneratePng) apmGeneratePng.end();
+
         return {
           content_type: 'image/png',
-          content: buffer.toString('base64'),
-          size: buffer.byteLength,
+          content: base64,
+          size: (base64 && base64.length) || 0,
+
           warnings,
         };
       }),