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

[APM] Replace ML index queries with searching via mlAnomalySearch API #69099

Merged
merged 3 commits into from
Jun 17, 2020
Merged

[APM] Replace ML index queries with searching via mlAnomalySearch API #69099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2524b40
Closes #69092 by replacing direct queries on ml indices with seaching
ogupte Jun 13, 2020
02949d9
Use the mlCapabilities API to ensure the required license is active f…
ogupte Jun 13, 2020
3dfe09d
Merge branch 'master' into apm-69092-use-ml-anomaly-search-client
elasticmachine Jun 15, 2020
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
11 changes: 0 additions & 11 deletions x-pack/plugins/apm/common/ml_job_constants.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
*/

import {
getMlIndex,
getMlJobId,
getMlPrefix,
getMlJobServiceName,
Expand Down Expand Up @@ -36,16 +35,6 @@ describe('ml_job_constants', () => {
);
});

it('getMlIndex', () => {
expect(getMlIndex('myServiceName')).toBe(
'.ml-anomalies-myservicename-high_mean_response_time'
);

expect(getMlIndex('myServiceName', 'myTransactionType')).toBe(
'.ml-anomalies-myservicename-mytransactiontype-high_mean_response_time'
);
});

describe('getMlJobServiceName', () => {
it('extracts the service name from a job id', () => {
expect(
Expand Down
4 changes: 0 additions & 4 deletions x-pack/plugins/apm/common/ml_job_constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ export function getMlJobServiceName(jobId: string) {
return jobId.split('-').slice(0, -2).join('-');
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is getMlJobServiceName still used? I thought we had stopped parsing the job id and was not instead solely relying on the job groups?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar with getMlPrefix and getMlJobId: I think we should be able to get rid of them.

getMlPrefix is only used in

kibana/x-pack/plugins/apm/public/services/rest/ml.ts

Line 72 in 04b8a49

prefix: getMlPrefix(serviceName, transactionType),

and I don't think we should be splitting ml jobs in different indices. We should be able to remove the prefix entirely.

getMlJobId should simply be a random id. A job should be retrieved based on groups - not the job id.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are already adding service name and transaction type to the groups so in theory this change is backwards compatible.

kibana/x-pack/plugins/apm/public/services/rest/ml.ts

Lines 58 to 62 in 04b8a49

const groups = [
APM_ML_JOB_GROUP_NAME,
encodeForMlApi(serviceName),
encodeForMlApi(transactionType),
];

One backwards incompatible change I would like us to make though, is to prefix groups with a property name:

 const groups = [ 
   `app:apm`, 
   `service.name:${encodeForMlApi(serviceName)}`, 
   `transaction.type:${encodeForMlApi(transactionType)}`, 
 ];

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed on all these point. I held off since the templated job id is still used in the client-side ml integration, but i can update it to make them job_id agnostic and introduce keyed:group strings in the context of this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's sync with the rest of the team before doing the breaking changes (like prefixes)


export function getMlIndex(serviceName: string, transactionType?: string) {
return `.ml-anomalies-${getMlJobId(serviceName, transactionType)}`;
}

export function encodeForMlApi(value: string) {
return value.replace(/\s+/g, '_').toLowerCase();
}
Expand Down
6 changes: 5 additions & 1 deletion ...ns/apm/server/lib/transactions/charts/get_anomaly_data/__snapshots__/fetcher.test.ts.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 19 additions & 3 deletions x-pack/plugins/apm/server/lib/transactions/charts/get_anomaly_data/fetcher.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ describe('anomalyAggsFetcher', () => {
intervalString: 'myInterval',
mlBucketSize: 10,
setup: {
client: { search: clientSpy },
ml: {
mlSystem: {
mlAnomalySearch: clientSpy,
},
} as any,
start: 100000,
end: 200000,
} as any,
Expand All @@ -42,7 +46,13 @@ describe('anomalyAggsFetcher', () => {

return expect(
anomalySeriesFetcher({
setup: { client: { search: failedRequestSpy } },
setup: {
ml: {
mlSystem: {
mlAnomalySearch: failedRequestSpy,
},
} as any,
},
} as any)
).resolves.toEqual(undefined);
});
Expand All @@ -53,7 +63,13 @@ describe('anomalyAggsFetcher', () => {

return expect(
anomalySeriesFetcher({
setup: { client: { search: failedRequestSpy } },
setup: {
ml: {
mlSystem: {
mlAnomalySearch: failedRequestSpy,
},
} as any,
},
} as any)
).rejects.toThrow(otherError);
});
Expand Down
12 changes: 8 additions & 4 deletions x-pack/plugins/apm/server/lib/transactions/charts/get_anomaly_data/fetcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { getMlIndex } from '../../../../../common/ml_job_constants';
import { getMlJobId } from '../../../../../common/ml_job_constants';
import { PromiseReturnType } from '../../../../../../observability/typings/common';
import { Setup, SetupTimeRange } from '../../../helpers/setup_request';

Expand All @@ -26,19 +26,23 @@ export async function anomalySeriesFetcher({
mlBucketSize: number;
setup: Setup & SetupTimeRange;
}) {
const { client, start, end } = setup;
const { ml, start, end } = setup;
if (!ml) {
return;
}

// move the start back with one bucket size, to ensure to get anomaly data in the beginning
// this is required because ML has a minimum bucket size (default is 900s) so if our buckets are smaller, we might have several null buckets in the beginning
const newStart = start - mlBucketSize * 1000;
const jobId = getMlJobId(serviceName, transactionType);

const params = {
index: getMlIndex(serviceName, transactionType),
body: {
size: 0,
query: {
bool: {
filter: [
{ term: { job_id: jobId } },
{ exists: { field: 'bucket_span' } },
{
range: {
Expand Down Expand Up @@ -74,7 +78,7 @@ export async function anomalySeriesFetcher({
};

try {
const response = await client.search(params);
const response = await ml.mlSystem.mlAnomalySearch(params);
return response;
} catch (err) {
const isHttpError = 'statusCode' in err;
Expand Down
13 changes: 9 additions & 4 deletions x-pack/plugins/apm/server/lib/transactions/charts/get_anomaly_data/get_ml_bucket_size.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { getMlIndex } from '../../../../../common/ml_job_constants';
import { getMlJobId } from '../../../../../common/ml_job_constants';
import { Setup, SetupTimeRange } from '../../../helpers/setup_request';

interface IOptions {
Expand All @@ -22,15 +22,20 @@ export async function getMlBucketSize({
transactionType,
setup,
}: IOptions): Promise<number> {
const { client, start, end } = setup;
const { ml, start, end } = setup;
if (!ml) {
return 0;
}
const jobId = getMlJobId(serviceName, transactionType);

const params = {
index: getMlIndex(serviceName, transactionType),
body: {
_source: 'bucket_span',
size: 1,
query: {
bool: {
filter: [
{ term: { job_id: jobId } },
{ exists: { field: 'bucket_span' } },
{
range: {
Expand All @@ -48,7 +53,7 @@ export async function getMlBucketSize({
};

try {
const resp = await client.search<ESResponse, typeof params>(params);
const resp = await ml.mlSystem.mlAnomalySearch<ESResponse>(params);
return resp.hits.hits[0]?._source.bucket_span || 0;
} catch (err) {
const isHttpError = 'statusCode' in err;
Expand Down
10 changes: 8 additions & 2 deletions x-pack/plugins/apm/server/lib/transactions/charts/get_anomaly_data/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ describe('getAnomalySeries', () => {
setup: {
start: 0,
end: 500000,
client: { search: clientSpy } as any,
internalClient: { search: clientSpy } as any,
client: { search: () => {} } as any,
internalClient: { search: () => {} } as any,
config: new Proxy(
{},
{
Expand All @@ -46,6 +46,12 @@ describe('getAnomalySeries', () => {
apmCustomLinkIndex: 'myIndex',
},
dynamicIndexPattern: null as any,
ml: {
mlSystem: {
mlAnomalySearch: clientSpy,
mlCapabilities: async () => ({ isPlatinumOrTrialLicense: true }),
},
} as any,
},
});
});
Expand Down
11 changes: 11 additions & 0 deletions x-pack/plugins/apm/server/lib/transactions/charts/get_anomaly_data/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,17 @@ export async function getAnomalySeries({
return;
}

// don't fetch anomalies if the ML plugin is not setup
if (!setup.ml) {
return;
}

// don't fetch anomalies if required license is not satisfied
const mlCapabilities = await setup.ml.mlSystem.mlCapabilities();
if (!mlCapabilities.isPlatinumOrTrialLicense) {
return;
}

const mlBucketSize = await getMlBucketSize({
serviceName,
transactionType,
Expand Down