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.

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

[7.6] [SIEM] Fixes FTUE when APM node is present (#56574) #56698

Merged
merged 1 commit into from
Feb 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,54 @@

import { FrameworkAdapter, FrameworkRequest } from '../framework';
import { SourceStatusAdapter } from './index';
import { buildQuery } from './query.dsl';
import { ApmServiceNameAgg } from './types';

const APM_INDEX_NAME = 'apm-*-transaction*';

export class ElasticsearchSourceStatusAdapter implements SourceStatusAdapter {
constructor(private readonly framework: FrameworkAdapter) {}

public async hasIndices(request: FrameworkRequest, indexNames: string | string[]) {
return this.framework
.callWithRequest(request, 'search', {
index: indexNames,
size: 0,
terminate_after: 1,
allow_no_indices: true,
})
.then(
response => response._shards.total > 0,
err => {
if (err.status === 404) {
return false;
}
throw err;
}
);
public async hasIndices(request: FrameworkRequest, indexNames: string[]) {
// Intended flow to determine app-empty state is to first check siem indices (as this is a quick shard count), and
// if no shards exist only then perform the heavier APM query. This optimizes for normal use when siem data exists
try {
// Remove APM index if exists, and only query if length > 0 in case it's the only index provided
const nonApmIndexNames = indexNames.filter(name => name !== APM_INDEX_NAME);
const indexCheckResponse = await (nonApmIndexNames.length > 0
? this.framework.callWithRequest(request, 'search', {
index: nonApmIndexNames,
size: 0,
terminate_after: 1,
allow_no_indices: true,
})
: Promise.resolve(undefined));

if ((indexCheckResponse?._shards.total ?? -1) > 0) {
return true;
}

// Note: Additional check necessary for APM-specific index. For details see: https://github.com/elastic/kibana/issues/56363
// Only verify if APM data exists if indexNames includes `apm-*-transaction*` (default included apm index)
const includesApmIndex = indexNames.includes(APM_INDEX_NAME);
const hasApmDataResponse = await (includesApmIndex
? this.framework.callWithRequest<{}, ApmServiceNameAgg>(
request,
'search',
buildQuery({ defaultIndex: [APM_INDEX_NAME] })
)
: Promise.resolve(undefined));

if ((hasApmDataResponse?.aggregations?.total_service_names?.value ?? -1) > 0) {
return true;
}
} catch (e) {
if (e.status === 404) {
return false;
}
throw e;
}

return false;
}
}
27 changes: 27 additions & 0 deletions x-pack/legacy/plugins/siem/server/lib/source_status/query.dsl.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

const SERVICE_NAME = 'service.name';

export const buildQuery = ({ defaultIndex }: { defaultIndex: string[] }) => {
return {
allowNoIndices: true,
index: defaultIndex,
ignoreUnavailable: true,
terminate_after: 1,
body: {
size: 0,
aggs: {
total_service_names: {
cardinality: {
field: SERVICE_NAME,
},
},
},
},
track_total_hits: false,
};
};
11 changes: 11 additions & 0 deletions x-pack/legacy/plugins/siem/server/lib/source_status/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

export interface ApmServiceNameAgg {
total_service_names: {
value: number;
};
}