[Traces] Return 503 if opensearch calls failed (#2238)

(cherry picked from commit 8c0face) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Nov 2, 2024 · 08da159 · 08da159
1 parent e627394
commit 08da159
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 13 deletions.
diff --git a/server/plugin.ts b/server/plugin.ts
@@ -219,7 +219,12 @@ export class ObservabilityPlugin
     core.savedObjects.registerType(integrationTemplateType);
 
     // Register server side APIs
-    setupRoutes({ router, client: openSearchObservabilityClient, dataSourceEnabled });
+    setupRoutes({
+      router,
+      client: openSearchObservabilityClient,
+      dataSourceEnabled,
+      logger: this.logger,
+    });
 
     core.savedObjects.registerType(getVisualizationSavedObject(dataSourceEnabled));
     core.savedObjects.registerType(getSearchSavedObject(dataSourceEnabled));

diff --git a/server/routes/dsl.ts b/server/routes/dsl.ts
@@ -42,7 +42,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -71,7 +71,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -95,7 +95,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -119,7 +119,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -158,7 +158,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -194,7 +194,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -230,7 +230,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -263,7 +263,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }
@@ -298,7 +298,7 @@ export function registerDslRoute(
       } catch (error) {
         if (error.statusCode !== 404) console.error(error);
         return response.custom({
-          statusCode: error.statusCode || 500,
+          statusCode: error.statusCode === 500 ? 503 : error.statusCode || 503,
           body: error.message,
         });
       }

diff --git a/server/routes/index.ts b/server/routes/index.ts
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { ILegacyClusterClient, IRouter } from '../../../../src/core/server';
+import { ILegacyClusterClient, IRouter, Logger } from '../../../../src/core/server';
 import { DSLFacet } from '../services/facets/dsl_facet';
 import { PPLFacet } from '../services/facets/ppl_facet';
 import SavedObjectFacet from '../services/facets/saved_objects';
@@ -30,10 +30,12 @@ export function setupRoutes({
   router,
   client,
   dataSourceEnabled,
+  logger,
 }: {
   router: IRouter;
   client: ILegacyClusterClient;
   dataSourceEnabled: boolean;
+  logger: Logger;
 }) {
   PanelsRouter(router);
   VisualizationsRouter(router);
@@ -49,7 +51,7 @@ export function setupRoutes({
   registerParaRoute(router);
   registerNoteRoute(router);
   registerVizRoute(router, dataSourceEnabled);
-  const queryService = new QueryService(client);
+  const queryService = new QueryService(client, logger);
   registerSqlRoute(router, queryService, dataSourceEnabled);
 
   registerMetricsRoute(router, dataSourceEnabled);

diff --git a/server/services/queryService.ts b/server/services/queryService.ts
@@ -6,10 +6,11 @@
 import 'core-js/stable';
 import _ from 'lodash';
 import 'regenerator-runtime/runtime';
+import { Logger } from '../../../../src/core/server';
 
 export class QueryService {
   private client: any;
-  constructor(client: any) {
+  constructor(client: any, private readonly logger: Logger) {
     this.client = client;
   }