[APM] Add kibana config for limiting the number of services in a service group (#131929)

* [APM] Add kibana config for the limit of number of services in a service group

* change kibana config label & description

* Allow only positive numbers for service group limit

* Add apm prefix to the kibana config

* fix a missing renaming

* revert back to using a constant when getting the list of service groups

* Parallelize uiSettings with setupRequest

* (Fix) Parallelizing getting the value from uiSettings with setupRequest

* delete uiSettingsClient usage from lookupServices

* Use kibana advanced config for limiting the number of services

Co-authored-by: Kibana Machine <[email protected]>
Co-authored-by: Miriam <[email protected]>

Author: 3 people

x-pack/plugins/apm/server/routes/service_groups/lookup_services.ts

@@ -14,18 +14,19 @@ import {
 } from '../../../common/elasticsearch_fieldnames';
 import { ProcessorEvent } from '../../../common/processor_event';
 import { Setup } from '../../lib/helpers/setup_request';
-import { MAX_NUMBER_OF_SERVICE_GROUPS } from '../../../common/service_groups';
 
 export async function lookupServices({
   setup,
   kuery,
   start,
   end,
+  maxNumberOfServices,
 }: {
   setup: Setup;
   kuery: string;
   start: number;
   end: number;
+  maxNumberOfServices: number;
 }) {
   const { apmEventClient } = setup;
 
@@ -49,7 +50,7 @@ export async function lookupServices({
         services: {
           terms: {
             field: SERVICE_NAME,
-            size: MAX_NUMBER_OF_SERVICE_GROUPS,
+            size: maxNumberOfServices,
           },
           aggs: {
             environments: {

x-pack/plugins/apm/server/routes/service_groups/route.ts

@@ -6,6 +6,7 @@
  */
 
 import * as t from 'io-ts';
+import { apmServiceGroupMaxNumberOfServices } from '@kbn/observability-plugin/common';
 import { setupRequest } from '../../lib/helpers/setup_request';
 import { createApmServerRoute } from '../apm_routes/create_apm_server_route';
 import { kueryRt, rangeRt } from '../default_api_types';
@@ -28,8 +29,12 @@ const serviceGroupsRoute = createApmServerRoute({
     resources
   ): Promise<{ serviceGroups: SavedServiceGroup[] }> => {
     const { context } = resources;
-    const savedObjectsClient = (await context.core).savedObjects.client;
-    const serviceGroups = await getServiceGroups({ savedObjectsClient });
+    const {
+      savedObjects: { client: savedObjectsClient },
+    } = await context.core;
+    const serviceGroups = await getServiceGroups({
+      savedObjectsClient,
+    });
     return { serviceGroups };
   },
 });
@@ -46,7 +51,9 @@ const serviceGroupRoute = createApmServerRoute({
   },
   handler: async (resources): Promise<{ serviceGroup: SavedServiceGroup }> => {
     const { context, params } = resources;
-    const savedObjectsClient = (await context.core).savedObjects.client;
+    const {
+      savedObjects: { client: savedObjectsClient },
+    } = await context.core;
     const serviceGroup = await getServiceGroup({
       savedObjectsClient,
       serviceGroupId: params.query.serviceGroup,
@@ -75,13 +82,21 @@ const serviceGroupSaveRoute = createApmServerRoute({
   handler: async (resources): Promise<void> => {
     const { context, params } = resources;
     const { start, end, serviceGroupId } = params.query;
-    const savedObjectsClient = (await context.core).savedObjects.client;
-    const setup = await setupRequest(resources);
+    const {
+      savedObjects: { client: savedObjectsClient },
+      uiSettings: { client: uiSettingsClient },
+    } = await context.core;
+    const [setup, maxNumberOfServices] = await Promise.all([
+      setupRequest(resources),
+      uiSettingsClient.get<number>(apmServiceGroupMaxNumberOfServices),
+    ]);
+
     const items = await lookupServices({
       setup,
       kuery: params.body.kuery,
       start,
       end,
+      maxNumberOfServices,
     });
     const serviceNames = items.map(({ serviceName }): string => serviceName);
     const serviceGroup: ServiceGroup = {
@@ -126,14 +141,21 @@ const serviceGroupServicesRoute = createApmServerRoute({
   handler: async (
     resources
   ): Promise<{ items: Awaited<ReturnType<typeof lookupServices>> }> => {
-    const { params } = resources;
+    const { params, context } = resources;
     const { kuery = '', start, end } = params.query;
-    const setup = await setupRequest(resources);
+    const {
+      uiSettings: { client: uiSettingsClient },
+    } = await context.core;
+    const [setup, maxNumberOfServices] = await Promise.all([
+      setupRequest(resources),
+      uiSettingsClient.get<number>(apmServiceGroupMaxNumberOfServices),
+    ]);
     const items = await lookupServices({
       setup,
       kuery,
       start,
       end,
+      maxNumberOfServices,
     });
     return { items };
   },

x-pack/plugins/apm/server/routes/service_map/get_service_map.ts

@@ -90,10 +90,17 @@ async function getConnectionData({
   });
 }
 
-async function getServicesData(options: IEnvOptions) {
-  const { environment, setup, searchAggregatedTransactions, start, end } =
-    options;
-
+async function getServicesData(
+  options: IEnvOptions & { maxNumberOfServices: number }
+) {
+  const {
+    environment,
+    setup,
+    searchAggregatedTransactions,
+    start,
+    end,
+    maxNumberOfServices,
+  } = options;
   const params = {
     apm: {
       events: [
@@ -117,7 +124,7 @@ async function getServicesData(options: IEnvOptions) {
         services: {
           terms: {
             field: SERVICE_NAME,
-            size: 500,
+            size: maxNumberOfServices,
           },
           aggs: {
             agent_name: {
@@ -156,7 +163,9 @@ async function getServicesData(options: IEnvOptions) {
 export type ConnectionsResponse = Awaited<ReturnType<typeof getConnectionData>>;
 export type ServicesResponse = Awaited<ReturnType<typeof getServicesData>>;
 
-export function getServiceMap(options: IEnvOptions) {
+export function getServiceMap(
+  options: IEnvOptions & { maxNumberOfServices: number }
+) {
   return withApmSpan('get_service_map', async () => {
     const { logger } = options;
     const anomaliesPromise = getServiceAnomalies(

x-pack/plugins/apm/server/routes/service_map/route.ts

@@ -7,6 +7,7 @@
 
 import Boom from '@hapi/boom';
 import * as t from 'io-ts';
+import { apmServiceGroupMaxNumberOfServices } from '@kbn/observability-plugin/common';
 import { isActivePlatinumLicense } from '../../../common/license_check';
 import { invalidLicenseMessage } from '../../../common/service_map';
 import { notifyFeatureUsage } from '../../feature';
@@ -109,15 +110,19 @@ const serviceMapRoute = createApmServerRoute({
       },
     } = params;
 
-    const savedObjectsClient = (await context.core).savedObjects.client;
-    const [setup, serviceGroup] = await Promise.all([
+    const {
+      savedObjects: { client: savedObjectsClient },
+      uiSettings: { client: uiSettingsClient },
+    } = await context.core;
+    const [setup, serviceGroup, maxNumberOfServices] = await Promise.all([
       setupRequest(resources),
       serviceGroupId
         ? getServiceGroup({
             savedObjectsClient,
             serviceGroupId,
           })
         : Promise.resolve(null),
+      uiSettingsClient.get<number>(apmServiceGroupMaxNumberOfServices),
     ]);
 
     const serviceNames = [
@@ -140,6 +145,7 @@ const serviceMapRoute = createApmServerRoute({
       logger,
       start,
       end,
+      maxNumberOfServices,
     });
   },
 });

x-pack/plugins/apm/server/routes/services/get_services/get_sorted_and_filtered_services.ts

@@ -22,13 +22,15 @@ export async function getSortedAndFilteredServices({
   environment,
   logger,
   serviceGroup,
+  maxNumberOfServices,
 }: {
   setup: Setup;
   start: number;
   end: number;
   environment: Environment;
   logger: Logger;
   serviceGroup: ServiceGroup | null;
+  maxNumberOfServices: number;
 }) {
   const { apmEventClient } = setup;
 
@@ -48,7 +50,7 @@ export async function getSortedAndFilteredServices({
           ],
         },
         body: {
-          size: 500,
+          size: maxNumberOfServices,
           field: SERVICE_NAME,
         },
       }

x-pack/plugins/apm/server/routes/services/route.ts

@@ -16,6 +16,7 @@ import {
 } from '@kbn/ml-plugin/server';
 import { ScopedAnnotationsClient } from '@kbn/observability-plugin/server';
 import { Annotation } from '@kbn/observability-plugin/common/annotations';
+import { apmServiceGroupMaxNumberOfServices } from '@kbn/observability-plugin/common';
 import { latencyAggregationTypeRt } from '../../../common/latency_aggregation_types';
 import { ProfilingValueType } from '../../../common/profiling';
 import { getSearchAggregatedTransactions } from '../../lib/helpers/transactions';
@@ -1220,14 +1221,17 @@ const sortedAndFilteredServicesRoute = createApmServerRoute({
       };
     }
 
-    const savedObjectsClient = (await resources.context.core).savedObjects
-      .client;
+    const {
+      savedObjects: { client: savedObjectsClient },
+      uiSettings: { client: uiSettingsClient },
+    } = await resources.context.core;
 
-    const [setup, serviceGroup] = await Promise.all([
+    const [setup, serviceGroup, maxNumberOfServices] = await Promise.all([
       setupRequest(resources),
       serviceGroupId
         ? getServiceGroup({ savedObjectsClient, serviceGroupId })
         : Promise.resolve(null),
+      uiSettingsClient.get<number>(apmServiceGroupMaxNumberOfServices),
     ]);
     return {
       services: await getSortedAndFilteredServices({
@@ -1237,6 +1241,7 @@ const sortedAndFilteredServicesRoute = createApmServerRoute({
         environment,
         logger: resources.logger,
         serviceGroup,
+        maxNumberOfServices,
       }),
     };
   },

x-pack/plugins/observability/common/index.ts

@@ -17,6 +17,7 @@ export {
   defaultApmServiceEnvironment,
   apmServiceInventoryOptimizedSorting,
   apmProgressiveLoading,
+  apmServiceGroupMaxNumberOfServices,
   apmTraceExplorerTab,
   apmOperationsTab,
 } from './ui_settings_keys';

x-pack/plugins/observability/common/ui_settings_keys.ts

@@ -15,5 +15,7 @@ export const apmProgressiveLoading = 'observability:apmProgressiveLoading';
 export const enableServiceGroups = 'observability:enableServiceGroups';
 export const apmServiceInventoryOptimizedSorting =
   'observability:apmServiceInventoryOptimizedSorting';
+export const apmServiceGroupMaxNumberOfServices =
+  'observability:apmServiceGroupMaxNumberOfServices';
 export const apmTraceExplorerTab = 'observability:apmTraceExplorerTab';
 export const apmOperationsTab = 'observability:apmOperationsTab';

x-pack/plugins/observability/public/index.ts

@@ -30,6 +30,7 @@ export {
   enableInfrastructureView,
   enableServiceGroups,
   enableNewSyntheticsView,
+  apmServiceGroupMaxNumberOfServices,
 } from '../common/ui_settings_keys';
 export { uptimeOverviewLocatorID } from '../common';
 

x-pack/plugins/observability/server/ui_settings.ts

@@ -19,6 +19,7 @@ import {
   enableServiceGroups,
   apmServiceInventoryOptimizedSorting,
   enableNewSyntheticsView,
+  apmServiceGroupMaxNumberOfServices,
   apmTraceExplorerTab,
   apmOperationsTab,
 } from '../common/ui_settings_keys';
@@ -189,6 +190,17 @@ export const uiSettings: Record<string, UiSettingsParams<boolean | number | stri
     requiresPageReload: false,
     type: 'boolean',
   },
+  [apmServiceGroupMaxNumberOfServices]: {
+    category: [observabilityFeatureId],
+    name: i18n.translate('xpack.observability.serviceGroupMaxServicesUiSettingName', {
+      defaultMessage: 'Maximum services in a service group',
+    }),
+    value: 500,
+    description: i18n.translate('xpack.observability.serviceGroupMaxServicesUiSettingDescription', {
+      defaultMessage: 'Limit the number of services in a given service group',
+    }),
+    schema: schema.number({ min: 1 }),
+  },
   [apmTraceExplorerTab]: {
     category: [observabilityFeatureId],
     name: i18n.translate('xpack.observability.apmTraceExplorerTab', {