forked from opensearch-project/OpenSearch-Dashboards
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Manual backport 2.x] Add support for async ppl to discover (opensear…
…ch-project#8706) Backport PR: opensearch-project#8706 From original PR: * add support for async ppl to discover Signed-off-by: Shenoy Pratik <[email protected]> * Changeset file for PR opensearch-project#8706 created/updated * update s3_type test to add PPL as supported lang Signed-off-by: Shenoy Pratik <[email protected]> * fix lint error Signed-off-by: Shenoy Pratik <[email protected]> --------- Signed-off-by: Shenoy Pratik <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
- Loading branch information
Showing
11 changed files
with
139 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| feat: | ||
| - Add support for async ppl to discover ([#8706](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8706)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
src/plugins/query_enhancements/server/search/ppl_async_search_strategy.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { ILegacyClusterClient, Logger, SharedGlobalConfig } from 'opensearch-dashboards/server'; | ||
| import { Observable } from 'rxjs'; | ||
| import { | ||
| createDataFrame, | ||
| DATA_FRAME_TYPES, | ||
| IDataFrameResponse, | ||
| IOpenSearchDashboardsSearchRequest, | ||
| Query, | ||
| } from '../../../data/common'; | ||
| import { ISearchStrategy, SearchUsage } from '../../../data/server'; | ||
| import { buildQueryStatusConfig, getFields, handleFacetError, SEARCH_STRATEGY } from '../../common'; | ||
| import { Facet } from '../utils'; | ||
|
|
||
| export const pplAsyncSearchStrategyProvider = ( | ||
| config$: Observable<SharedGlobalConfig>, | ||
| logger: Logger, | ||
| client: ILegacyClusterClient, | ||
| usage?: SearchUsage | ||
| ): ISearchStrategy<IOpenSearchDashboardsSearchRequest, IDataFrameResponse> => { | ||
| const pplAsyncFacet = new Facet({ | ||
| client, | ||
| logger, | ||
| endpoint: 'enhancements.runDirectQuery', | ||
| }); | ||
| const pplAsyncJobsFacet = new Facet({ | ||
| client, | ||
| logger, | ||
| endpoint: 'enhancements.getJobStatus', | ||
| useJobs: true, | ||
| }); | ||
|
|
||
| return { | ||
| search: async (context, request: any, options) => { | ||
| try { | ||
| const query: Query = request.body.query; | ||
| const pollQueryResultsParams = request.body.pollQueryResultsParams; | ||
| const inProgressQueryId = pollQueryResultsParams?.queryId; | ||
|
|
||
| if (!inProgressQueryId) { | ||
| request.body = { ...request.body, lang: SEARCH_STRATEGY.PPL }; | ||
| const rawResponse: any = await pplAsyncFacet.describeQuery(context, request); | ||
|
|
||
| if (!rawResponse.success) handleFacetError(rawResponse); | ||
|
|
||
| const statusConfig = buildQueryStatusConfig(rawResponse); | ||
|
|
||
| return { | ||
| type: DATA_FRAME_TYPES.POLLING, | ||
| status: 'started', | ||
| body: { | ||
| queryStatusConfig: statusConfig, | ||
| }, | ||
| } as IDataFrameResponse; | ||
| } else { | ||
| request.params = { queryId: inProgressQueryId }; | ||
| const queryStatusResponse: any = await pplAsyncJobsFacet.describeQuery(context, request); | ||
| const queryStatus = queryStatusResponse?.data?.status; | ||
| logger.info(`pplAsyncSearchStrategy: JOB: ${inProgressQueryId} - STATUS: ${queryStatus}`); | ||
|
|
||
| if (queryStatus?.toUpperCase() === 'SUCCESS') { | ||
| const dataFrame = createDataFrame({ | ||
| name: query.dataset?.id, | ||
| schema: queryStatusResponse.data.schema, | ||
| meta: { ...pollQueryResultsParams }, | ||
| fields: getFields(queryStatusResponse), | ||
| }); | ||
|
|
||
| dataFrame.size = queryStatusResponse.data.datarows.length; | ||
|
|
||
| return { | ||
| type: DATA_FRAME_TYPES.POLLING, | ||
| status: 'success', | ||
| body: dataFrame, | ||
| } as IDataFrameResponse; | ||
| } else if (queryStatus?.toUpperCase() === 'FAILED') { | ||
| return { | ||
| type: DATA_FRAME_TYPES.POLLING, | ||
| status: 'failed', | ||
| body: { | ||
| error: `JOB: ${inProgressQueryId} failed: ${queryStatusResponse.data.error}`, | ||
| }, | ||
| } as IDataFrameResponse; | ||
| } | ||
|
|
||
| return { | ||
| type: DATA_FRAME_TYPES.POLLING, | ||
| status: queryStatus, | ||
| } as IDataFrameResponse; | ||
| } | ||
| } catch (e: any) { | ||
| logger.error(`pplAsyncSearchStrategy: ${e.message}`); | ||
| if (usage) usage.trackError(); | ||
| throw e; | ||
| } | ||
| }, | ||
| }; | ||
| }; |