[Logs onboarding] Removing custom_logs from routes and making them mo…

…re generic (#162706) This PR is a preparation work for #154929. ### Changes: - Rearranged code to make routes more generic (Most of the changes). - Added `type` to onboarding savedObject. - Removed `status` route since it was not being used.
elastic · Aug 1, 2023 · 378cd6f · 378cd6f
1 parent 132139e
commit 378cd6f
Show file tree

Hide file tree

Showing 29 changed files with 227 additions and 249 deletions.
diff --git a/packages/kbn-check-mappings-update-cli/current_mappings.json b/packages/kbn-check-mappings-update-cli/current_mappings.json
@@ -2249,6 +2249,9 @@
   },
   "observability-onboarding-state": {
     "properties": {
+      "type": {
+        "type": "keyword"
+      },
       "state": {
         "type": "object",
         "dynamic": false

diff --git a/...e/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts b/...e/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts
@@ -120,7 +120,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "ml-module": "2225cbb4bd508ea5f69db4b848be9d8a74b60198",
         "ml-trained-model": "482195cefd6b04920e539d34d7356d22cb68e4f3",
         "monitoring-telemetry": "5d91bf75787d9d4dd2fae954d0b3f76d33d2e559",
-        "observability-onboarding-state": "55b112d6a33fedb7c1e4fec4da768d2bcc5fadc2",
+        "observability-onboarding-state": "c18631f47a0da568f12f859c9ab9d4ca73bdff7c",
         "osquery-manager-usage-metric": "983bcbc3b7dda0aad29b20907db233abba709bcc",
         "osquery-pack": "6ab4358ca4304a12dcfc1777c8135b75cffb4397",
         "osquery-pack-asset": "b14101d3172c4b60eb5404696881ce5275c84152",

diff --git a/x-pack/plugins/observability_onboarding/public/assets/standalone_agent_setup.sh b/x-pack/plugins/observability_onboarding/public/assets/standalone_agent_setup.sh
@@ -55,7 +55,7 @@ updateStepProgress() {
   local STATUS="$2" # "incomplete" | "complete" | "disabled" | "loading" | "warning" | "danger" | "current"
   local MESSAGE=${3:-}
   curl --request POST \
-    --url "${API_ENDPOINT}/custom_logs/${ONBOARDING_ID}/step/${STEPNAME}" \
+    --url "${API_ENDPOINT}/flow/${ONBOARDING_ID}/step/${STEPNAME}" \
     --header "Authorization: ApiKey ${API_KEY_ENCODED}" \
     --header "Content-Type: application/json" \
     --header "kbn-xsrf: true" \

diff --git a/...gins/observability_onboarding/public/components/app/custom_logs/wizard/api_key_banner.tsx b/...gins/observability_onboarding/public/components/app/custom_logs/wizard/api_key_banner.tsx
@@ -21,7 +21,7 @@ import React from 'react';
 import { APIReturnType } from '../../../../services/rest/create_call_api';
 
 type ApiKeyPayload =
-  APIReturnType<'POST /internal/observability_onboarding/custom_logs/save'>;
+  APIReturnType<'POST /internal/observability_onboarding/logs/flow'>;
 
 export type HasPrivileges = boolean;
 

diff --git a/...servability_onboarding/public/components/app/custom_logs/wizard/install_elastic_agent.tsx b/...servability_onboarding/public/components/app/custom_logs/wizard/install_elastic_agent.tsx
@@ -60,7 +60,7 @@ export function InstallElasticAgent() {
     (callApi) => {
       if (!hasAlreadySavedFlow(getState())) {
         return callApi(
-          'GET /internal/observability_onboarding/custom_logs/privileges'
+          'GET /internal/observability_onboarding/logs/setup/privileges'
         );
       }
     },
@@ -69,7 +69,7 @@ export function InstallElasticAgent() {
 
   const { data: setup } = useFetcher((callApi) => {
     return callApi(
-      'GET /internal/observability_onboarding/custom_logs/install_shipper_setup'
+      'GET /internal/observability_onboarding/logs/setup/environment'
     );
   }, []);
 
@@ -87,23 +87,20 @@ export function InstallElasticAgent() {
         logFilePaths,
       } = getState();
       if (!hasAlreadySavedFlow(getState()) && monitoringRole?.hasPrivileges) {
-        return callApi(
-          'POST /internal/observability_onboarding/custom_logs/save',
-          {
-            params: {
-              body: {
-                name: datasetName,
-                state: {
-                  datasetName,
-                  serviceName,
-                  namespace,
-                  customConfigurations,
-                  logFilePaths,
-                },
+        return callApi('POST /internal/observability_onboarding/logs/flow', {
+          params: {
+            body: {
+              name: datasetName,
+              state: {
+                datasetName,
+                serviceName,
+                namespace,
+                customConfigurations,
+                logFilePaths,
               },
             },
-          }
-        );
+          },
+        });
       }
     },
     [monitoringRole?.hasPrivileges]
@@ -120,7 +117,7 @@ export function InstallElasticAgent() {
     } = getState();
     if (onboardingId) {
       return callApi(
-        'PUT /internal/observability_onboarding/custom_logs/{onboardingId}/save',
+        'PUT /internal/observability_onboarding/flow/{onboardingId}',
         {
           params: {
             path: { onboardingId },
@@ -173,7 +170,7 @@ export function InstallElasticAgent() {
     (callApi) => {
       if (onboardingId) {
         return callApi(
-          'GET /internal/observability_onboarding/custom_logs/{onboardingId}/progress',
+          'GET /internal/observability_onboarding/flow/{onboardingId}/progress',
           { params: { path: { onboardingId } } }
         );
       }

diff --git a/...r/routes/custom_logs/get_fallback_urls.ts → ...nboarding/server/lib/get_fallback_urls.ts b/...r/routes/custom_logs/get_fallback_urls.ts → ...nboarding/server/lib/get_fallback_urls.ts
@@ -6,7 +6,7 @@
  */
 
 import { CoreStart } from '@kbn/core/server';
-import { EsLegacyConfigService } from '../../services/es_legacy_config_service';
+import { EsLegacyConfigService } from '../services/es_legacy_config_service';
 
 export function getFallbackKibanaUrl({ http }: CoreStart) {
   const basePath = http.basePath;

diff --git a/...ogs/get_observability_onboarding_state.ts → ...tate/get_observability_onboarding_flow.ts b/...ogs/get_observability_onboarding_state.ts → ...tate/get_observability_onboarding_flow.ts
@@ -7,20 +7,20 @@
 
 import { SavedObjectsClientContract } from '@kbn/core/server';
 import {
+  ObservabilityOnboardingFlow,
   OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
-  ObservabilityOnboardingState,
-  SavedObservabilityOnboardingState,
+  SavedObservabilityOnboardingFlow,
 } from '../../saved_objects/observability_onboarding_status';
 
-export async function getObservabilityOnboardingState({
+export async function getObservabilityOnboardingFlow({
   savedObjectsClient,
   savedObjectId,
 }: {
   savedObjectsClient: SavedObjectsClientContract;
   savedObjectId: string;
-}): Promise<SavedObservabilityOnboardingState | undefined> {
+}): Promise<SavedObservabilityOnboardingFlow | undefined> {
   try {
-    const result = await savedObjectsClient.get<ObservabilityOnboardingState>(
+    const result = await savedObjectsClient.get<ObservabilityOnboardingFlow>(
       OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
       savedObjectId
     );

diff --git a/x-pack/plugins/observability_onboarding/server/lib/state/index.ts b/x-pack/plugins/observability_onboarding/server/lib/state/index.ts
@@ -0,0 +1,9 @@
+/*
+ * 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.
+ */
+
+export * from './get_observability_onboarding_flow';
+export * from './save_observability_onboarding_flow';
diff --git a/...gs/save_observability_onboarding_state.ts → ...ate/save_observability_onboarding_flow.ts b/...gs/save_observability_onboarding_state.ts → ...ate/save_observability_onboarding_flow.ts
@@ -8,35 +8,36 @@
 import { SavedObjectsClientContract, SavedObject } from '@kbn/core/server';
 import {
   OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
-  ObservabilityOnboardingState,
-  SavedObservabilityOnboardingState,
+  ObservabilityOnboardingFlow,
+  SavedObservabilityOnboardingFlow,
 } from '../../saved_objects/observability_onboarding_status';
 
 interface Options {
   savedObjectsClient: SavedObjectsClientContract;
-  observabilityOnboardingState: ObservabilityOnboardingState;
+  observabilityOnboardingState: ObservabilityOnboardingFlow;
   savedObjectId?: string;
 }
-export async function saveObservabilityOnboardingState({
+export async function saveObservabilityOnboardingFlow({
   savedObjectsClient,
   observabilityOnboardingState,
   savedObjectId,
-}: Options): Promise<SavedObservabilityOnboardingState> {
+}: Options): Promise<SavedObservabilityOnboardingFlow> {
   let savedObject: Omit<
-    SavedObject<ObservabilityOnboardingState>,
+    SavedObject<ObservabilityOnboardingFlow>,
     'attributes' | 'references'
   >;
   if (savedObjectId) {
-    savedObject = await savedObjectsClient.update<ObservabilityOnboardingState>(
+    savedObject = await savedObjectsClient.update<ObservabilityOnboardingFlow>(
       OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
       savedObjectId,
       {
+        type: observabilityOnboardingState.type,
         state: observabilityOnboardingState.state,
         progress: { ...observabilityOnboardingState.progress },
       }
     );
   } else {
-    savedObject = await savedObjectsClient.create<ObservabilityOnboardingState>(
+    savedObject = await savedObjectsClient.create<ObservabilityOnboardingFlow>(
       OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
       observabilityOnboardingState
     );

diff --git a/x-pack/plugins/observability_onboarding/server/plugin.ts b/x-pack/plugins/observability_onboarding/server/plugin.ts
@@ -23,7 +23,7 @@ import {
   ObservabilityOnboardingPluginStartDependencies,
 } from './types';
 import { ObservabilityOnboardingConfig } from '.';
-import { observabilityOnboardingState } from './saved_objects/observability_onboarding_status';
+import { observabilityOnboardingFlow } from './saved_objects/observability_onboarding_status';
 import { EsLegacyConfigService } from './services/es_legacy_config_service';
 
 export class ObservabilityOnboardingPlugin
@@ -52,7 +52,7 @@ export class ObservabilityOnboardingPlugin
     this.logger.debug('observability_onboarding: Setup');
     this.esLegacyConfigService.setup(core.elasticsearch.legacy.config$);
 
-    core.savedObjects.registerType(observabilityOnboardingState);
+    core.savedObjects.registerType(observabilityOnboardingFlow);
 
     const resourcePlugins = mapValues(plugins, (value, key) => {
       return {

diff --git a/...bility_onboarding/server/routes/custom_logs/find_latest_observability_onboarding_state.ts b/...bility_onboarding/server/routes/custom_logs/find_latest_observability_onboarding_state.ts
diff --git a/x-pack/plugins/observability_onboarding/server/routes/elastic_agent/route.ts b/x-pack/plugins/observability_onboarding/server/routes/elastic_agent/route.ts
@@ -8,9 +8,9 @@
 import * as t from 'io-ts';
 import { getAuthenticationAPIKey } from '../../lib/get_authentication_api_key';
 import { createObservabilityOnboardingServerRoute } from '../create_observability_onboarding_server_route';
-import { getObservabilityOnboardingState } from '../custom_logs/get_observability_onboarding_state';
 import { generateYml } from './generate_yml';
-import { getFallbackESUrl } from '../custom_logs/get_fallback_urls';
+import { getFallbackESUrl } from '../../lib/get_fallback_urls';
+import { getObservabilityOnboardingFlow } from '../../lib/state';
 
 const generateConfig = createObservabilityOnboardingServerRoute({
   endpoint: 'GET /internal/observability_onboarding/elastic_agent/config',
@@ -38,22 +38,22 @@ const generateConfig = createObservabilityOnboardingServerRoute({
       ? [plugins.cloud?.setup?.elasticsearchUrl]
       : await getFallbackESUrl(esLegacyConfigService);
 
-    const savedState = await getObservabilityOnboardingState({
+    const savedState = await getObservabilityOnboardingFlow({
       savedObjectsClient,
       savedObjectId: onboardingId,
     });
 
     const yaml = generateYml({
-      datasetName: savedState?.state.datasetName,
-      customConfigurations: savedState?.state.customConfigurations,
-      logFilePaths: savedState?.state.logFilePaths,
-      namespace: savedState?.state.namespace,
+      datasetName: savedState?.state?.datasetName,
+      customConfigurations: savedState?.state?.customConfigurations,
+      logFilePaths: savedState?.state?.logFilePaths,
+      namespace: savedState?.state?.namespace,
       apiKey: authApiKey
         ? `${authApiKey?.apiKeyId}:${authApiKey?.apiKey}`
         : '$API_KEY',
       esHost: elasticsearchUrl,
       logfileId: `custom-logs-${Date.now()}`,
-      serviceName: savedState?.state.serviceName,
+      serviceName: savedState?.state?.serviceName,
     });
 
     return yaml;

diff --git a/...server/routes/custom_logs/get_has_logs.ts → ...arding/server/routes/flow/get_has_logs.ts b/...server/routes/custom_logs/get_has_logs.ts → ...arding/server/routes/flow/get_has_logs.ts