[Synthetics] Schema configuration and Server side changes for CCS settings

packages/kbn-check-saved-objects-cli/current_fields.json

@@ -1341,6 +1341,7 @@
   ],
   "spaces-usage-stats": [],
   "stream-prompts": [],
+  "synthetics-ccs-settings": [],
   "synthetics-dynamic-settings": [],
   "synthetics-monitor": [
     "alert",

packages/kbn-check-saved-objects-cli/current_mappings.json

@@ -4403,6 +4403,10 @@
     "dynamic": false,
     "properties": {}
   },
+  "synthetics-ccs-settings": {
+    "dynamic": false,
+    "properties": {}
+  },
   "synthetics-dynamic-settings": {
     "dynamic": false,
     "properties": {}

src/core/packages/saved-objects/server-internal/src/object_types/index.ts

@@ -11,4 +11,4 @@ export { registerCoreObjectTypes } from './registration';
 
 // set minimum number of registered saved objects to ensure no object types are removed after 8.8
 // declared in internal implementation explicitly to prevent unintended changes.
-export const SAVED_OBJECT_TYPES_COUNT = 155 as const;
+export const SAVED_OBJECT_TYPES_COUNT = 156 as const;

src/core/server/integration_tests/ci_checks/saved_objects/check_registered_types.test.ts

@@ -187,6 +187,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "space": "a3792f667888f8a976a742c941bd6db28d027604eccc854986a5ec2515f44483",
         "spaces-usage-stats": "f692e8d75a0ac9187bfbf237e1b5aa6f9a028cf5569a3df2f9e0e96e625b6215",
         "stream-prompts": "25d761054f4e6c60362ef73da19e1bee4c22bcf79e858bdb11ef3eb7f433c66c",
+        "synthetics-ccs-settings": "a749c676195ab02b21fca8488de09b1f6be5c88805b1a68fd5be69fc8525075b",
         "synthetics-dynamic-settings": "30883b9647f119e1d4529f49bc0fee459c56f62489993cd7f2397ffcb8608e63",
         "synthetics-monitor": "19af677892a5eac45b3d1903c083cb222d8898d69ee545eaf079522b0bbbb85b",
         "synthetics-monitor-multi-space": "9159e968b4c011ee11fe7887572e883e0928c4b4b0924d672c77003cfdf01fe0",
@@ -1247,6 +1248,11 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "stream-prompts|10.2.0: a79e6825ccd534ba98f6b8ce45357da62f162efe3fbad1d0c2c7d3c0f8d1e48c",
         "stream-prompts|10.1.0: ba35cffdf735265c1b4bc2652c4ea22c74e81fafb58a5c67eba53a4ec3e821bc",
         "=======================================================================================",
+        "synthetics-ccs-settings|global: 16e0ec35935c7ad1af8b0fda068c471452cb4ca7",
+        "synthetics-ccs-settings|mappings: e1b10e5bec060a176469a5e9a4f80c94e23abcd7",
+        "synthetics-ccs-settings|schemas: da39a3ee5e6b4b0d3255bfef95601890afd80709",
+        "synthetics-ccs-settings|10.1.0: 0c41207f2cf98a296785c7bbb2a631d6dc8236519a99be5bdbd2f21f6dd752e6",
+        "================================================================================================",
         "synthetics-dynamic-settings|global: 79542e96ca9347188221391c3c7157ee5e8daefc",
         "synthetics-dynamic-settings|mappings: e1b10e5bec060a176469a5e9a4f80c94e23abcd7",
         "synthetics-dynamic-settings|schemas: da39a3ee5e6b4b0d3255bfef95601890afd80709",
@@ -1540,6 +1546,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "space": "10.2.0",
         "spaces-usage-stats": "10.0.0",
         "stream-prompts": "10.3.0",
+        "synthetics-ccs-settings": "10.1.0",
         "synthetics-dynamic-settings": "10.0.0",
         "synthetics-monitor": "10.2.0",
         "synthetics-monitor-multi-space": "10.0.0",
@@ -1705,6 +1712,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "space": "10.2.0",
         "spaces-usage-stats": "7.14.1",
         "stream-prompts": "10.3.0",
+        "synthetics-ccs-settings": "10.1.0",
         "synthetics-dynamic-settings": "0.0.0",
         "synthetics-monitor": "10.2.0",
         "synthetics-monitor-multi-space": "10.0.0",

src/core/server/integration_tests/saved_objects/registration/type_registrations.test.ts

@@ -166,6 +166,7 @@ const previouslyRegisteredTypes = [
   'space',
   'spaces-usage-stats',
   'stream-prompts',
+  'synthetics-ccs-settings',
   'synthetics-monitor',
   'synthetics-monitor-multi-space',
   'synthetics-param',

x-pack/solutions/observability/plugins/synthetics/common/constants/synthetics/rest_api.ts

@@ -69,4 +69,6 @@ export enum SYNTHETICS_API_URLS {
 
   INSPECT_STATUS_RULE = '/internal/synthetics/inspect_status_rule',
   INSPECT_TLS_RULE = '/internal/synthetics/inspect_tls_rule',
+
+  CCS_SETTINGS = '/internal/synthetics/ccs_settings',
 }

x-pack/solutions/observability/plugins/synthetics/common/get_synthetics_indices.test.ts

@@ -0,0 +1,74 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { SYNTHETICS_INDEX_PATTERN } from './constants';
+import { getSyntheticsIndices } from './get_synthetics_indices';
+
+describe('getSyntheticsIndices', () => {
+  it('returns only the local index when CCS is disabled', () => {
+    const result = getSyntheticsIndices({
+      useAllRemoteClusters: false,
+      selectedRemoteClusters: [],
+    });
+    expect(result).toStrictEqual([SYNTHETICS_INDEX_PATTERN]);
+  });
+
+  it('returns a wildcard remote and the local index when useAllRemoteClusters is true', () => {
+    const result = getSyntheticsIndices({
+      useAllRemoteClusters: true,
+      selectedRemoteClusters: [],
+      remoteClusters: [
+        { name: 'cluster1', isConnected: true },
+        { name: 'cluster2', isConnected: true },
+      ],
+    });
+    expect(result).toStrictEqual([SYNTHETICS_INDEX_PATTERN, `*:${SYNTHETICS_INDEX_PATTERN}`]);
+  });
+
+  it('returns only connected clusters from the selected list', () => {
+    const result = getSyntheticsIndices({
+      useAllRemoteClusters: false,
+      selectedRemoteClusters: ['cluster1', 'cluster3'],
+      remoteClusters: [
+        { name: 'cluster1', isConnected: true },
+        { name: 'cluster2', isConnected: true },
+        { name: 'cluster3', isConnected: false },
+      ],
+    });
+    expect(result).toStrictEqual([
+      SYNTHETICS_INDEX_PATTERN,
+      `cluster1:${SYNTHETICS_INDEX_PATTERN}`,
+    ]);
+  });
+
+  it('excludes clusters not in the selected list even if connected', () => {
+    const result = getSyntheticsIndices({
+      useAllRemoteClusters: false,
+      selectedRemoteClusters: ['cluster1'],
+      remoteClusters: [
+        { name: 'cluster1', isConnected: true },
+        { name: 'cluster2', isConnected: true },
+      ],
+    });
+    expect(result).toStrictEqual([
+      SYNTHETICS_INDEX_PATTERN,
+      `cluster1:${SYNTHETICS_INDEX_PATTERN}`,
+    ]);
+  });
+
+  it('returns only the local index when selected clusters are all disconnected', () => {
+    const result = getSyntheticsIndices({
+      useAllRemoteClusters: false,
+      selectedRemoteClusters: ['cluster1', 'cluster2'],
+      remoteClusters: [
+        { name: 'cluster1', isConnected: false },
+        { name: 'cluster2', isConnected: false },
+      ],
+    });
+    expect(result).toStrictEqual([SYNTHETICS_INDEX_PATTERN]);
+  });
+});

x-pack/solutions/observability/plugins/synthetics/common/get_synthetics_indices.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { SYNTHETICS_INDEX_PATTERN } from './constants';
+
+interface Props {
+  useAllRemoteClusters: boolean;
+  selectedRemoteClusters: string[];
+  remoteClusters?: Array<{ name: string; isConnected: boolean }>;
+}
+
+/**
+ * @returns the local synthetics index or the remote cluster indices based on the CCS settings.
+ * If `useAllRemoteClusters` is false and no remote clusters are selected, returns only the local index.
+ * If `useAllRemoteClusters` is true, returns both the local index and a wildcard remote index.
+ * If specific clusters are selected, returns the local index plus indices for connected selected clusters.
+ */
+export const getSyntheticsIndices = ({
+  useAllRemoteClusters,
+  selectedRemoteClusters,
+  remoteClusters = [],
+}: Props): string[] => {
+  if (!useAllRemoteClusters && selectedRemoteClusters.length === 0) {
+    return [SYNTHETICS_INDEX_PATTERN];
+  }
+
+  if (useAllRemoteClusters) {
+    return [SYNTHETICS_INDEX_PATTERN, `*:${SYNTHETICS_INDEX_PATTERN}`];
+  }
+
+  return remoteClusters.reduce(
+    (acc, { name, isConnected }) => {
+      if (isConnected && selectedRemoteClusters.includes(name)) {
+        acc.push(`${name}:${SYNTHETICS_INDEX_PATTERN}`);
+      }
+      return acc;
+    },
+    [SYNTHETICS_INDEX_PATTERN] as string[]
+  );
+};

x-pack/solutions/observability/plugins/synthetics/common/runtime_types/ccs_settings.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import * as t from 'io-ts';
+
+export const remoteSyntheticsClusterSchema = t.type({
+  name: t.string,
+  isConnected: t.boolean,
+});
+
+export const syntheticsCCSSettingsSchema = t.type({
+  useAllRemoteClusters: t.boolean,
+  selectedRemoteClusters: t.array(t.string),
+  remoteKibanaUrls: t.record(t.string, t.string),
+});
+
+export type RemoteSyntheticsCluster = t.TypeOf<typeof remoteSyntheticsClusterSchema>;
+export type SyntheticsCCSSettings = t.TypeOf<typeof syntheticsCCSSettingsSchema>;

x-pack/solutions/observability/plugins/synthetics/common/runtime_types/index.ts

@@ -15,3 +15,5 @@ export * from './network_events';
 export * from './monitor_management';
 export * from './monitor_management/synthetics_private_locations';
 export * from './monitor_health';
+export * from './ccs_settings';
+export * from './remote';

x-pack/solutions/observability/plugins/synthetics/common/runtime_types/monitor_management/synthetics_overview_status.ts

@@ -9,6 +9,7 @@ import * as t from 'io-ts';
 import { ObserverCodec } from '../ping/observer';
 import { ErrorStateCodec } from '../ping/error_state';
 import { AgentType, MonitorType, PingErrorType, UrlType } from '..';
+import { remoteMonitorInfoSchema } from '../remote';
 
 export const OverviewPingCodec = t.intersection([
   t.interface({
@@ -55,6 +56,7 @@ export const OverviewStatusMetaDataCodec = t.intersection([
     spaces: t.array(t.string),
     urls: t.string,
     maintenanceWindows: t.array(t.string),
+    remote: remoteMonitorInfoSchema,
   }),
 ]);
 

x-pack/solutions/observability/plugins/synthetics/common/runtime_types/ping/ping.ts

@@ -10,6 +10,7 @@ import { ObserverCodec } from './observer';
 import { ErrorStateCodec } from './error_state';
 import { DateRangeType } from '../common';
 import { SyntheticsDataType } from './synthetics';
+import { remoteMonitorInfoSchema } from '../remote';
 
 // IO type for validation
 export const PingErrorType = t.intersection([
@@ -239,6 +240,7 @@ export const PingType = t.intersection([
       dataset: t.string,
     }),
     labels: t.record(t.string, t.string),
+    remote: remoteMonitorInfoSchema,
   }),
 ]);
 

x-pack/solutions/observability/plugins/synthetics/common/runtime_types/remote.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import * as t from 'io-ts';
+
+export const remoteMonitorInfoSchema = t.type({
+  remoteName: t.string,
+  kibanaUrl: t.string,
+});
+
+export type RemoteMonitorInfo = t.TypeOf<typeof remoteMonitorInfoSchema>;

x-pack/solutions/observability/plugins/synthetics/public/apps/synthetics/components/settings/page_header.tsx

@@ -10,21 +10,24 @@ import { useRouteMatch } from 'react-router-dom';
 import type { EuiPageHeaderProps } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
 import { SYNTHETICS_SETTINGS_ROUTE } from '../../../../../common/constants';
+import { useSyntheticsSettingsContext } from '../../contexts';
 
 export type SettingsTabId =
   | 'data-retention'
   | 'params'
   | 'alerting'
   | 'private-locations'
   | 'api-keys'
-  | 'advanced';
+  | 'advanced'
+  | 'remote-clusters';
 
 export const getSettingsPageHeader = (
   history: ReturnType<typeof useHistory>,
   syntheticsPath: string
 ): EuiPageHeaderProps => {
   // Not a component, but it doesn't matter. Hooks are just functions
   const match = useRouteMatch<{ tabId: SettingsTabId }>(SYNTHETICS_SETTINGS_ROUTE); // eslint-disable-line react-hooks/rules-of-hooks
+  const { isServerless, isCCSEnabled } = useSyntheticsSettingsContext(); // eslint-disable-line react-hooks/rules-of-hooks
 
   if (!match) {
     return {};
@@ -84,6 +87,17 @@ export const getSettingsPageHeader = (
         isSelected: tabId === 'advanced',
         href: replaceTab('advanced'),
       },
+      ...(!isServerless && isCCSEnabled
+        ? [
+            {
+              label: i18n.translate('xpack.synthetics.settingsTabs.remoteClusters', {
+                defaultMessage: 'Remote Clusters',
+              }),
+              isSelected: tabId === 'remote-clusters',
+              href: replaceTab('remote-clusters'),
+            },
+          ]
+        : []),
     ],
   };
 };

x-pack/solutions/observability/plugins/synthetics/public/apps/synthetics/components/settings/remote_clusters/hooks/use_get_ccs_settings.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { useContext } from 'react';
+import { useFetcher } from '@kbn/observability-shared-plugin/public';
+import type { SyntheticsCCSSettings } from '../../../../../../../common/runtime_types';
+import { SYNTHETICS_API_URLS } from '../../../../../../../common/constants';
+import { apiService } from '../../../../../../utils/api_service';
+import { SyntheticsRefreshContext } from '../../../../contexts';
+
+export const DEFAULT_CCS_SETTINGS: SyntheticsCCSSettings = {
+  useAllRemoteClusters: false,
+  selectedRemoteClusters: [],
+  remoteKibanaUrls: {},
+};
+
+const fetchCCSSettings = async () => {
+  try {
+    return await apiService.get<SyntheticsCCSSettings>(SYNTHETICS_API_URLS.CCS_SETTINGS);
+  } catch (e) {
+    return DEFAULT_CCS_SETTINGS;
+  }
+};
+
+export const useGetCCSSettings = () => {
+  const { lastRefresh } = useContext(SyntheticsRefreshContext);
+
+  const { data, error, loading } = useFetcher(fetchCCSSettings, [lastRefresh]);
+
+  return {
+    data: data ?? DEFAULT_CCS_SETTINGS,
+    error,
+    loading,
+  };
+};