Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Exclude non-persisted sessions from SO migration #96938

Merged
merged 1 commit into from
Apr 13, 2021
Merged

Exclude non-persisted sessions from SO migration #96938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/core/server/saved_objects/migrations/core/elastic_index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,22 @@ describe('ElasticIndex', () => {
type: 'tsvb-validation-telemetry',
},
},
{
bool: {
must: [
{
match: {
type: 'search-session',
},
},
{
match: {
'search-session.persisted': false,
},
},
],
},
},
],
},
},
Expand Down
57 changes: 40 additions & 17 deletions src/core/server/saved_objects/migrations/core/elastic_index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,46 @@ export interface FullIndexInfo {
mappings: IndexMapping;
}

// When migrating from the outdated index we use a read query which excludes
// saved objects which are no longer used. These saved objects will still be
// kept in the outdated index for backup purposes, but won't be availble in
// the upgraded index.
export const excludeUnusedTypesQuery: estypes.QueryContainer = {
bool: {
must_not: [
// https://github.com/elastic/kibana/issues/91869
{
term: {
type: 'fleet-agent-events',
},
},
// https://github.com/elastic/kibana/issues/95617
{
term: {
type: 'tsvb-validation-telemetry',
},
},
// https://github.com/elastic/kibana/issues/96131
{
bool: {
must: [
{
match: {
type: 'search-session',
},
},
{
match: {
'search-session.persisted': false,
},
},
],
},
},
],
},
};

/**
* A slight enhancement to indices.get, that adds indexName, and validates that the
* index mappings are somewhat what we expect.
Expand Down Expand Up @@ -69,23 +109,6 @@ export function reader(
const scroll = scrollDuration;
let scrollId: string | undefined;

// When migrating from the outdated index we use a read query which excludes
// saved object types which are no longer used. These saved objects will
// still be kept in the outdated index for backup purposes, but won't be
// availble in the upgraded index.
const EXCLUDE_UNUSED_TYPES = [
'fleet-agent-events', // https://github.com/elastic/kibana/issues/91869
'tsvb-validation-telemetry', // https://github.com/elastic/kibana/issues/95617
];

const excludeUnusedTypesQuery = {
bool: {
must_not: EXCLUDE_UNUSED_TYPES.map((type) => ({
term: { type },
})),
},
};

const nextBatch = () =>
scrollId !== undefined
? client.scroll<SearchResponse<SavedObjectsRawDocSource>>({
Expand Down
1 change: 1 addition & 0 deletions src/core/server/saved_objects/migrations/core/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ export type { LogFn, SavedObjectsMigrationLogger } from './migration_logger';
export type { MigrationResult, MigrationStatus } from './migration_coordinator';
export { createMigrationEsClient } from './migration_es_client';
export type { MigrationEsClient } from './migration_es_client';
export { excludeUnusedTypesQuery } from './elastic_index';
15 changes: 5 additions & 10 deletions src/core/server/saved_objects/migrationsv2/actions/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import { errors as EsErrors } from '@elastic/elasticsearch';
import type { ElasticsearchClientError, ResponseError } from '@elastic/elasticsearch/lib/errors';
import { pipe } from 'fp-ts/lib/pipeable';
import { flow } from 'fp-ts/lib/function';
import { QueryContainer } from '@elastic/eui/src/components/search_bar/query/ast_to_es_query_dsl';
import { ElasticsearchClient } from '../../../elasticsearch';
import { IndexMapping } from '../../mappings';
import { SavedObjectsRawDoc, SavedObjectsRawDocSource } from '../../serialization';
Expand Down Expand Up @@ -440,9 +439,9 @@ export const reindex = (
requireAlias: boolean,
/* When reindexing we use a source query to exclude saved objects types which
* are no longer used. These saved objects will still be kept in the outdated
* index for backup purposes, but won't be availble in the upgraded index.
* index for backup purposes, but won't be available in the upgraded index.
*/
unusedTypesToExclude: Option.Option<string[]>
unusedTypesQuery: Option.Option<estypes.QueryContainer>
): TaskEither.TaskEither<RetryableEsClientError, ReindexResponse> => () => {
return client
.reindex({
Expand All @@ -457,14 +456,10 @@ export const reindex = (
// Set reindex batch size
size: BATCH_SIZE,
// Exclude saved object types
query: Option.fold<string[], QueryContainer | undefined>(
query: Option.fold<estypes.QueryContainer, estypes.QueryContainer | undefined>(
() => undefined,
(types) => ({
bool: {
must_not: types.map((type) => ({ term: { type } })),
},
})
)(unusedTypesToExclude),
(query) => query
)(unusedTypesQuery),
},
dest: {
index: targetIndex,
Expand Down
10 changes: 8 additions & 2 deletions src/core/server/saved_objects/migrationsv2/integration_tests/actions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,14 +416,20 @@ describe('migration actions', () => {
]
`);
});
it('resolves right and excludes all unusedTypesToExclude documents', async () => {
it('resolves right and excludes all documents not matching the unusedTypesQuery', async () => {
const res = (await reindex(
client,
'existing_index_with_docs',
'reindex_target_excluded_docs',
Option.none,
false,
Option.some(['f_agent_event', 'another_unused_type'])
Option.of({
bool: {
must_not: ['f_agent_event', 'another_unused_type'].map((type) => ({
term: { type },
})),
},
})
)()) as Either.Right<ReindexResponse>;
const task = waitForReindexTask(client, res.right.taskId, '10s');
await expect(task()).resolves.toMatchInlineSnapshot(`
Expand Down
152 changes: 132 additions & 20 deletions src/core/server/saved_objects/migrationsv2/migrations_state_action_machine.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,12 +254,40 @@ describe('migrationsStateActionMachine', () => {
},
},
},
"unusedTypesToExclude": Object {
"unusedTypesQuery": Object {
"_tag": "Some",
"value": Array [
"fleet-agent-events",
"tsvb-validation-telemetry",
],
"value": Object {
"bool": Object {
"must_not": Array [
Object {
"term": Object {
"type": "fleet-agent-events",
},
},
Object {
"term": Object {
"type": "tsvb-validation-telemetry",
},
},
Object {
"bool": Object {
"must": Array [
Object {
"match": Object {
"type": "search-session",
},
},
Object {
"match": Object {
"search-session.persisted": false,
},
},
],
},
},
],
},
},
},
"versionAlias": ".my-so-index_7.11.0",
"versionIndex": ".my-so-index_7.11.0_001",
Expand Down Expand Up @@ -322,12 +350,40 @@ describe('migrationsStateActionMachine', () => {
},
},
},
"unusedTypesToExclude": Object {
"unusedTypesQuery": Object {
"_tag": "Some",
"value": Array [
"fleet-agent-events",
"tsvb-validation-telemetry",
],
"value": Object {
"bool": Object {
"must_not": Array [
Object {
"term": Object {
"type": "fleet-agent-events",
},
},
Object {
"term": Object {
"type": "tsvb-validation-telemetry",
},
},
Object {
"bool": Object {
"must": Array [
Object {
"match": Object {
"type": "search-session",
},
},
Object {
"match": Object {
"search-session.persisted": false,
},
},
],
},
},
],
},
},
},
"versionAlias": ".my-so-index_7.11.0",
"versionIndex": ".my-so-index_7.11.0_001",
Expand Down Expand Up @@ -475,12 +531,40 @@ describe('migrationsStateActionMachine', () => {
},
},
},
"unusedTypesToExclude": Object {
"unusedTypesQuery": Object {
"_tag": "Some",
"value": Array [
"fleet-agent-events",
"tsvb-validation-telemetry",
],
"value": Object {
"bool": Object {
"must_not": Array [
Object {
"term": Object {
"type": "fleet-agent-events",
},
},
Object {
"term": Object {
"type": "tsvb-validation-telemetry",
},
},
Object {
"bool": Object {
"must": Array [
Object {
"match": Object {
"type": "search-session",
},
},
Object {
"match": Object {
"search-session.persisted": false,
},
},
],
},
},
],
},
},
},
"versionAlias": ".my-so-index_7.11.0",
"versionIndex": ".my-so-index_7.11.0_001",
Expand Down Expand Up @@ -538,12 +622,40 @@ describe('migrationsStateActionMachine', () => {
},
},
},
"unusedTypesToExclude": Object {
"unusedTypesQuery": Object {
"_tag": "Some",
"value": Array [
"fleet-agent-events",
"tsvb-validation-telemetry",
],
"value": Object {
"bool": Object {
"must_not": Array [
Object {
"term": Object {
"type": "fleet-agent-events",
},
},
Object {
"term": Object {
"type": "tsvb-validation-telemetry",
},
},
Object {
"bool": Object {
"must": Array [
Object {
"match": Object {
"type": "search-session",
},
},
Object {
"match": Object {
"search-session.persisted": false,
},
},
],
},
},
],
},
},
},
"versionAlias": ".my-so-index_7.11.0",
"versionIndex": ".my-so-index_7.11.0_001",
Expand Down
Loading