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] Moves the APM index creation from server startup #37965

Merged
merged 2 commits into from
Jun 6, 2019
Merged

[APM] Moves the APM index creation from server startup #37965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a255ac
[APM] Closes #37499 by moving the APM index creation from server startup
ogupte Jun 4, 2019
04185f0
[APM] provide more meaninful status codes in the default error handler
ogupte Jun 5, 2019
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
29 changes: 8 additions & 21 deletions x-pack/plugins/apm/public/services/rest/savedObjects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
*/

import { memoize } from 'lodash';
import chrome from 'ui/chrome';
import { callApi } from './callApi';

export interface ISavedObject {
Expand All @@ -16,25 +15,13 @@ export interface ISavedObject {
type: string;
}

interface ISavedObjectAPIResponse {
saved_objects: ISavedObject[];
}

export const getAPMIndexPattern = memoize(async () => {
const apmIndexPatternTitle: string = chrome.getInjected(
'apmIndexPatternTitle'
);
const res = await callApi<ISavedObjectAPIResponse>({
pathname: `/api/saved_objects/_find`,
query: {
type: 'index-pattern',
search: `"${apmIndexPatternTitle}"`,
search_fields: 'title',
per_page: 200
}
});

return res.saved_objects.find(
savedObject => savedObject.attributes.title === apmIndexPatternTitle
);
try {
return await callApi<ISavedObject>({
method: 'GET',
pathname: `/api/apm/index_pattern`
});
} catch (error) {
return;
Copy link
Contributor

@cjcenizal cjcenizal Jun 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Do we want to swallow errors here? It seems like it might be a better UX to show an EuiCallOut with an error message (e.g. "APM failed to initialize" along with the status code and error message), or maybe just a toast notification. This way a user can report this info to support or on the Discuss forums.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This doesn't happen as part of initialization, but rather attempts to lazily create the APM index pattern when the UI attempts to load it. This memoized function is expected to return undefined if no index pattern is present (in this case, there was a failure to lazily create it). When undefined, the UI shows messaging to the user that the APM index pattern is required to use certain features, and the user is directed to explicitly create it.

}
});
25 changes: 14 additions & 11 deletions x-pack/plugins/apm/server/lib/index_pattern/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,24 @@
*/
import { InternalCoreSetup } from 'src/core/server';
import { getSavedObjectsClient } from '../helpers/saved_objects_client';
import indexPattern from '../../../../../../src/legacy/core_plugins/kibana/server/tutorials/apm/index_pattern.json';
import apmIndexPattern from '../../../../../../src/legacy/core_plugins/kibana/server/tutorials/apm/index_pattern.json';

export async function ensureIndexPatternExists(core: InternalCoreSetup) {
export async function getIndexPattern(core: InternalCoreSetup) {
const { server } = core.http;
const config = server.config();
const apmIndexPatternTitle = config.get('apm_oss.indexPattern');
const savedObjectsClient = getSavedObjectsClient(server);
const savedObjects = [
{
...indexPattern,
attributes: {
...indexPattern.attributes,
try {
return await savedObjectsClient.get('index-pattern', apmIndexPattern.id);
} catch (error) {
// if GET fails, then create a new index pattern saved object
return await savedObjectsClient.create(
Copy link
Contributor

Choose a reason for hiding this comment

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

Does savedObjectsClient return an error with a status code, e.g. 404? If so, then maybe we should check this before trying to create the index pattern. If it's some other kind of status code it seems like we'd probably want to surface it in the UI as an initialization failure or something.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We attempt to lazily create the index pattern here as a convenience, but if a failure occurs, the APM UI shows the user some messaging that the APM index pattern is required to use certain features. The user is then directed to a tutorial where they can explicitly create the index pattern.

'index-pattern',
{
...apmIndexPattern.attributes,
title: apmIndexPatternTitle
}
}
];
await savedObjectsClient.bulkCreate(savedObjects, { overwrite: false });
},
{ id: apmIndexPattern.id, overwrite: false }
);
}
}
4 changes: 2 additions & 2 deletions x-pack/plugins/apm/server/new-platform/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

import { InternalCoreSetup } from 'src/core/server';
import { makeApmUsageCollector } from '../lib/apm_telemetry';
import { ensureIndexPatternExists } from '../lib/index_pattern';
import { CoreSetupWithUsageCollector } from '../lib/apm_telemetry/make_apm_usage_collector';
import { initErrorsApi } from '../routes/errors';
import { initMetricsApi } from '../routes/metrics';
import { initServicesApi } from '../routes/services';
import { initTracesApi } from '../routes/traces';
import { initTransactionGroupsApi } from '../routes/transaction_groups';
import { initUIFiltersApi } from '../routes/ui_filters';
import { initIndexPatternApi } from '../routes/index_pattern';

export class Plugin {
public setup(core: InternalCoreSetup) {
Expand All @@ -23,7 +23,7 @@ export class Plugin {
initServicesApi(core);
initErrorsApi(core);
initMetricsApi(core);
initIndexPatternApi(core);
makeApmUsageCollector(core as CoreSetupWithUsageCollector);
ensureIndexPatternExists(core);
}
}
30 changes: 30 additions & 0 deletions x-pack/plugins/apm/server/routes/index_pattern.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* 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.
*/

import Boom from 'boom';
import { InternalCoreSetup } from 'src/core/server';
import { getIndexPattern } from '../lib/index_pattern';

const ROOT = '/api/apm/index_pattern';
const defaultErrorHandler = (err: Error & { status?: number }) => {
// eslint-disable-next-line
console.error(err.stack);
throw Boom.boomify(err, { statusCode: err.status || 500 });
};

export function initIndexPatternApi(core: InternalCoreSetup) {
const { server } = core.http;
server.route({
method: 'GET',
path: ROOT,
options: {
tags: ['access:apm']
},
handler: async req => {
return await getIndexPattern(core).catch(defaultErrorHandler);
}
});
}