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

[APM] Improve debug output #58467

Merged
merged 1 commit into from
Feb 26, 2020
Merged
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
96 changes: 55 additions & 41 deletions x-pack/plugins/apm/server/lib/helpers/es_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ import {
IndicesCreateParams,
DeleteDocumentResponse
} from 'elasticsearch';
import { cloneDeep, isString, merge, uniqueId } from 'lodash';
import { cloneDeep, isString, merge } from 'lodash';
import { KibanaRequest } from 'src/core/server';
import chalk from 'chalk';
import {
ESSearchRequest,
ESSearchResponse
Expand Down Expand Up @@ -126,6 +127,10 @@ interface ClientCreateOptions {

export type ESClient = ReturnType<typeof getESClient>;

function formatObj(obj: Record<string, any>) {
return JSON.stringify(obj, null, 2);
}

export function getESClient(
context: APMRequestHandlerContext,
request: KibanaRequest,
Expand All @@ -136,25 +141,49 @@ export function getESClient(
callAsInternalUser
} = context.core.elasticsearch.dataClient;

const callMethod = clientAsInternalUser
? callAsInternalUser
: callAsCurrentUser;
async function callEs(operationName: string, params: Record<string, any>) {
const startTime = process.hrtime();

let res: any;
let esError = null;
try {
res = clientAsInternalUser
? await callAsInternalUser(operationName, params)
: await callAsCurrentUser(operationName, params);
} catch (e) {
// catch error and throw after outputting debug info
esError = e;
}

if (context.params.query._debug) {
const highlightColor = esError ? 'bgRed' : 'inverse';
const diff = process.hrtime(startTime);
const duration = `${Math.round(diff[0] * 1000 + diff[1] / 1e6)}ms`;
const routeInfo = `${request.route.method.toUpperCase()} ${
request.route.path
}`;

const debug = context.params.query._debug;
console.log(
chalk.bold[highlightColor](`=== Debug: ${routeInfo} (${duration}) ===`)
);

if (operationName === 'search') {
console.log(`GET ${params.index}/_${operationName}`);
console.log(formatObj(params.body));
} else {
console.log(chalk.bold('ES operation:'), operationName);

function withTime<T>(
fn: (log: typeof console.log) => Promise<T>
): Promise<T> {
const log = console.log.bind(console, uniqueId());
if (!debug) {
return fn(log);
console.log(chalk.bold('ES query:'));
console.log(formatObj(params));
}
console.log(`\n`);
}
const time = process.hrtime();
return fn(log).then(data => {
const now = process.hrtime(time);
log(`took: ${Math.round(now[0] * 1000 + now[1] / 1e6)}ms`);
return data;
});

if (esError) {
throw esError;
}

return res;
}

return {
Expand All @@ -171,40 +200,25 @@ export function getESClient(
apmOptions
);

return withTime(log => {
if (context.params.query._debug) {
log(`--DEBUG ES QUERY--`);
log(
`${request.url.pathname} ${JSON.stringify(context.params.query)}`
);
log(`GET ${nextParams.index}/_search`);
log(JSON.stringify(nextParams.body, null, 2));
}

return (callMethod('search', nextParams) as unknown) as Promise<
ESSearchResponse<TDocument, TSearchRequest>
>;
});
return callEs('search', nextParams);
},
index: <Body>(params: APMIndexDocumentParams<Body>) => {
return withTime(() => callMethod('index', params));
return callEs('index', params);
},
delete: (params: IndicesDeleteParams): Promise<DeleteDocumentResponse> => {
return withTime(() => callMethod('delete', params));
return callEs('delete', params);
},
indicesCreate: (params: IndicesCreateParams) => {
return withTime(() => callMethod('indices.create', params));
return callEs('indices.create', params);
},
hasPrivileges: (
params: IndexPrivilegesParams
): Promise<IndexPrivileges> => {
return withTime(() =>
callMethod('transport.request', {
method: 'POST',
path: '/_security/user/_has_privileges',
body: params
})
);
return callEs('transport.request', {
method: 'POST',
path: '/_security/user/_has_privileges',
body: params
});
}
};
}