[APM] Add table tabs showing summary of metrics (#153044)

Closes #146877 Notes: - Crash rate is calculated per sessions, the same session ID is kept after a crash, so a session can have more than one crash. - App number of launches is not available - Error rate stays out for now - Http requests, `host.os.version` and `service.version` is only available on transactions, metrics and errors. Not spans for now, there are two issues opened to fix this for the apm mobile agents team - Instead of the View Load (not available), we show Throughput - The filters (+ -) will be added in a follow-up PR Pending: - [x] API tests - [x] e2e tests https://user-images.githubusercontent.com/31922082/234267965-e5e1e411-87c6-40b8-9e94-31d792f9d806.mov --------- Co-authored-by: Yngrid Coello <[email protected]>
elastic · Apr 25, 2023 · b6a91f3 · b6a91f3
1 parent 3864554
commit b6a91f3
Show file tree

Hide file tree

Showing 27 changed files with 1,826 additions and 64 deletions.
diff --git a/packages/kbn-apm-synthtrace-client/src/lib/apm/apm_fields.ts b/packages/kbn-apm-synthtrace-client/src/lib/apm/apm_fields.ts
@@ -22,6 +22,7 @@ export type ApmApplicationMetricFields = Partial<{
   'faas.timeout': number;
   'faas.coldstart_duration': number;
   'faas.duration': number;
+  'application.launch.time': number;
 }>;
 
 export type ApmUserAgentFields = Partial<{
@@ -88,6 +89,7 @@ export type ApmFields = Fields<{
     'error.grouping_key': string;
     'error.grouping_name': string;
     'error.id': string;
+    'error.type': string;
     'event.ingested': number;
     'event.name': string;
     'event.outcome': string;

diff --git a/packages/kbn-apm-synthtrace-client/src/lib/apm/mobile_device.ts b/packages/kbn-apm-synthtrace-client/src/lib/apm/mobile_device.ts
@@ -9,8 +9,10 @@
 import { Entity } from '../entity';
 import { Span } from './span';
 import { Transaction } from './transaction';
-import { ApmFields, SpanParams, GeoLocation } from './apm_fields';
+import { ApmFields, SpanParams, GeoLocation, ApmApplicationMetricFields } from './apm_fields';
 import { generateLongId } from '../utils/generate_id';
+import { Metricset } from './metricset';
+import { ApmError } from './apm_error';
 
 export interface DeviceInfo {
   manufacturer: string;
@@ -115,6 +117,7 @@ export class MobileDevice extends Entity<ApmFields> {
     return this;
   }
 
+  // FIXME  synthtrace shouldn't have side-effects like this. We should use an API like .session() which returns a session
   startNewSession() {
     this.fields['session.id'] = generateLongId();
     return this;
@@ -238,4 +241,21 @@ export class MobileDevice extends Entity<ApmFields> {
 
     return this.span(spanParameters);
   }
+
+  appMetrics(metrics: ApmApplicationMetricFields) {
+    return new Metricset<ApmFields>({
+      ...this.fields,
+      'metricset.name': 'app',
+      ...metrics,
+    });
+  }
+
+  crash({ message, groupingName }: { message: string; groupingName?: string }) {
+    return new ApmError({
+      ...this.fields,
+      'error.type': 'crash',
+      'error.exception': [{ message, ...{ type: 'crash' } }],
+      'error.grouping_name': groupingName || message,
+    });
+  }
 }
diff --git a/packages/kbn-apm-synthtrace/src/scenarios/mobile.ts b/packages/kbn-apm-synthtrace/src/scenarios/mobile.ts
@@ -20,6 +20,16 @@ const ENVIRONMENT = getSynthtraceEnvironment(__filename);
 
 type DeviceMetadata = DeviceInfo & OSInfo;
 
+const modelIdentifiersWithCrashes = [
+  'SM-G930F',
+  'HUAWEI P2-0000',
+  'Pixel 3a',
+  'LG K10',
+  'iPhone11,8',
+  'Watch6,8',
+  'iPad12,2',
+];
+
 const ANDROID_DEVICES: DeviceMetadata[] = [
   {
     manufacturer: 'Samsung',
@@ -354,34 +364,40 @@ const scenario: Scenario<ApmFields> = async ({ scenarioOpts, logger }) => {
           device.startNewSession();
           const framework =
             device.fields['device.manufacturer'] === 'Apple' ? 'iOS' : 'Android Activity';
+          const couldCrash = modelIdentifiersWithCrashes.includes(
+            device.fields['device.model.identifier'] ?? ''
+          );
+          const startTx = device
+            .transaction('Start View - View Appearing', framework)
+            .timestamp(timestamp)
+            .duration(500)
+            .success()
+            .children(
+              device
+                .span({
+                  spanName: 'onCreate',
+                  spanType: 'app',
+                  spanSubtype: 'external',
+                  'service.target.type': 'http',
+                  'span.destination.service.resource': 'external',
+                })
+                .duration(50)
+                .success()
+                .timestamp(timestamp + 20),
+              device
+                .httpSpan({
+                  spanName: 'GET backend:1234',
+                  httpMethod: 'GET',
+                  httpUrl: 'https://backend:1234/api/start',
+                })
+                .duration(800)
+                .failure()
+                .timestamp(timestamp + 400)
+            );
           return [
-            device
-              .transaction('Start View - View Appearing', framework)
-              .timestamp(timestamp)
-              .duration(500)
-              .success()
-              .children(
-                device
-                  .span({
-                    spanName: 'onCreate',
-                    spanType: 'app',
-                    spanSubtype: 'external',
-                    'service.target.type': 'http',
-                    'span.destination.service.resource': 'external',
-                  })
-                  .duration(50)
-                  .success()
-                  .timestamp(timestamp + 20),
-                device
-                  .httpSpan({
-                    spanName: 'GET backend:1234',
-                    httpMethod: 'GET',
-                    httpUrl: 'https://backend:1234/api/start',
-                  })
-                  .duration(800)
-                  .failure()
-                  .timestamp(timestamp + 400)
-              ),
+            couldCrash && index % 2 === 0
+              ? startTx.errors(device.crash({ message: 'error' }).timestamp(timestamp))
+              : startTx,
             device
               .transaction('Second View - View Appearing', framework)
               .timestamp(10000 + timestamp)
@@ -418,7 +434,23 @@ const scenario: Scenario<ApmFields> = async ({ scenarioOpts, logger }) => {
         });
       };
 
-      return [...androidDevices, ...iOSDevices].map((device) => sessionTransactions(device));
+      const appLaunchMetrics = (device: MobileDevice) => {
+        return clickRate.generator((timestamp, index) =>
+          device
+            .appMetrics({
+              'application.launch.time': 100 * (index + 1),
+            })
+            .timestamp(timestamp)
+        );
+      };
+
+      return [
+        ...androidDevices.flatMap((device) => [
+          sessionTransactions(device),
+          appLaunchMetrics(device),
+        ]),
+        ...iOSDevices.map((device) => sessionTransactions(device)),
+      ];
     },
   };
 };

diff --git a/x-pack/plugins/apm/common/data_source.ts b/x-pack/plugins/apm/common/data_source.ts
@@ -13,7 +13,8 @@ type AnyApmDocumentType =
   | ApmDocumentType.TransactionMetric
   | ApmDocumentType.TransactionEvent
   | ApmDocumentType.ServiceDestinationMetric
-  | ApmDocumentType.ServiceSummaryMetric;
+  | ApmDocumentType.ServiceSummaryMetric
+  | ApmDocumentType.ErrorEvent;
 
 export interface ApmDataSource<
   TDocumentType extends AnyApmDocumentType = AnyApmDocumentType

diff --git a/x-pack/plugins/apm/common/document_type.ts b/x-pack/plugins/apm/common/document_type.ts
@@ -11,6 +11,7 @@ export enum ApmDocumentType {
   TransactionEvent = 'transactionEvent',
   ServiceDestinationMetric = 'serviceDestinationMetric',
   ServiceSummaryMetric = 'serviceSummaryMetric',
+  ErrorEvent = 'error',
 }
 
 export type ApmServiceTransactionDocumentType =

diff --git a/x-pack/plugins/apm/common/es_fields/__snapshots__/es_fields.test.ts.snap b/x-pack/plugins/apm/common/es_fields/__snapshots__/es_fields.test.ts.snap
diff --git a/x-pack/plugins/apm/common/es_fields/apm.ts b/x-pack/plugins/apm/common/es_fields/apm.ts
@@ -109,6 +109,7 @@ export const ERROR_EXC_MESSAGE = 'error.exception.message'; // only to be used i
 export const ERROR_EXC_HANDLED = 'error.exception.handled'; // only to be used in es queries, since error.exception is now an array
 export const ERROR_EXC_TYPE = 'error.exception.type';
 export const ERROR_PAGE_URL = 'error.page.url';
+export const ERROR_TYPE = 'error.type';
 
 // METRICS
 export const METRIC_SYSTEM_FREE_MEMORY = 'system.memory.actual.free';