[APM] Add logic to use useSummaryField Prop for get Services endpoint (…

…elastic#168108) ## Summary Closes elastic#168031 - This PR includes a long list of files. But mostly they are tests and places which calls the `getServicesItems` function either directly or via the endpoint. We have introduced an additional parameter which is already present in other endpoints, which would make sure if `transaction.duration.summary` field is present, then use it for aggregations as its faster. In case of transaction events, it would fallback to `transaction.duration.histogram` - To keep the scope simple, API tests are simply setting `true/false`. Rule of thumb used here is, for function calls in API tests, which are using transaction events i am passing `useDurationSummary: false` and which are using metric, passing `useDurationSummary: true`. --------- Co-authored-by: kibanamachine <[email protected]>
ersin-erdal · Oct 10, 2023 · aa48e31 · aa48e31
1 parent 5ef9111
commit aa48e31
Show file tree

Hide file tree

Showing 17 changed files with 54 additions and 3 deletions.
diff --git a/x-pack/plugins/apm/public/components/app/service_inventory/index.tsx b/x-pack/plugins/apm/public/components/app/service_inventory/index.tsx
@@ -65,6 +65,8 @@ function useServicesMainStatisticsFetcher() {
     numBuckets: 20,
   });
 
+  const shouldUseDurationSummary = !!preferred?.source?.hasDurationSummaryField;
+
   const mainStatisticsFetch = useProgressiveFetcher(
     (callApmApi) => {
       if (preferred) {
@@ -76,6 +78,7 @@ function useServicesMainStatisticsFetcher() {
               start,
               end,
               serviceGroup,
+              useDurationSummary: shouldUseDurationSummary,
               documentType: preferred.source.documentType,
               rollupInterval: preferred.source.rollupInterval,
             },

diff --git a/x-pack/plugins/apm/server/routes/assistant_functions/route.ts b/x-pack/plugins/apm/server/routes/assistant_functions/route.ts
@@ -260,6 +260,7 @@ const getApmServicesListRoute = createApmServerRoute({
       rollupInterval: RollupInterval.OneMinute,
       serviceGroup: null,
       mlClient,
+      useDurationSummary: false,
     });
 
     let mappedItems = serviceItems.items.map((item): ApmServicesListItem => {

diff --git a/x-pack/plugins/apm/server/routes/services/get_services/get_service_transaction_stats.ts b/x-pack/plugins/apm/server/routes/services/get_services/get_service_transaction_stats.ts
@@ -44,6 +44,7 @@ interface AggregationParams {
     | ApmDocumentType.TransactionMetric
     | ApmDocumentType.TransactionEvent;
   rollupInterval: RollupInterval;
+  useDurationSummary: boolean;
 }
 
 export interface ServiceTransactionStatsResponse {
@@ -70,13 +71,17 @@ export async function getServiceTransactionStats({
   randomSampler,
   documentType,
   rollupInterval,
+  useDurationSummary,
 }: AggregationParams): Promise<ServiceTransactionStatsResponse> {
   const outcomes = getOutcomeAggregation(documentType);
 
   const metrics = {
     avg_duration: {
       avg: {
-        field: getDurationFieldForTransactions(documentType),
+        field: getDurationFieldForTransactions(
+          documentType,
+          useDurationSummary
+        ),
       },
     },
     ...outcomes,

diff --git a/x-pack/plugins/apm/server/routes/services/get_services/get_services_items.ts b/x-pack/plugins/apm/server/routes/services/get_services/get_services_items.ts
@@ -41,6 +41,7 @@ export async function getServicesItems({
   randomSampler,
   documentType,
   rollupInterval,
+  useDurationSummary,
 }: {
   environment: string;
   kuery: string;
@@ -54,6 +55,7 @@ export async function getServicesItems({
   randomSampler: RandomSampler;
   documentType: ApmServiceTransactionDocumentType;
   rollupInterval: RollupInterval;
+  useDurationSummary: boolean;
 }): Promise<ServicesItemsResponse> {
   return withApmSpan('get_services_items', async () => {
     const commonParams = {
@@ -66,6 +68,7 @@ export async function getServicesItems({
       randomSampler,
       documentType,
       rollupInterval,
+      useDurationSummary,
     };
 
     const [

diff --git a/x-pack/plugins/apm/server/routes/services/queries.test.ts b/x-pack/plugins/apm/server/routes/services/queries.test.ts
@@ -71,6 +71,7 @@ describe('services queries', () => {
             seed: 0,
           },
           apmAlertsClient: mockApmAlertsClient,
+          useDurationSummary: false,
         })
     );
 

diff --git a/x-pack/plugins/apm/server/routes/services/route.ts b/x-pack/plugins/apm/server/routes/services/route.ts
@@ -6,7 +6,12 @@
  */
 
 import Boom from '@hapi/boom';
-import { isoToEpochRt, jsonRt, toNumberRt } from '@kbn/io-ts-utils';
+import {
+  isoToEpochRt,
+  jsonRt,
+  toBooleanRt,
+  toNumberRt,
+} from '@kbn/io-ts-utils';
 import {
   InsufficientMLCapabilities,
   MLPrivilegesUninitialized,
@@ -105,7 +110,12 @@ const servicesRoute = createApmServerRoute({
       t.partial({ serviceGroup: t.string }),
       t.intersection([
         probabilityRt,
-        serviceTransactionDataSourceRt,
+        t.intersection([
+          serviceTransactionDataSourceRt,
+          t.type({
+            useDurationSummary: toBooleanRt,
+          }),
+        ]),
         environmentRt,
         kueryRt,
         rangeRt,
@@ -131,6 +141,7 @@ const servicesRoute = createApmServerRoute({
       probability,
       documentType,
       rollupInterval,
+      useDurationSummary,
     } = params.query;
     const savedObjectsClient = (await context.core).savedObjects.client;
 
@@ -163,6 +174,7 @@ const servicesRoute = createApmServerRoute({
       randomSampler,
       documentType,
       rollupInterval,
+      useDurationSummary,
     });
   },
 });

diff --git a/x-pack/test/apm_api_integration/tests/alerts/helpers/alerting_api_helper.ts b/x-pack/test/apm_api_integration/tests/alerts/helpers/alerting_api_helper.ts
@@ -71,6 +71,7 @@ export async function fetchServiceInventoryAlertCounts(apmApiClient: ApmApiClien
         probability: 1,
         documentType: ApmDocumentType.ServiceTransactionMetric,
         rollupInterval: RollupInterval.SixtyMinutes,
+        useDurationSummary: true,
       },
     },
   });

diff --git a/x-pack/test/apm_api_integration/tests/error_rate/service_apis.spec.ts b/x-pack/test/apm_api_integration/tests/error_rate/service_apis.spec.ts
@@ -51,10 +51,12 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               ? {
                   documentType: ApmDocumentType.TransactionMetric,
                   rollupInterval: RollupInterval.OneMinute,
+                  useDurationSummary: true,
                 }
               : {
                   documentType: ApmDocumentType.TransactionEvent,
                   rollupInterval: RollupInterval.None,
+                  useDurationSummary: false,
                 }),
           },
         },

diff --git a/x-pack/test/apm_api_integration/tests/error_rate/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/error_rate/service_maps.spec.ts
@@ -39,10 +39,12 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               ? {
                   documentType: ApmDocumentType.TransactionMetric,
                   rollupInterval: RollupInterval.OneMinute,
+                  useDurationSummary: true,
                 }
               : {
                   documentType: ApmDocumentType.TransactionEvent,
                   rollupInterval: RollupInterval.None,
+                  useDurationSummary: false,
                 }),
           },
         },

diff --git a/x-pack/test/apm_api_integration/tests/fleet/input_only_package.spec.ts b/x-pack/test/apm_api_integration/tests/fleet/input_only_package.spec.ts
@@ -189,6 +189,7 @@ function getApmServices(apmApiClient: ApmApiClient, start: string, end: string)
           kuery: '',
           documentType: ApmDocumentType.TransactionMetric,
           rollupInterval: RollupInterval.OneMinute,
+          useDurationSummary: true,
         },
       },
     });

diff --git a/x-pack/test/apm_api_integration/tests/latency/service_apis.spec.ts b/x-pack/test/apm_api_integration/tests/latency/service_apis.spec.ts
@@ -54,10 +54,12 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               ? {
                   documentType: ApmDocumentType.TransactionMetric,
                   rollupInterval: RollupInterval.OneMinute,
+                  useDurationSummary: true,
                 }
               : {
                   documentType: ApmDocumentType.TransactionEvent,
                   rollupInterval: RollupInterval.None,
+                  useDurationSummary: false,
                 }),
           },
         },

diff --git a/x-pack/test/apm_api_integration/tests/latency/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/latency/service_maps.spec.ts
@@ -39,10 +39,12 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               ? {
                   documentType: ApmDocumentType.TransactionMetric,
                   rollupInterval: RollupInterval.OneMinute,
+                  useDurationSummary: true,
                 }
               : {
                   documentType: ApmDocumentType.TransactionEvent,
                   rollupInterval: RollupInterval.None,
+                  useDurationSummary: false,
                 }),
           },
         },

diff --git a/x-pack/test/apm_api_integration/tests/observability_overview/observability_overview.spec.ts b/x-pack/test/apm_api_integration/tests/observability_overview/observability_overview.spec.ts
@@ -36,6 +36,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
             kuery: '',
             documentType: ApmDocumentType.TransactionMetric,
             rollupInterval: RollupInterval.OneMinute,
+            useDurationSummary: true,
           },
         },
       }),

diff --git a/...tion/tests/service_groups/service_group_with_overflow/service_group_with_overflow.spec.ts b/...tion/tests/service_groups/service_group_with_overflow/service_group_with_overflow.spec.ts
@@ -90,6 +90,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               probability: 1,
               documentType: ApmDocumentType.ServiceTransactionMetric,
               rollupInterval: RollupInterval.OneMinute,
+              useDurationSummary: true,
             },
           },
         });

diff --git a/x-pack/test/apm_api_integration/tests/services/top_services.spec.ts b/x-pack/test/apm_api_integration/tests/services/top_services.spec.ts
@@ -49,6 +49,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               probability: 1,
               documentType: ApmDocumentType.TransactionMetric,
               rollupInterval: RollupInterval.OneMinute,
+              useDurationSummary: true,
             },
           },
         });
@@ -192,6 +193,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.TransactionMetric,
                 rollupInterval: RollupInterval.OneMinute,
+                useDurationSummary: true,
               },
             },
           });
@@ -227,6 +229,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.TransactionMetric,
                 rollupInterval: RollupInterval.OneMinute,
+                useDurationSummary: true,
               },
             },
           });
@@ -264,6 +267,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.TransactionMetric,
                 rollupInterval: RollupInterval.OneMinute,
+                useDurationSummary: true,
               },
             },
           });
@@ -301,6 +305,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.TransactionMetric,
                 rollupInterval: RollupInterval.OneMinute,
+                useDurationSummary: true,
               },
             },
           });
@@ -328,6 +333,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.ServiceTransactionMetric,
                 rollupInterval: RollupInterval.OneMinute,
+                useDurationSummary: true,
               },
             },
           });
@@ -359,6 +365,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.TransactionMetric,
                 rollupInterval: RollupInterval.TenMinutes,
+                useDurationSummary: true,
               },
             },
           });
@@ -394,6 +401,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                   probability: 1,
                   documentType: ApmDocumentType.TransactionMetric,
                   rollupInterval: RollupInterval.OneMinute,
+                  useDurationSummary: true,
                 },
               },
             });
@@ -451,6 +459,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.TransactionMetric,
                 rollupInterval: RollupInterval.OneMinute,
+                useDurationSummary: true,
               },
             },
           });
@@ -487,6 +496,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
                 probability: 1,
                 documentType: ApmDocumentType.TransactionMetric,
                 rollupInterval: RollupInterval.OneMinute,
+                useDurationSummary: true,
               },
             },
           });

diff --git a/x-pack/test/apm_api_integration/tests/throughput/service_apis.spec.ts b/x-pack/test/apm_api_integration/tests/throughput/service_apis.spec.ts
@@ -47,10 +47,12 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               ? {
                   documentType: ApmDocumentType.TransactionMetric,
                   rollupInterval: RollupInterval.OneMinute,
+                  useDurationSummary: true,
                 }
               : {
                   documentType: ApmDocumentType.TransactionEvent,
                   rollupInterval: RollupInterval.None,
+                  useDurationSummary: false,
                 }),
           },
         },

diff --git a/x-pack/test/apm_api_integration/tests/throughput/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/throughput/service_maps.spec.ts
@@ -50,10 +50,12 @@ export default function ApiTest({ getService }: FtrProviderContext) {
               ? {
                   documentType: ApmDocumentType.TransactionMetric,
                   rollupInterval: RollupInterval.OneMinute,
+                  useDurationSummary: true,
                 }
               : {
                   documentType: ApmDocumentType.TransactionEvent,
                   rollupInterval: RollupInterval.None,
+                  useDurationSummary: false,
                 }),
           },
         },
-Original file line number
+Diff line change
@@ Expand Up / @@ -71,6 +71,7 @@ describe('services queries', () => { @@
                 seed: 0,
               },
               apmAlertsClient: mockApmAlertsClient,
+              useDurationSummary: false,
             })
         );
@@ Expand Down @@