[Index Management] Support Hidden Indices #66422
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,9 +3,9 @@ | |
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
| import { CatIndicesParams } from 'elasticsearch'; | ||
| import { IndexDataEnricher } from '../services'; | ||
| import { Index, CallAsCurrentUser } from '../types'; | ||
|
|
||
| interface Hit { | ||
| health: string; | ||
|
|
@@ -17,20 +17,64 @@ interface Hit { | |
| 'docs.count': any; | ||
| 'store.size': any; | ||
| sth: 'true' | 'false'; | ||
| hidden: boolean; | ||
| } | ||
|
|
||
| interface IndexInfo { | ||
| aliases: { [aliasName: string]: unknown }; | ||
| mappings: unknown; | ||
| settings: { | ||
| index: { | ||
| hidden: 'true' | 'false'; | ||
| }; | ||
| }; | ||
| } | ||
|
|
||
| interface GetIndicesResponse { | ||
| [indexName: string]: IndexInfo; | ||
| } | ||
|
|
||
| async function fetchIndicesCall( | ||
| callAsCurrentUser: CallAsCurrentUser, | ||
| indexNames?: string[] | ||
| ): Promise<Index[]> { | ||
| const indexNamesString = indexNames && indexNames.length ? indexNames.join(',') : '*'; | ||
|
|
||
| // This call retrieves alias and settings (incl. hidden status) information about indices | ||
| const indices: GetIndicesResponse = await callAsCurrentUser('transport.request', { | ||
| method: 'GET', | ||
| path: `/${indexNamesString}`, | ||
| query: { | ||
| expand_wildcards: 'hidden,all', | ||
| }, | ||
| }); | ||
|
|
||
| if (!Object.keys(indices).length) { | ||
|
There was a problem hiding this comment. If we know that the There was a problem hiding this comment. I spoke to @danhermann about this, he mentioned that both |
||
| return []; | ||
| } | ||
|
|
||
| const catQuery: Pick<CatIndicesParams, 'format' | 'h'> & { | ||
| expand_wildcards: string; | ||
| index?: string; | ||
| } = { | ||
| format: 'json', | ||
| h: 'health,status,index,uuid,pri,rep,docs.count,sth,store.size', | ||
| expand_wildcards: 'hidden,all', | ||
| index: indexNamesString, | ||
| }; | ||
|
|
||
| // This call retrieves health and other high-level information about indices. | ||
| const catHits: Hit[] = await callAsCurrentUser('transport.request', { | ||
| method: 'GET', | ||
| path: '/_cat/indices', | ||
| query: catQuery, | ||
| }); | ||
|
|
||
| // The two responses should be equal in the number of indices returned | ||
| return catHits.map(hit => { | ||
| const index = indices[hit.index]; | ||
| const aliases = Object.keys(index.aliases); | ||
|
|
||
| return { | ||
| health: hit.health, | ||
| status: hit.status, | ||
|
|
@@ -41,32 +85,17 @@ function formatHits(hits: Hit[], aliases: Aliases): Index[] { | |
| documents: hit['docs.count'], | ||
| size: hit['store.size'], | ||
| isFrozen: hit.sth === 'true', // sth value coming back as a string from ES | ||
| aliases: aliases.length ? aliases : 'none', | ||
| hidden: index.settings.index.hidden === 'true', | ||
| }; | ||
| }); | ||
| } | ||
|
|
||
| export const fetchIndices = async ( | ||
| callAsCurrentUser: CallAsCurrentUser, | ||
| indexDataEnricher: IndexDataEnricher, | ||
| indexNames?: string[] | ||
| ) => { | ||
| const indices = await fetchIndicesCall(callAsCurrentUser, indexNames); | ||
| return await indexDataEnricher.enrichIndices(indices, callAsCurrentUser); | ||
| }; | ||
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this also feel like you're reading the docs? 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😂 quite!