[Feature] Initial Live Queries Dashboard

common/utils/QueryUtils.ts

@@ -3,16 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { SearchQueryRecord } from '../../types/types';
+import { SearchQueryRecord, LiveSearchQueryResponse } from '../../types/types';
+import { API_ENDPOINTS } from './apiendpoints';
 
 // Utility function to fetch query by id and time range
 export const retrieveQueryById = async (
   core: { http: { get: (endpoint: string, params: any) => Promise<any> } },
   dataSourceId: string,
   start: string | null,
   end: string | null,
-  id: string | null,
-  verbose: boolean
+  id: string | null
 ): Promise<SearchQueryRecord | null> => {
   const nullResponse = { response: { top_queries: [] } };
   const params = {
@@ -21,7 +21,6 @@
       from: start,
       to: end,
       id,
-      verbose,
     },
   };
 
@@ -63,3 +62,32 @@
     return null;
   }
 };
+
+export const retrieveLiveQueries = async (core: {
+  http: { get: (endpoint: string) => Promise<any> };
+}): Promise<LiveSearchQueryResponse> => {
+  const nullResponse: LiveSearchQueryResponse = {
+    ok: true,
+    response: { live_queries: [] },
+  };
+
+  const errorResponse: LiveSearchQueryResponse = {
+    ok: false,
+    response: { live_queries: [] },
+  };
+
+  try {
+    const response: LiveSearchQueryResponse = await core.http.get(API_ENDPOINTS.LIVE_QUERIES);
+    const liveQueries = response?.response?.live_queries;
+
+    if (Array.isArray(liveQueries)) {
+      return response;
+    } else {
+      console.warn('No live queries found in response');
+      return nullResponse;
+    }
+  } catch (error) {
+    console.error('Error retrieving live queries:', error);
+    return errorResponse;
+  }
+};

common/utils/apiendpoints.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const API_ENDPOINTS = {
+  LIVE_QUERIES: '/api/live_queries',
+  CANCEL_TASK: (taskId: string) => `/api/tasks/${taskId}/cancel`,
+};

cypress/e2e/3_configurations.cy.js

@@ -32,8 +32,9 @@ describe('Query Insights Configurations Page', () => {
     cy.get('h1').contains('Query insights - Configuration').should('be.visible');
     // Validate the tabs
     cy.get('.euiTabs').should('be.visible');
-    cy.get('.euiTab').should('have.length', 2); // Two tabs: 'Top N queries' and 'Configuration'
+    cy.get('.euiTab').should('have.length', 3); // Three tabs: 'Top N queries', 'Live queries' and 'Configuration'
     cy.contains('button', 'Top N queries').should('be.visible');
+    cy.contains('button', 'Live queries').should('be.visible');
     cy.contains('button', 'Configuration').should('have.class', 'euiTab-isSelected');
     // Validate the panels
     // 6 panels: Settings, Status, Group Settings, Group Status, Delete After Settings, Delete After Status