Skip to content

Commit

Permalink
[8.7] Fix csv generation when search:includeFrozen is enabled (#152354
Browse files Browse the repository at this point in the history
) (#152901)

# Backport

This will backport the following commits from `main` to `8.7`:
- [Fix csv generation when `search:includeFrozen` is enabled
(#152354)](#152354)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Anton
Dosov","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-03-08T12:26:16Z","message":"Fix
csv generation when `search:includeFrozen` is enabled (#152354)\n\nfix
https://github.com/elastic/kibana/issues/151546\r\nsee:
https://github.com/elastic/kibana/issues/151546#issuecomment-1443996912\r\n\r\n\r\nSince
it isn't possible to freeze an index in 8.x to test you have
to\r\ncreate an index and freeze it in 7.x and then upgrade to
8.x.","sha":"00e0f5cae3911fec2491d3bba7684365fe74fdb5","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Feature:Reporting","Team:SharedUX","backport:prev-minor","v8.8.0"],"number":152354,"url":"https://github.com/elastic/kibana/pull/152354","mergeCommit":{"message":"Fix
csv generation when `search:includeFrozen` is enabled (#152354)\n\nfix
https://github.com/elastic/kibana/issues/151546\r\nsee:
https://github.com/elastic/kibana/issues/151546#issuecomment-1443996912\r\n\r\n\r\nSince
it isn't possible to freeze an index in 8.x to test you have
to\r\ncreate an index and freeze it in 7.x and then upgrade to
8.x.","sha":"00e0f5cae3911fec2491d3bba7684365fe74fdb5"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/152354","number":152354,"mergeCommit":{"message":"Fix
csv generation when `search:includeFrozen` is enabled (#152354)\n\nfix
https://github.com/elastic/kibana/issues/151546\r\nsee:
https://github.com/elastic/kibana/issues/151546#issuecomment-1443996912\r\n\r\n\r\nSince
it isn't possible to freeze an index in 8.x to test you have
to\r\ncreate an index and freeze it in 7.x and then upgrade to
8.x.","sha":"00e0f5cae3911fec2491d3bba7684365fe74fdb5"}}]}] BACKPORT-->

Co-authored-by: Anton Dosov <[email protected]>
  • Loading branch information
kibanamachine and Dosant authored Mar 8, 2023
1 parent e70452f commit 9428e82
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -819,11 +819,20 @@ it('can override ignoring frozen indices', async () => {

await generateCsv.generateData();

expect(mockEsClient.asCurrentUser.openPointInTime).toHaveBeenCalledWith(
{
ignore_unavailable: true,
ignore_throttled: false,
index: 'logstash-*',
keep_alive: '30s',
},
{ maxRetries: 0, requestTimeout: '30s' }
);

expect(mockDataClient.search).toBeCalledWith(
{
params: {
body: {},
ignore_throttled: false,
},
},
{ strategy: 'es', transport: { maxRetries: 0, requestTimeout: '30s' } }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ export class CsvGenerator {
index: indexPatternTitle,
keep_alive: duration,
ignore_unavailable: true,
// TODO: currently this doesn't do anything as es has a bug that throttled indices are always included when using PIT api
// if es fixes the issue, everything should work as expected. Just needs to be tested and this comment removed
// if es decides to not fix, then we can close the issue and remove the `ignore_throttled` code from here
// https://github.com/elastic/kibana/issues/152884
// @ts-expect-error ignore_throttled is not in the type definition, but it is accepted by es
ignore_throttled: settings.includeFrozen ? false : undefined, // "true" will cause deprecation warnings logged in ES
},
{
requestTimeout: duration,
Expand All @@ -91,7 +97,7 @@ export class CsvGenerator {
settings: CsvExportSettings,
searchAfter?: estypes.SortResults
) {
const { scroll: scrollSettings, includeFrozen } = settings;
const { scroll: scrollSettings } = settings;
searchSource.setField('size', scrollSettings.size);

if (searchAfter) {
Expand All @@ -112,7 +118,6 @@ export class CsvGenerator {
const searchParams = {
params: {
body: searchBody,
ignore_throttled: includeFrozen ? false : undefined, // "true" will cause deprecation warnings logged in ES
},
};

Expand Down

0 comments on commit 9428e82

Please sign in to comment.