(
- {
- ...options,
- maxAttempts,
- attempt: attempt + 1,
- },
- dryRunResponse
- );
+ throw error;
}
-
- if (errorResponseLog) {
- throw new Error(`${errorResponseLog}: ${JSON.stringify(error.response.data)}`);
- }
-
- throw error;
}
}
}
diff --git a/packages/kbn-test/src/failed_tests_reporter/report_failures_to_file.ts b/packages/kbn-test/src/failed_tests_reporter/report_failures_to_file.ts
index e481da019945c..33dab240ec8b4 100644
--- a/packages/kbn-test/src/failed_tests_reporter/report_failures_to_file.ts
+++ b/packages/kbn-test/src/failed_tests_reporter/report_failures_to_file.ts
@@ -14,6 +14,7 @@ import { ToolingLog } from '@kbn/dev-utils';
import { REPO_ROOT } from '@kbn/utils';
import { escape } from 'he';
+import { BuildkiteMetadata } from './buildkite_metadata';
import { TestFailure } from './get_failures';
const findScreenshots = (dirPath: string, allScreenshots: string[] = []) => {
@@ -37,7 +38,11 @@ const findScreenshots = (dirPath: string, allScreenshots: string[] = []) => {
return allScreenshots;
};
-export function reportFailuresToFile(log: ToolingLog, failures: TestFailure[]) {
+export function reportFailuresToFile(
+ log: ToolingLog,
+ failures: TestFailure[],
+ bkMeta: BuildkiteMetadata
+) {
if (!failures?.length) {
return;
}
@@ -76,28 +81,15 @@ export function reportFailuresToFile(log: ToolingLog, failures: TestFailure[]) {
.flat()
.join('\n');
- // Buildkite steps that use `parallelism` need a numerical suffix added to identify them
- // We should also increment the number by one, since it's 0-based
- const jobNumberSuffix = process.env.BUILDKITE_PARALLEL_JOB
- ? ` #${parseInt(process.env.BUILDKITE_PARALLEL_JOB, 10) + 1}`
- : '';
-
- const buildUrl = process.env.BUILDKITE_BUILD_URL || '';
- const jobUrl = process.env.BUILDKITE_JOB_ID
- ? `${buildUrl}#${process.env.BUILDKITE_JOB_ID}`
- : '';
-
const failureJSON = JSON.stringify(
{
...failure,
hash,
- buildId: process.env.BUJILDKITE_BUILD_ID || '',
- jobId: process.env.BUILDKITE_JOB_ID || '',
- url: buildUrl,
- jobUrl,
- jobName: process.env.BUILDKITE_LABEL
- ? `${process.env.BUILDKITE_LABEL}${jobNumberSuffix}`
- : '',
+ buildId: bkMeta.buildId,
+ jobId: bkMeta.jobId,
+ url: bkMeta.url,
+ jobUrl: bkMeta.jobUrl,
+ jobName: bkMeta.jobName,
},
null,
2
@@ -149,11 +141,11 @@ export function reportFailuresToFile(log: ToolingLog, failures: TestFailure[]) {
${
- jobUrl
+ bkMeta.jobUrl
? `
Buildkite Job
- ${escape(jobUrl)}
+ ${escape(bkMeta.jobUrl)}
`
: ''
diff --git a/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts b/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts
index 193bc668ce003..6ab135a6afa7e 100644
--- a/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts
+++ b/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts
@@ -9,7 +9,7 @@
import Path from 'path';
import { REPO_ROOT } from '@kbn/utils';
-import { run, createFailError, createFlagError } from '@kbn/dev-utils';
+import { run, createFailError, createFlagError, CiStatsReporter } from '@kbn/dev-utils';
import globby from 'globby';
import normalize from 'normalize-path';
@@ -22,6 +22,7 @@ import { addMessagesToReport } from './add_messages_to_report';
import { getReportMessageIter } from './report_metadata';
import { reportFailuresToEs } from './report_failures_to_es';
import { reportFailuresToFile } from './report_failures_to_file';
+import { getBuildkiteMetadata } from './buildkite_metadata';
const DEFAULT_PATTERNS = [Path.resolve(REPO_ROOT, 'target/junit/**/*.xml')];
@@ -71,108 +72,129 @@ export function runFailedTestsReporterCli() {
dryRun: !updateGithub,
});
- const buildUrl = flags['build-url'] || (updateGithub ? '' : 'http://buildUrl');
- if (typeof buildUrl !== 'string' || !buildUrl) {
- throw createFlagError('Missing --build-url or process.env.BUILD_URL');
- }
+ const bkMeta = getBuildkiteMetadata();
- const patterns = (flags._.length ? flags._ : DEFAULT_PATTERNS).map((p) =>
- normalize(Path.resolve(p))
- );
- log.info('Searching for reports at', patterns);
- const reportPaths = await globby(patterns, {
- absolute: true,
- });
+ try {
+ const buildUrl = flags['build-url'] || (updateGithub ? '' : 'http://buildUrl');
+ if (typeof buildUrl !== 'string' || !buildUrl) {
+ throw createFlagError('Missing --build-url or process.env.BUILD_URL');
+ }
- if (!reportPaths.length) {
- throw createFailError(`Unable to find any junit reports with patterns [${patterns}]`);
- }
+ const patterns = (flags._.length ? flags._ : DEFAULT_PATTERNS).map((p) =>
+ normalize(Path.resolve(p))
+ );
+ log.info('Searching for reports at', patterns);
+ const reportPaths = await globby(patterns, {
+ absolute: true,
+ });
- log.info('found', reportPaths.length, 'junit reports', reportPaths);
- const newlyCreatedIssues: Array<{
- failure: TestFailure;
- newIssue: GithubIssueMini;
- }> = [];
+ if (!reportPaths.length) {
+ throw createFailError(`Unable to find any junit reports with patterns [${patterns}]`);
+ }
- for (const reportPath of reportPaths) {
- const report = await readTestReport(reportPath);
- const messages = Array.from(getReportMessageIter(report));
- const failures = await getFailures(report);
+ log.info('found', reportPaths.length, 'junit reports', reportPaths);
+ const newlyCreatedIssues: Array<{
+ failure: TestFailure;
+ newIssue: GithubIssueMini;
+ }> = [];
- if (indexInEs) {
- await reportFailuresToEs(log, failures);
- }
+ for (const reportPath of reportPaths) {
+ const report = await readTestReport(reportPath);
+ const messages = Array.from(getReportMessageIter(report));
+ const failures = await getFailures(report);
- for (const failure of failures) {
- const pushMessage = (msg: string) => {
- messages.push({
- classname: failure.classname,
- name: failure.name,
- message: msg,
- });
- };
-
- if (failure.likelyIrrelevant) {
- pushMessage(
- 'Failure is likely irrelevant' +
- (updateGithub ? ', so an issue was not created or updated' : '')
- );
- continue;
+ if (indexInEs) {
+ await reportFailuresToEs(log, failures);
}
- let existingIssue: GithubIssueMini | undefined = await githubApi.findFailedTestIssue(
- (i) =>
- getIssueMetadata(i.body, 'test.class') === failure.classname &&
- getIssueMetadata(i.body, 'test.name') === failure.name
- );
+ for (const failure of failures) {
+ const pushMessage = (msg: string) => {
+ messages.push({
+ classname: failure.classname,
+ name: failure.name,
+ message: msg,
+ });
+ };
+
+ if (failure.likelyIrrelevant) {
+ pushMessage(
+ 'Failure is likely irrelevant' +
+ (updateGithub ? ', so an issue was not created or updated' : '')
+ );
+ continue;
+ }
- if (!existingIssue) {
- const newlyCreated = newlyCreatedIssues.find(
- ({ failure: f }) => f.classname === failure.classname && f.name === failure.name
- );
+ let existingIssue: GithubIssueMini | undefined = updateGithub
+ ? await githubApi.findFailedTestIssue(
+ (i) =>
+ getIssueMetadata(i.body, 'test.class') === failure.classname &&
+ getIssueMetadata(i.body, 'test.name') === failure.name
+ )
+ : undefined;
+
+ if (!existingIssue) {
+ const newlyCreated = newlyCreatedIssues.find(
+ ({ failure: f }) => f.classname === failure.classname && f.name === failure.name
+ );
+
+ if (newlyCreated) {
+ existingIssue = newlyCreated.newIssue;
+ }
+ }
- if (newlyCreated) {
- existingIssue = newlyCreated.newIssue;
+ if (existingIssue) {
+ const newFailureCount = await updateFailureIssue(
+ buildUrl,
+ existingIssue,
+ githubApi,
+ branch
+ );
+ const url = existingIssue.html_url;
+ failure.githubIssue = url;
+ failure.failureCount = updateGithub ? newFailureCount : newFailureCount - 1;
+ pushMessage(
+ `Test has failed ${newFailureCount - 1} times on tracked branches: ${url}`
+ );
+ if (updateGithub) {
+ pushMessage(`Updated existing issue: ${url} (fail count: ${newFailureCount})`);
+ }
+ continue;
}
- }
- if (existingIssue) {
- const newFailureCount = await updateFailureIssue(
- buildUrl,
- existingIssue,
- githubApi,
- branch
- );
- const url = existingIssue.html_url;
- failure.githubIssue = url;
- failure.failureCount = updateGithub ? newFailureCount : newFailureCount - 1;
- pushMessage(`Test has failed ${newFailureCount - 1} times on tracked branches: ${url}`);
+ const newIssue = await createFailureIssue(buildUrl, failure, githubApi, branch);
+ pushMessage('Test has not failed recently on tracked branches');
if (updateGithub) {
- pushMessage(`Updated existing issue: ${url} (fail count: ${newFailureCount})`);
+ pushMessage(`Created new issue: ${newIssue.html_url}`);
+ failure.githubIssue = newIssue.html_url;
}
- continue;
- }
-
- const newIssue = await createFailureIssue(buildUrl, failure, githubApi, branch);
- pushMessage('Test has not failed recently on tracked branches');
- if (updateGithub) {
- pushMessage(`Created new issue: ${newIssue.html_url}`);
- failure.githubIssue = newIssue.html_url;
+ newlyCreatedIssues.push({ failure, newIssue });
+ failure.failureCount = updateGithub ? 1 : 0;
}
- newlyCreatedIssues.push({ failure, newIssue });
- failure.failureCount = updateGithub ? 1 : 0;
- }
- // mutates report to include messages and writes updated report to disk
- await addMessagesToReport({
- report,
- messages,
- log,
- reportPath,
- dryRun: !flags['report-update'],
- });
+ // mutates report to include messages and writes updated report to disk
+ await addMessagesToReport({
+ report,
+ messages,
+ log,
+ reportPath,
+ dryRun: !flags['report-update'],
+ });
- reportFailuresToFile(log, failures);
+ reportFailuresToFile(log, failures, bkMeta);
+ }
+ } finally {
+ await CiStatsReporter.fromEnv(log).metrics([
+ {
+ group: 'github api request count',
+ id: `failed test reporter`,
+ value: githubApi.getRequestCount(),
+ meta: Object.fromEntries(
+ Object.entries(bkMeta).map(
+ ([k, v]) => [`buildkite${k[0].toUpperCase()}${k.slice(1)}`, v] as const
+ )
+ ),
+ },
+ ]);
}
},
{
diff --git a/packages/kbn-test/src/functional_test_runner/lib/mocha/validate_ci_group_tags.js b/packages/kbn-test/src/functional_test_runner/lib/mocha/validate_ci_group_tags.js
index 3446c5be5d4a7..4f798839d7231 100644
--- a/packages/kbn-test/src/functional_test_runner/lib/mocha/validate_ci_group_tags.js
+++ b/packages/kbn-test/src/functional_test_runner/lib/mocha/validate_ci_group_tags.js
@@ -8,7 +8,7 @@
import Path from 'path';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
/**
* Traverse the suites configured and ensure that each suite has no more than one ciGroup assigned
diff --git a/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts b/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts
index e87f316a100a7..53ce4c74c1388 100644
--- a/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts
+++ b/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts
@@ -14,7 +14,7 @@ jest.mock('@kbn/utils', () => {
return { REPO_ROOT: '/dev/null/root' };
});
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { Lifecycle } from './lifecycle';
import { SuiteTracker } from './suite_tracker';
import { Suite } from '../fake_mocha_types';
diff --git a/packages/kbn-test/src/functional_tests/lib/babel_register_for_test_plugins.js b/packages/kbn-test/src/functional_tests/lib/babel_register_for_test_plugins.js
index 03947f7e267ba..63d2b56350ba1 100644
--- a/packages/kbn-test/src/functional_tests/lib/babel_register_for_test_plugins.js
+++ b/packages/kbn-test/src/functional_tests/lib/babel_register_for_test_plugins.js
@@ -9,7 +9,7 @@
const Fs = require('fs');
const Path = require('path');
-const { REPO_ROOT: REPO_ROOT_FOLLOWING_SYMLINKS } = require('@kbn/dev-utils');
+const { REPO_ROOT: REPO_ROOT_FOLLOWING_SYMLINKS } = require('@kbn/utils');
const BASE_REPO_ROOT = Path.resolve(
Fs.realpathSync(Path.resolve(REPO_ROOT_FOLLOWING_SYMLINKS, 'package.json')),
'..'
diff --git a/packages/kbn-test/src/functional_tests/tasks.ts b/packages/kbn-test/src/functional_tests/tasks.ts
index 6dde114d3a98e..6a6c7edb98c79 100644
--- a/packages/kbn-test/src/functional_tests/tasks.ts
+++ b/packages/kbn-test/src/functional_tests/tasks.ts
@@ -9,7 +9,8 @@
import { relative } from 'path';
import * as Rx from 'rxjs';
import { startWith, switchMap, take } from 'rxjs/operators';
-import { withProcRunner, ToolingLog, REPO_ROOT, getTimeReporter } from '@kbn/dev-utils';
+import { withProcRunner, ToolingLog, getTimeReporter } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import dedent from 'dedent';
import {
diff --git a/packages/kbn-test/src/jest/utils/enzyme_helpers.tsx b/packages/kbn-test/src/jest/utils/enzyme_helpers.tsx
index ee5e06ebf6947..696a1d1b63163 100644
--- a/packages/kbn-test/src/jest/utils/enzyme_helpers.tsx
+++ b/packages/kbn-test/src/jest/utils/enzyme_helpers.tsx
@@ -46,7 +46,11 @@ function getOptions(context = {}, childContextTypes = {}, props = {}) {
/**
* When using @kbn/i18n `injectI18n` on components, props.intl is required.
*/
-function nodeWithIntlProp(node: ReactElement): ReactElement {
+// This function is exported solely to fix the types output in TS 4.5.2, likely a bug
+// Otherwise, InjectedIntl is missing from the output
+export function nodeWithIntlProp(
+ node: ReactElement
+): ReactElement {
return React.cloneElement(node, { intl });
}
diff --git a/packages/kbn-test/src/kbn_client/kbn_client_import_export.ts b/packages/kbn-test/src/kbn_client/kbn_client_import_export.ts
index 4adae7d1cd031..6da34228bbe7f 100644
--- a/packages/kbn-test/src/kbn_client/kbn_client_import_export.ts
+++ b/packages/kbn-test/src/kbn_client/kbn_client_import_export.ts
@@ -12,7 +12,8 @@ import { existsSync } from 'fs';
import Path from 'path';
import FormData from 'form-data';
-import { ToolingLog, isAxiosResponseError, createFailError, REPO_ROOT } from '@kbn/dev-utils';
+import { ToolingLog, isAxiosResponseError, createFailError } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { KbnClientRequester, uriencode, ReqOptions } from './kbn_client_requester';
import { KbnClientSavedObjects } from './kbn_client_saved_objects';
diff --git a/packages/kbn-typed-react-router-config/src/types/index.ts b/packages/kbn-typed-react-router-config/src/types/index.ts
index c1ae5afd816ee..f15fd99a02a87 100644
--- a/packages/kbn-typed-react-router-config/src/types/index.ts
+++ b/packages/kbn-typed-react-router-config/src/types/index.ts
@@ -13,97 +13,13 @@ import { RequiredKeys, ValuesType } from 'utility-types';
// import { unconst } from '../unconst';
import { NormalizePath } from './utils';
-type PathsOfRoute =
- | TRoute['path']
- | (TRoute extends { children: Route[] }
- ? AppendPath | PathsOf
- : never);
-
-export type PathsOf = TRoutes extends []
- ? never
- : TRoutes extends [Route]
- ? PathsOfRoute
- : TRoutes extends [Route, Route]
- ? PathsOfRoute | PathsOfRoute
- : TRoutes extends [Route, Route, Route]
- ? PathsOfRoute | PathsOfRoute | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route, Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route, Route, Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route, Route, Route, Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : TRoutes extends [Route, Route, Route, Route, Route, Route, Route, Route, Route, Route, Route]
- ?
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- | PathsOfRoute
- : string;
+// type PathsOfRoute =
+// | TRoute['path']
+// | (TRoute extends { children: Route[] }
+// ? AppendPath | PathsOf
+// : never);
+
+export type PathsOf = keyof MapRoutes & string;
export interface RouteMatch {
route: TRoute;
@@ -347,6 +263,14 @@ type MapRoutes = TRoutes extends [Route]
// const routes = unconst([
// {
+// path: '/link-to/transaction/{transactionId}',
+// element,
+// },
+// {
+// path: '/link-to/trace/{traceId}',
+// element,
+// },
+// {
// path: '/',
// element,
// children: [
@@ -393,6 +317,10 @@ type MapRoutes = TRoutes extends [Route]
// element,
// },
// {
+// path: '/settings/agent-keys',
+// element,
+// },
+// {
// path: '/settings',
// element,
// },
@@ -430,11 +358,19 @@ type MapRoutes = TRoutes extends [Route]
// element,
// },
// {
+// path: '/services/:serviceName/transactions/view',
+// element,
+// },
+// {
+// path: '/services/:serviceName/dependencies',
+// element,
+// },
+// {
// path: '/services/:serviceName/errors',
// element,
// children: [
// {
-// path: '/:groupId',
+// path: '/services/:serviceName/errors/:groupId',
// element,
// params: t.type({
// path: t.type({
@@ -443,7 +379,7 @@ type MapRoutes = TRoutes extends [Route]
// }),
// },
// {
-// path: '/services/:serviceName',
+// path: '/services/:serviceName/errors',
// element,
// params: t.partial({
// query: t.partial({
@@ -457,15 +393,33 @@ type MapRoutes = TRoutes extends [Route]
// ],
// },
// {
-// path: '/services/:serviceName/foo',
+// path: '/services/:serviceName/metrics',
+// element,
+// },
+// {
+// path: '/services/:serviceName/nodes',
+// element,
+// children: [
+// {
+// path: '/services/{serviceName}/nodes/{serviceNodeName}/metrics',
+// element,
+// },
+// {
+// path: '/services/:serviceName/nodes',
+// element,
+// },
+// ],
+// },
+// {
+// path: '/services/:serviceName/service-map',
// element,
// },
// {
-// path: '/services/:serviceName/bar',
+// path: '/services/:serviceName/logs',
// element,
// },
// {
-// path: '/services/:serviceName/baz',
+// path: '/services/:serviceName/profiling',
// element,
// },
// {
@@ -497,6 +451,24 @@ type MapRoutes = TRoutes extends [Route]
// element,
// },
// {
+// path: '/backends',
+// element,
+// children: [
+// {
+// path: '/backends/{backendName}/overview',
+// element,
+// },
+// {
+// path: '/backends/overview',
+// element,
+// },
+// {
+// path: '/backends',
+// element,
+// },
+// ],
+// },
+// {
// path: '/',
// element,
// },
@@ -509,10 +481,11 @@ type MapRoutes = TRoutes extends [Route]
// type Routes = typeof routes;
// type Mapped = keyof MapRoutes;
+// type Paths = PathsOf;
// type Bar = ValuesType>['route']['path'];
// type Foo = OutputOf;
-// type Baz = OutputOf;
+// // type Baz = OutputOf;
// const { path }: Foo = {} as any;
@@ -520,4 +493,4 @@ type MapRoutes = TRoutes extends [Route]
// return {} as any;
// }
-// const params = _useApmParams('/*');
+// // const params = _useApmParams('/services/:serviceName/nodes/*');
diff --git a/src/cli/serve/integration_tests/invalid_config.test.ts b/src/cli/serve/integration_tests/invalid_config.test.ts
index 2de902582a548..ca051f37a816e 100644
--- a/src/cli/serve/integration_tests/invalid_config.test.ts
+++ b/src/cli/serve/integration_tests/invalid_config.test.ts
@@ -8,7 +8,7 @@
import { spawnSync } from 'child_process';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
const INVALID_CONFIG_PATH = require.resolve('./__fixtures__/invalid_config.yml');
diff --git a/src/core/public/apm_system.test.ts b/src/core/public/apm_system.test.ts
index f62421cb55abc..842d5de7e5afc 100644
--- a/src/core/public/apm_system.test.ts
+++ b/src/core/public/apm_system.test.ts
@@ -9,6 +9,7 @@
jest.mock('@elastic/apm-rum');
import type { DeeplyMockedKeys, MockedKeys } from '@kbn/utility-types/jest';
import { init, apm } from '@elastic/apm-rum';
+import type { Transaction } from '@elastic/apm-rum';
import { ApmSystem } from './apm_system';
import { Subject } from 'rxjs';
import { InternalApplicationStart } from './application/types';
diff --git a/src/core/public/apm_system.ts b/src/core/public/apm_system.ts
index f15a317f9f934..2231f394381f0 100644
--- a/src/core/public/apm_system.ts
+++ b/src/core/public/apm_system.ts
@@ -6,7 +6,7 @@
* Side Public License, v 1.
*/
-import type { ApmBase, AgentConfigOptions } from '@elastic/apm-rum';
+import type { ApmBase, AgentConfigOptions, Transaction } from '@elastic/apm-rum';
import { modifyUrl } from '@kbn/std';
import { CachedResourceObserver } from './apm_resource_counter';
import type { InternalApplicationStart } from './application';
diff --git a/src/core/public/chrome/recently_accessed/recently_accessed_service.test.ts b/src/core/public/chrome/recently_accessed/recently_accessed_service.test.ts
index 10b4f510d4afa..bcf58b7a40ab1 100644
--- a/src/core/public/chrome/recently_accessed/recently_accessed_service.test.ts
+++ b/src/core/public/chrome/recently_accessed/recently_accessed_service.test.ts
@@ -44,11 +44,9 @@ describe('RecentlyAccessed#start()', () => {
let originalLocalStorage: Storage;
beforeAll(() => {
originalLocalStorage = window.localStorage;
- // @ts-expect-error
window.localStorage = new LocalStorageMock();
});
beforeEach(() => localStorage.clear());
- // @ts-expect-error
afterAll(() => (window.localStorage = originalLocalStorage));
const getStart = async () => {
diff --git a/src/core/public/i18n/__snapshots__/i18n_service.test.tsx.snap b/src/core/public/i18n/__snapshots__/i18n_service.test.tsx.snap
index e93ef34c38025..1c394112a404c 100644
--- a/src/core/public/i18n/__snapshots__/i18n_service.test.tsx.snap
+++ b/src/core/public/i18n/__snapshots__/i18n_service.test.tsx.snap
@@ -98,6 +98,7 @@ exports[`#start() returns \`Context\` component 1`] = `
"euiDataGridToolbar.fullScreenButtonActive": "Exit full screen",
"euiDatePopoverButton.invalidTitle": [Function],
"euiDatePopoverButton.outdatedTitle": [Function],
+ "euiErrorBoundary.error": "Error",
"euiFieldPassword.maskPassword": "Mask password",
"euiFieldPassword.showPassword": "Show password as plain text. Note: this will visually expose your password on the screen.",
"euiFilePicker.clearSelectedFiles": "Clear selected files",
@@ -218,7 +219,7 @@ exports[`#start() returns \`Context\` component 1`] = `
"euiStyleSelector.labelExpanded": "Expanded density",
"euiStyleSelector.labelNormal": "Normal density",
"euiSuperDatePicker.showDatesButtonLabel": "Show dates",
- "euiSuperSelect.screenReaderAnnouncement": [Function],
+ "euiSuperSelect.screenReaderAnnouncement": "You are in a form selector and must select a single option. Use the up and down keys to navigate or escape to close.",
"euiSuperSelectControl.selectAnOption": [Function],
"euiSuperUpdateButton.cannotUpdateTooltip": "Cannot update",
"euiSuperUpdateButton.clickToApplyTooltip": "Click to apply",
diff --git a/src/core/public/i18n/i18n_eui_mapping.tsx b/src/core/public/i18n/i18n_eui_mapping.tsx
index 7c4d39fa2b11a..e3357d138e794 100644
--- a/src/core/public/i18n/i18n_eui_mapping.tsx
+++ b/src/core/public/i18n/i18n_eui_mapping.tsx
@@ -663,6 +663,10 @@ export const getEuiContextMapping = (): EuiTokensObject => {
defaultMessage: '+ {messagesLength} more',
values: { messagesLength },
}),
+ 'euiErrorBoundary.error': i18n.translate('core.euiErrorBoundary.error', {
+ defaultMessage: 'Error',
+ description: 'Error boundary for uncaught exceptions when rendering part of the application',
+ }),
'euiNotificationEventMessages.accordionAriaLabelButtonText': ({
messagesLength,
eventName,
@@ -1046,12 +1050,13 @@ export const getEuiContextMapping = (): EuiTokensObject => {
description: 'Displayed in a button that shows date picker',
}
),
- 'euiSuperSelect.screenReaderAnnouncement': ({ optionsCount }: EuiValues) =>
- i18n.translate('core.euiSuperSelect.screenReaderAnnouncement', {
+ 'euiSuperSelect.screenReaderAnnouncement': i18n.translate(
+ 'core.euiSuperSelect.screenReaderAnnouncement',
+ {
defaultMessage:
- 'You are in a form selector of {optionsCount} items and must select a single option. Use the up and down keys to navigate or escape to close.',
- values: { optionsCount },
- }),
+ 'You are in a form selector and must select a single option. Use the up and down keys to navigate or escape to close.',
+ }
+ ),
'euiSuperSelectControl.selectAnOption': ({ selectedValue }: EuiValues) =>
i18n.translate('core.euiSuperSelectControl.selectAnOption', {
defaultMessage: 'Select an option: {selectedValue}, is selected',
diff --git a/src/core/server/capabilities/integration_tests/capabilities_service.test.ts b/src/core/server/capabilities/integration_tests/capabilities_service.test.ts
index 2e80fbb9d20c0..c1f6ffb5add77 100644
--- a/src/core/server/capabilities/integration_tests/capabilities_service.test.ts
+++ b/src/core/server/capabilities/integration_tests/capabilities_service.test.ts
@@ -7,7 +7,7 @@
*/
import supertest from 'supertest';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { HttpService, InternalHttpServicePreboot, InternalHttpServiceSetup } from '../../http';
import { contextServiceMock } from '../../context/context_service.mock';
import { executionContextServiceMock } from '../../execution_context/execution_context_service.mock';
diff --git a/src/core/server/core_context.mock.ts b/src/core/server/core_context.mock.ts
index ddb87d31383c8..4d7b4e1ba5548 100644
--- a/src/core/server/core_context.mock.ts
+++ b/src/core/server/core_context.mock.ts
@@ -6,7 +6,7 @@
* Side Public License, v 1.
*/
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
import { CoreContext } from './core_context';
import { Env, IConfigService } from './config';
diff --git a/src/core/server/elasticsearch/client/configure_client.test.ts b/src/core/server/elasticsearch/client/configure_client.test.ts
index 7988e81045d17..f252993415afa 100644
--- a/src/core/server/elasticsearch/client/configure_client.test.ts
+++ b/src/core/server/elasticsearch/client/configure_client.test.ts
@@ -6,21 +6,16 @@
* Side Public License, v 1.
*/
-import { Buffer } from 'buffer';
-import { Readable } from 'stream';
-
-import { errors } from '@elastic/elasticsearch';
-import type {
- TransportRequestOptions,
- TransportRequestParams,
- DiagnosticResult,
- RequestBody,
-} from '@elastic/elasticsearch';
+jest.mock('./log_query_and_deprecation.ts', () => ({
+ __esModule: true,
+ instrumentEsQueryAndDeprecationLogger: jest.fn(),
+}));
import { parseClientOptionsMock, ClientMock } from './configure_client.test.mocks';
import { loggingSystemMock } from '../../logging/logging_system.mock';
import type { ElasticsearchClientConfig } from './client_config';
import { configureClient } from './configure_client';
+import { instrumentEsQueryAndDeprecationLogger } from './log_query_and_deprecation';
const createFakeConfig = (
parts: Partial = {}
@@ -36,40 +31,9 @@ const createFakeClient = () => {
const client = new actualEs.Client({
nodes: ['http://localhost'], // Enforcing `nodes` because it's mandatory
});
- jest.spyOn(client.diagnostic, 'on');
return client;
};
-const createApiResponse = ({
- body,
- statusCode = 200,
- headers = {},
- warnings = [],
- params,
- requestOptions = {},
-}: {
- body: T;
- statusCode?: number;
- headers?: Record;
- warnings?: string[];
- params?: TransportRequestParams;
- requestOptions?: TransportRequestOptions;
-}): DiagnosticResult => {
- return {
- body,
- statusCode,
- headers,
- warnings,
- meta: {
- body,
- request: {
- params: params!,
- options: requestOptions,
- } as any,
- } as any,
- };
-};
-
describe('configureClient', () => {
let logger: ReturnType;
let config: ElasticsearchClientConfig;
@@ -84,6 +48,7 @@ describe('configureClient', () => {
afterEach(() => {
parseClientOptionsMock.mockReset();
ClientMock.mockReset();
+ jest.clearAllMocks();
});
it('calls `parseClientOptions` with the correct parameters', () => {
@@ -113,366 +78,14 @@ describe('configureClient', () => {
expect(client).toBe(ClientMock.mock.results[0].value);
});
- it('listens to client on `response` events', () => {
+ it('calls instrumentEsQueryAndDeprecationLogger', () => {
const client = configureClient(config, { logger, type: 'test', scoped: false });
- expect(client.diagnostic.on).toHaveBeenCalledTimes(1);
- expect(client.diagnostic.on).toHaveBeenCalledWith('response', expect.any(Function));
- });
-
- describe('Client logging', () => {
- function createResponseWithBody(body?: RequestBody) {
- return createApiResponse({
- body: {},
- statusCode: 200,
- params: {
- method: 'GET',
- path: '/foo',
- querystring: { hello: 'dolly' },
- body,
- },
- });
- }
-
- describe('logs each query', () => {
- it('creates a query logger context based on the `type` parameter', () => {
- configureClient(createFakeConfig(), { logger, type: 'test123' });
- expect(logger.get).toHaveBeenCalledWith('query', 'test123');
- });
-
- it('when request body is an object', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createResponseWithBody({
- seq_no_primary_term: true,
- query: {
- term: { user: 'kimchy' },
- },
- });
-
- client.diagnostic.emit('response', null, response);
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "200
- GET /foo?hello=dolly
- {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}}",
- undefined,
- ],
- ]
- `);
- });
-
- it('when request body is a string', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createResponseWithBody(
- JSON.stringify({
- seq_no_primary_term: true,
- query: {
- term: { user: 'kimchy' },
- },
- })
- );
-
- client.diagnostic.emit('response', null, response);
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "200
- GET /foo?hello=dolly
- {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}}",
- undefined,
- ],
- ]
- `);
- });
-
- it('when request body is a buffer', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createResponseWithBody(
- Buffer.from(
- JSON.stringify({
- seq_no_primary_term: true,
- query: {
- term: { user: 'kimchy' },
- },
- })
- )
- );
-
- client.diagnostic.emit('response', null, response);
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "200
- GET /foo?hello=dolly
- [buffer]",
- undefined,
- ],
- ]
- `);
- });
-
- it('when request body is a readable stream', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createResponseWithBody(
- Readable.from(
- JSON.stringify({
- seq_no_primary_term: true,
- query: {
- term: { user: 'kimchy' },
- },
- })
- )
- );
-
- client.diagnostic.emit('response', null, response);
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "200
- GET /foo?hello=dolly
- [stream]",
- undefined,
- ],
- ]
- `);
- });
-
- it('when request body is not defined', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createResponseWithBody();
-
- client.diagnostic.emit('response', null, response);
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "200
- GET /foo?hello=dolly",
- undefined,
- ],
- ]
- `);
- });
-
- it('properly encode queries', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createApiResponse({
- body: {},
- statusCode: 200,
- params: {
- method: 'GET',
- path: '/foo',
- querystring: { city: 'Münich' },
- },
- });
-
- client.diagnostic.emit('response', null, response);
-
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "200
- GET /foo?city=M%C3%BCnich",
- undefined,
- ],
- ]
- `);
- });
-
- it('logs queries even in case of errors', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createApiResponse({
- statusCode: 500,
- body: {
- error: {
- type: 'internal server error',
- },
- },
- params: {
- method: 'GET',
- path: '/foo',
- querystring: { hello: 'dolly' },
- body: {
- seq_no_primary_term: true,
- query: {
- term: { user: 'kimchy' },
- },
- },
- },
- });
- client.diagnostic.emit('response', new errors.ResponseError(response), response);
-
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "500
- GET /foo?hello=dolly
- {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}} [internal server error]: internal server error",
- undefined,
- ],
- ]
- `);
- });
-
- it('logs debug when the client emits an @elastic/elasticsearch error', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createApiResponse({ body: {} });
- client.diagnostic.emit('response', new errors.TimeoutError('message', response), response);
-
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "[TimeoutError]: message",
- undefined,
- ],
- ]
- `);
- });
-
- it('logs debug when the client emits an ResponseError returned by elasticsearch', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- const response = createApiResponse({
- statusCode: 400,
- headers: {},
- params: {
- method: 'GET',
- path: '/_path',
- querystring: { hello: 'dolly' },
- },
- body: {
- error: {
- type: 'illegal_argument_exception',
- reason: 'request [/_path] contains unrecognized parameter: [name]',
- },
- },
- });
- client.diagnostic.emit('response', new errors.ResponseError(response), response);
-
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "400
- GET /_path?hello=dolly [illegal_argument_exception]: request [/_path] contains unrecognized parameter: [name]",
- undefined,
- ],
- ]
- `);
- });
-
- it('logs default error info when the error response body is empty', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- let response: DiagnosticResult = createApiResponse({
- statusCode: 400,
- headers: {},
- params: {
- method: 'GET',
- path: '/_path',
- },
- body: {
- error: {},
- },
- });
- client.diagnostic.emit('response', new errors.ResponseError(response), response);
-
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "400
- GET /_path [undefined]: {\\"error\\":{}}",
- undefined,
- ],
- ]
- `);
-
- logger.debug.mockClear();
-
- response = createApiResponse({
- statusCode: 400,
- headers: {},
- params: {
- method: 'GET',
- path: '/_path',
- },
- body: undefined,
- });
- client.diagnostic.emit('response', new errors.ResponseError(response), response);
-
- expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
- Array [
- Array [
- "400
- GET /_path [undefined]: Response Error",
- undefined,
- ],
- ]
- `);
- });
-
- it('adds meta information to logs', () => {
- const client = configureClient(createFakeConfig(), { logger, type: 'test', scoped: false });
-
- let response = createApiResponse({
- statusCode: 400,
- headers: {},
- params: {
- method: 'GET',
- path: '/_path',
- },
- requestOptions: {
- opaqueId: 'opaque-id',
- },
- body: {
- error: {},
- },
- });
- client.diagnostic.emit('response', null, response);
-
- expect(loggingSystemMock.collect(logger).debug[0][1]).toMatchInlineSnapshot(`
- Object {
- "http": Object {
- "request": Object {
- "id": "opaque-id",
- },
- },
- }
- `);
-
- logger.debug.mockClear();
-
- response = createApiResponse({
- statusCode: 400,
- headers: {},
- params: {
- method: 'GET',
- path: '/_path',
- },
- requestOptions: {
- opaqueId: 'opaque-id',
- },
- body: {} as any,
- });
- client.diagnostic.emit('response', new errors.ResponseError(response), response);
-
- expect(loggingSystemMock.collect(logger).debug[0][1]).toMatchInlineSnapshot(`
- Object {
- "http": Object {
- "request": Object {
- "id": "opaque-id",
- },
- },
- }
- `);
- });
+ expect(instrumentEsQueryAndDeprecationLogger).toHaveBeenCalledTimes(1);
+ expect(instrumentEsQueryAndDeprecationLogger).toHaveBeenCalledWith({
+ logger,
+ client,
+ type: 'test',
});
});
});
diff --git a/src/core/server/elasticsearch/client/configure_client.ts b/src/core/server/elasticsearch/client/configure_client.ts
index fc8a06660cc5e..e48a36fa4fe58 100644
--- a/src/core/server/elasticsearch/client/configure_client.ts
+++ b/src/core/server/elasticsearch/client/configure_client.ts
@@ -6,21 +6,17 @@
* Side Public License, v 1.
*/
-import { Buffer } from 'buffer';
-import { stringify } from 'querystring';
-import { Client, errors, Transport, HttpConnection } from '@elastic/elasticsearch';
+import { Client, Transport, HttpConnection } from '@elastic/elasticsearch';
import type { KibanaClient } from '@elastic/elasticsearch/lib/api/kibana';
import type {
TransportRequestParams,
TransportRequestOptions,
TransportResult,
- DiagnosticResult,
- RequestBody,
} from '@elastic/elasticsearch';
import { Logger } from '../../logging';
import { parseClientOptions, ElasticsearchClientConfig } from './client_config';
-import type { ElasticsearchErrorDetails } from './types';
+import { instrumentEsQueryAndDeprecationLogger } from './log_query_and_deprecation';
const noop = () => undefined;
@@ -61,91 +57,8 @@ export const configureClient = (
Transport: KibanaTransport,
Connection: HttpConnection,
});
- addLogging(client, logger.get('query', type));
- return client as KibanaClient;
-};
-
-const convertQueryString = (qs: string | Record | undefined): string => {
- if (qs === undefined || typeof qs === 'string') {
- return qs ?? '';
- }
- return stringify(qs);
-};
-
-function ensureString(body: RequestBody): string {
- if (typeof body === 'string') return body;
- if (Buffer.isBuffer(body)) return '[buffer]';
- if ('readable' in body && body.readable && typeof body._read === 'function') return '[stream]';
- return JSON.stringify(body);
-}
-
-/**
- * Returns a debug message from an Elasticsearch error in the following format:
- * [error type] error reason
- */
-export function getErrorMessage(error: errors.ElasticsearchClientError): string {
- if (error instanceof errors.ResponseError) {
- const errorBody = error.meta.body as ElasticsearchErrorDetails;
- return `[${errorBody?.error?.type}]: ${errorBody?.error?.reason ?? error.message}`;
- }
- return `[${error.name}]: ${error.message}`;
-}
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type });
-/**
- * returns a string in format:
- *
- * status code
- * method URL
- * request body
- *
- * so it could be copy-pasted into the Dev console
- */
-function getResponseMessage(event: DiagnosticResult): string {
- const errorMeta = getRequestDebugMeta(event);
- const body = errorMeta.body ? `\n${errorMeta.body}` : '';
- return `${errorMeta.statusCode}\n${errorMeta.method} ${errorMeta.url}${body}`;
-}
-
-/**
- * Returns stringified debug information from an Elasticsearch request event
- * useful for logging in case of an unexpected failure.
- */
-export function getRequestDebugMeta(event: DiagnosticResult): {
- url: string;
- body: string;
- statusCode: number | null;
- method: string;
-} {
- const params = event.meta.request.params;
- // definition is wrong, `params.querystring` can be either a string or an object
- const querystring = convertQueryString(params.querystring);
- return {
- url: `${params.path}${querystring ? `?${querystring}` : ''}`,
- body: params.body ? `${ensureString(params.body)}` : '',
- method: params.method,
- statusCode: event.statusCode!,
- };
-}
-
-const addLogging = (client: Client, logger: Logger) => {
- client.diagnostic.on('response', (error, event) => {
- if (event) {
- const opaqueId = event.meta.request.options.opaqueId;
- const meta = opaqueId
- ? {
- http: { request: { id: event.meta.request.options.opaqueId } },
- }
- : undefined; // do not clutter logs if opaqueId is not present
- if (error) {
- if (error instanceof errors.ResponseError) {
- logger.debug(`${getResponseMessage(event)} ${getErrorMessage(error)}`, meta);
- } else {
- logger.debug(getErrorMessage(error), meta);
- }
- } else {
- logger.debug(getResponseMessage(event), meta);
- }
- }
- });
+ return client as KibanaClient;
};
diff --git a/src/core/server/elasticsearch/client/index.ts b/src/core/server/elasticsearch/client/index.ts
index 2cf5a0229a489..123c498f1ee21 100644
--- a/src/core/server/elasticsearch/client/index.ts
+++ b/src/core/server/elasticsearch/client/index.ts
@@ -21,5 +21,6 @@ export type { IScopedClusterClient } from './scoped_cluster_client';
export type { ElasticsearchClientConfig } from './client_config';
export { ClusterClient } from './cluster_client';
export type { IClusterClient, ICustomClusterClient } from './cluster_client';
-export { configureClient, getRequestDebugMeta, getErrorMessage } from './configure_client';
+export { configureClient } from './configure_client';
+export { getRequestDebugMeta, getErrorMessage } from './log_query_and_deprecation';
export { retryCallCluster, migrationRetryCallCluster } from './retry_call_cluster';
diff --git a/src/core/server/elasticsearch/client/log_query_and_deprecation.test.ts b/src/core/server/elasticsearch/client/log_query_and_deprecation.test.ts
new file mode 100644
index 0000000000000..30d5d8b87ed1c
--- /dev/null
+++ b/src/core/server/elasticsearch/client/log_query_and_deprecation.test.ts
@@ -0,0 +1,624 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { Buffer } from 'buffer';
+import { Readable } from 'stream';
+
+import {
+ Client,
+ ConnectionRequestParams,
+ errors,
+ TransportRequestOptions,
+ TransportRequestParams,
+} from '@elastic/elasticsearch';
+import type { DiagnosticResult, RequestBody } from '@elastic/elasticsearch';
+
+import { parseClientOptionsMock, ClientMock } from './configure_client.test.mocks';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
+import { instrumentEsQueryAndDeprecationLogger } from './log_query_and_deprecation';
+
+const createApiResponse = ({
+ body,
+ statusCode = 200,
+ headers = {},
+ warnings = null,
+ params,
+ requestOptions = {},
+}: {
+ body: T;
+ statusCode?: number;
+ headers?: Record;
+ warnings?: string[] | null;
+ params?: TransportRequestParams | ConnectionRequestParams;
+ requestOptions?: TransportRequestOptions;
+}): DiagnosticResult => {
+ return {
+ body,
+ statusCode,
+ headers,
+ warnings,
+ meta: {
+ body,
+ request: {
+ params: params!,
+ options: requestOptions,
+ } as any,
+ } as any,
+ };
+};
+
+const createFakeClient = () => {
+ const actualEs = jest.requireActual('@elastic/elasticsearch');
+ const client = new actualEs.Client({
+ nodes: ['http://localhost'], // Enforcing `nodes` because it's mandatory
+ });
+ jest.spyOn(client.diagnostic, 'on');
+ return client as Client;
+};
+
+describe('instrumentQueryAndDeprecationLogger', () => {
+ let logger: ReturnType;
+ const client = createFakeClient();
+
+ beforeEach(() => {
+ logger = loggingSystemMock.createLogger();
+ parseClientOptionsMock.mockReturnValue({});
+ ClientMock.mockImplementation(() => createFakeClient());
+ });
+
+ afterEach(() => {
+ parseClientOptionsMock.mockReset();
+ ClientMock.mockReset();
+ jest.clearAllMocks();
+ });
+
+ function createResponseWithBody(body?: RequestBody) {
+ return createApiResponse({
+ body: {},
+ statusCode: 200,
+ params: {
+ method: 'GET',
+ path: '/foo',
+ querystring: { hello: 'dolly' },
+ body,
+ },
+ });
+ }
+
+ it('creates a query logger context based on the `type` parameter', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test123' });
+ expect(logger.get).toHaveBeenCalledWith('query', 'test123');
+ });
+
+ describe('logs each query', () => {
+ it('when request body is an object', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createResponseWithBody({
+ seq_no_primary_term: true,
+ query: {
+ term: { user: 'kimchy' },
+ },
+ });
+
+ client.diagnostic.emit('response', null, response);
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "200
+ GET /foo?hello=dolly
+ {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}}",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('when request body is a string', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createResponseWithBody(
+ JSON.stringify({
+ seq_no_primary_term: true,
+ query: {
+ term: { user: 'kimchy' },
+ },
+ })
+ );
+
+ client.diagnostic.emit('response', null, response);
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "200
+ GET /foo?hello=dolly
+ {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}}",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('when request body is a buffer', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createResponseWithBody(
+ Buffer.from(
+ JSON.stringify({
+ seq_no_primary_term: true,
+ query: {
+ term: { user: 'kimchy' },
+ },
+ })
+ )
+ );
+
+ client.diagnostic.emit('response', null, response);
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "200
+ GET /foo?hello=dolly
+ [buffer]",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('when request body is a readable stream', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createResponseWithBody(
+ Readable.from(
+ JSON.stringify({
+ seq_no_primary_term: true,
+ query: {
+ term: { user: 'kimchy' },
+ },
+ })
+ )
+ );
+
+ client.diagnostic.emit('response', null, response);
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "200
+ GET /foo?hello=dolly
+ [stream]",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('when request body is not defined', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createResponseWithBody();
+
+ client.diagnostic.emit('response', null, response);
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "200
+ GET /foo?hello=dolly",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('properly encode queries', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ body: {},
+ statusCode: 200,
+ params: {
+ method: 'GET',
+ path: '/foo',
+ querystring: { city: 'Münich' },
+ },
+ });
+
+ client.diagnostic.emit('response', null, response);
+
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "200
+ GET /foo?city=M%C3%BCnich",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('logs queries even in case of errors', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 500,
+ body: {
+ error: {
+ type: 'internal server error',
+ },
+ },
+ params: {
+ method: 'GET',
+ path: '/foo',
+ querystring: { hello: 'dolly' },
+ body: {
+ seq_no_primary_term: true,
+ query: {
+ term: { user: 'kimchy' },
+ },
+ },
+ },
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "500
+ GET /foo?hello=dolly
+ {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}} [internal server error]: internal server error",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('logs debug when the client emits an @elastic/elasticsearch error', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({ body: {} });
+ client.diagnostic.emit('response', new errors.TimeoutError('message', response), response);
+
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "[TimeoutError]: message",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('logs debug when the client emits an ResponseError returned by elasticsearch', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 400,
+ headers: {},
+ params: {
+ method: 'GET',
+ path: '/_path',
+ querystring: { hello: 'dolly' },
+ },
+ body: {
+ error: {
+ type: 'illegal_argument_exception',
+ reason: 'request [/_path] contains unrecognized parameter: [name]',
+ },
+ },
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "400
+ GET /_path?hello=dolly [illegal_argument_exception]: request [/_path] contains unrecognized parameter: [name]",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('logs default error info when the error response body is empty', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ let response: DiagnosticResult = createApiResponse({
+ statusCode: 400,
+ headers: {},
+ params: {
+ method: 'GET',
+ path: '/_path',
+ },
+ body: {
+ error: {},
+ },
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "400
+ GET /_path [undefined]: {\\"error\\":{}}",
+ undefined,
+ ],
+ ]
+ `);
+
+ logger.debug.mockClear();
+
+ response = createApiResponse({
+ statusCode: 400,
+ headers: {},
+ params: {
+ method: 'GET',
+ path: '/_path',
+ },
+ body: undefined,
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "400
+ GET /_path [undefined]: Response Error",
+ undefined,
+ ],
+ ]
+ `);
+ });
+
+ it('adds meta information to logs', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ let response = createApiResponse({
+ statusCode: 400,
+ headers: {},
+ params: {
+ method: 'GET',
+ path: '/_path',
+ },
+ requestOptions: {
+ opaqueId: 'opaque-id',
+ },
+ body: {
+ error: {},
+ },
+ });
+ client.diagnostic.emit('response', null, response);
+
+ expect(loggingSystemMock.collect(logger).debug[0][1]).toMatchInlineSnapshot(`
+ Object {
+ "http": Object {
+ "request": Object {
+ "id": "opaque-id",
+ },
+ },
+ }
+ `);
+
+ logger.debug.mockClear();
+
+ response = createApiResponse({
+ statusCode: 400,
+ headers: {},
+ params: {
+ method: 'GET',
+ path: '/_path',
+ },
+ requestOptions: {
+ opaqueId: 'opaque-id',
+ },
+ body: {} as any,
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ expect(loggingSystemMock.collect(logger).debug[0][1]).toMatchInlineSnapshot(`
+ Object {
+ "http": Object {
+ "request": Object {
+ "id": "opaque-id",
+ },
+ },
+ }
+ `);
+ });
+ });
+
+ describe('deprecation warnings from response headers', () => {
+ it('does not log when no deprecation warning header is returned', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 200,
+ warnings: null,
+ params: {
+ method: 'GET',
+ path: '/_path',
+ querystring: { hello: 'dolly' },
+ },
+ body: {
+ hits: [
+ {
+ _source: 'may the source be with you',
+ },
+ ],
+ },
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ // One debug log entry from 'elasticsearch.query' context
+ expect(loggingSystemMock.collect(logger).debug.length).toEqual(1);
+ expect(loggingSystemMock.collect(logger).info).toEqual([]);
+ });
+
+ it('does not log when warning header comes from a warn-agent that is not elasticsearch', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 200,
+ warnings: [
+ '299 nginx/2.3.1 "GET /_path is deprecated"',
+ '299 nginx/2.3.1 "GET hello query param is deprecated"',
+ ],
+ params: {
+ method: 'GET',
+ path: '/_path',
+ querystring: { hello: 'dolly' },
+ },
+ body: {
+ hits: [
+ {
+ _source: 'may the source be with you',
+ },
+ ],
+ },
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ // One debug log entry from 'elasticsearch.query' context
+ expect(loggingSystemMock.collect(logger).debug.length).toEqual(1);
+ expect(loggingSystemMock.collect(logger).info).toEqual([]);
+ });
+
+ it('logs error when the client receives an Elasticsearch error response for a deprecated request originating from a user', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 400,
+ warnings: ['299 Elasticsearch-8.1.0 "GET /_path is deprecated"'],
+ params: {
+ method: 'GET',
+ path: '/_path',
+ querystring: { hello: 'dolly' },
+ },
+ body: {
+ error: {
+ type: 'illegal_argument_exception',
+ reason: 'request [/_path] contains unrecognized parameter: [name]',
+ },
+ },
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ expect(loggingSystemMock.collect(logger).info).toEqual([]);
+ // Test debug[1] since theree is one log entry from 'elasticsearch.query' context
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch(
+ 'Elasticsearch deprecation: 299 Elasticsearch-8.1.0 "GET /_path is deprecated"'
+ );
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch('Origin:user');
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch(/Stack trace:\n.*at/);
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch(
+ /Query:\n.*400\n.*GET \/_path\?hello\=dolly \[illegal_argument_exception\]: request \[\/_path\] contains unrecognized parameter: \[name\]/
+ );
+ });
+
+ it('logs warning when the client receives an Elasticsearch error response for a deprecated request originating from kibana', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 400,
+ warnings: ['299 Elasticsearch-8.1.0 "GET /_path is deprecated"'],
+ params: {
+ method: 'GET',
+ path: '/_path',
+ querystring: { hello: 'dolly' },
+ // Set the request header to indicate to Elasticsearch that this is a request over which users have no control
+ headers: { 'x-elastic-product-origin': 'kibana' },
+ },
+ body: {
+ error: {
+ type: 'illegal_argument_exception',
+ reason: 'request [/_path] contains unrecognized parameter: [name]',
+ },
+ },
+ });
+ client.diagnostic.emit('response', new errors.ResponseError(response), response);
+
+ // One debug log entry from 'elasticsearch.query' context
+ expect(loggingSystemMock.collect(logger).debug.length).toEqual(1);
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch(
+ 'Elasticsearch deprecation: 299 Elasticsearch-8.1.0 "GET /_path is deprecated"'
+ );
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch('Origin:kibana');
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch(/Stack trace:\n.*at/);
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch(
+ /Query:\n.*400\n.*GET \/_path\?hello\=dolly \[illegal_argument_exception\]: request \[\/_path\] contains unrecognized parameter: \[name\]/
+ );
+ });
+
+ it('logs error when the client receives an Elasticsearch success response for a deprecated request originating from a user', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 200,
+ warnings: ['299 Elasticsearch-8.1.0 "GET /_path is deprecated"'],
+ params: {
+ method: 'GET',
+ path: '/_path',
+ querystring: { hello: 'dolly' },
+ },
+ body: {
+ hits: [
+ {
+ _source: 'may the source be with you',
+ },
+ ],
+ },
+ });
+ client.diagnostic.emit('response', null, response);
+
+ expect(loggingSystemMock.collect(logger).info).toEqual([]);
+ // Test debug[1] since theree is one log entry from 'elasticsearch.query' context
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch(
+ 'Elasticsearch deprecation: 299 Elasticsearch-8.1.0 "GET /_path is deprecated"'
+ );
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch('Origin:user');
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch(/Stack trace:\n.*at/);
+ expect(loggingSystemMock.collect(logger).debug[1][0]).toMatch(
+ /Query:\n.*200\n.*GET \/_path\?hello\=dolly/
+ );
+ });
+
+ it('logs warning when the client receives an Elasticsearch success response for a deprecated request originating from kibana', () => {
+ instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' });
+
+ const response = createApiResponse({
+ statusCode: 200,
+ warnings: ['299 Elasticsearch-8.1.0 "GET /_path is deprecated"'],
+ params: {
+ method: 'GET',
+ path: '/_path',
+ querystring: { hello: 'dolly' },
+ // Set the request header to indicate to Elasticsearch that this is a request over which users have no control
+ headers: { 'x-elastic-product-origin': 'kibana' },
+ },
+ body: {
+ hits: [
+ {
+ _source: 'may the source be with you',
+ },
+ ],
+ },
+ });
+ client.diagnostic.emit('response', null, response);
+
+ // One debug log entry from 'elasticsearch.query' context
+ expect(loggingSystemMock.collect(logger).debug.length).toEqual(1);
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch(
+ 'Elasticsearch deprecation: 299 Elasticsearch-8.1.0 "GET /_path is deprecated"'
+ );
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch('Origin:kibana');
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch(/Stack trace:\n.*at/);
+ expect(loggingSystemMock.collect(logger).info[0][0]).toMatch(
+ /Query:\n.*200\n.*GET \/_path\?hello\=dolly/
+ );
+ });
+ });
+});
diff --git a/src/core/server/elasticsearch/client/log_query_and_deprecation.ts b/src/core/server/elasticsearch/client/log_query_and_deprecation.ts
new file mode 100644
index 0000000000000..fc5a0fa6e1111
--- /dev/null
+++ b/src/core/server/elasticsearch/client/log_query_and_deprecation.ts
@@ -0,0 +1,143 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { Buffer } from 'buffer';
+import { stringify } from 'querystring';
+import { errors, DiagnosticResult, RequestBody, Client } from '@elastic/elasticsearch';
+import type { ElasticsearchErrorDetails } from './types';
+import { Logger } from '../../logging';
+
+const convertQueryString = (qs: string | Record | undefined): string => {
+ if (qs === undefined || typeof qs === 'string') {
+ return qs ?? '';
+ }
+ return stringify(qs);
+};
+
+function ensureString(body: RequestBody): string {
+ if (typeof body === 'string') return body;
+ if (Buffer.isBuffer(body)) return '[buffer]';
+ if ('readable' in body && body.readable && typeof body._read === 'function') return '[stream]';
+ return JSON.stringify(body);
+}
+
+/**
+ * Returns a debug message from an Elasticsearch error in the following format:
+ * [error type] error reason
+ */
+export function getErrorMessage(error: errors.ElasticsearchClientError): string {
+ if (error instanceof errors.ResponseError) {
+ const errorBody = error.meta.body as ElasticsearchErrorDetails;
+ return `[${errorBody?.error?.type}]: ${errorBody?.error?.reason ?? error.message}`;
+ }
+ return `[${error.name}]: ${error.message}`;
+}
+
+/**
+ * returns a string in format:
+ *
+ * status code
+ * method URL
+ * request body
+ *
+ * so it could be copy-pasted into the Dev console
+ */
+function getResponseMessage(event: DiagnosticResult): string {
+ const errorMeta = getRequestDebugMeta(event);
+ const body = errorMeta.body ? `\n${errorMeta.body}` : '';
+ return `${errorMeta.statusCode}\n${errorMeta.method} ${errorMeta.url}${body}`;
+}
+
+/**
+ * Returns stringified debug information from an Elasticsearch request event
+ * useful for logging in case of an unexpected failure.
+ */
+export function getRequestDebugMeta(event: DiagnosticResult): {
+ url: string;
+ body: string;
+ statusCode: number | null;
+ method: string;
+} {
+ const params = event.meta.request.params;
+ // definition is wrong, `params.querystring` can be either a string or an object
+ const querystring = convertQueryString(params.querystring);
+ return {
+ url: `${params.path}${querystring ? `?${querystring}` : ''}`,
+ body: params.body ? `${ensureString(params.body)}` : '',
+ method: params.method,
+ statusCode: event.statusCode!,
+ };
+}
+
+/** HTTP Warning headers have the following syntax:
+ * (where warn-code is a three digit number)
+ * This function tests if a warning comes from an Elasticsearch warn-agent
+ * */
+const isEsWarning = (warning: string) => /\d\d\d Elasticsearch-/.test(warning);
+
+export const instrumentEsQueryAndDeprecationLogger = ({
+ logger,
+ client,
+ type,
+}: {
+ logger: Logger;
+ client: Client;
+ type: string;
+}) => {
+ const queryLogger = logger.get('query', type);
+ const deprecationLogger = logger.get('deprecation');
+ client.diagnostic.on('response', (error, event) => {
+ if (event) {
+ const opaqueId = event.meta.request.options.opaqueId;
+ const meta = opaqueId
+ ? {
+ http: { request: { id: event.meta.request.options.opaqueId } },
+ }
+ : undefined; // do not clutter logs if opaqueId is not present
+ let queryMsg = '';
+ if (error) {
+ if (error instanceof errors.ResponseError) {
+ queryMsg = `${getResponseMessage(event)} ${getErrorMessage(error)}`;
+ } else {
+ queryMsg = getErrorMessage(error);
+ }
+ } else {
+ queryMsg = getResponseMessage(event);
+ }
+
+ queryLogger.debug(queryMsg, meta);
+
+ if (event.warnings && event.warnings.filter(isEsWarning).length > 0) {
+ // Plugins can explicitly mark requests as originating from a user by
+ // removing the `'x-elastic-product-origin': 'kibana'` header that's
+ // added by default. User requests will be shown to users in the
+ // upgrade assistant UI as an action item that has to be addressed
+ // before they upgrade.
+ // Kibana requests will be hidden from the upgrade assistant UI and are
+ // only logged to help developers maintain their plugins
+ const requestOrigin =
+ (event.meta.request.params.headers != null &&
+ (event.meta.request.params.headers[
+ 'x-elastic-product-origin'
+ ] as unknown as string)) === 'kibana'
+ ? 'kibana'
+ : 'user';
+
+ // Strip the first 5 stack trace lines as these are irrelavent to finding the call site
+ const stackTrace = new Error().stack?.split('\n').slice(5).join('\n');
+
+ const deprecationMsg = `Elasticsearch deprecation: ${event.warnings}\nOrigin:${requestOrigin}\nStack trace:\n${stackTrace}\nQuery:\n${queryMsg}`;
+ if (requestOrigin === 'kibana') {
+ deprecationLogger.info(deprecationMsg);
+ } else {
+ deprecationLogger.debug(deprecationMsg);
+ }
+ }
+ }
+ });
+};
diff --git a/src/core/server/elasticsearch/elasticsearch_service.test.ts b/src/core/server/elasticsearch/elasticsearch_service.test.ts
index 3b75d19b80a10..ce5672ad30519 100644
--- a/src/core/server/elasticsearch/elasticsearch_service.test.ts
+++ b/src/core/server/elasticsearch/elasticsearch_service.test.ts
@@ -21,7 +21,7 @@ import { MockClusterClient, isScriptingEnabledMock } from './elasticsearch_servi
import type { NodesVersionCompatibility } from './version_check/ensure_es_version';
import { BehaviorSubject } from 'rxjs';
import { first } from 'rxjs/operators';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { Env } from '../config';
import { configServiceMock, getEnvOptions } from '../config/mocks';
import { CoreContext } from '../core_context';
diff --git a/src/core/server/http/cookie_session_storage.test.ts b/src/core/server/http/cookie_session_storage.test.ts
index ad05d37c81e99..8e2cd58733faf 100644
--- a/src/core/server/http/cookie_session_storage.test.ts
+++ b/src/core/server/http/cookie_session_storage.test.ts
@@ -8,7 +8,7 @@
import { parse as parseCookie } from 'tough-cookie';
import supertest from 'supertest';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { ByteSizeValue } from '@kbn/config-schema';
import { BehaviorSubject } from 'rxjs';
diff --git a/src/core/server/http/http_service.test.ts b/src/core/server/http/http_service.test.ts
index 4955d19668580..3a387cdfd5e35 100644
--- a/src/core/server/http/http_service.test.ts
+++ b/src/core/server/http/http_service.test.ts
@@ -10,7 +10,7 @@ import { mockHttpServer } from './http_service.test.mocks';
import { noop } from 'lodash';
import { BehaviorSubject } from 'rxjs';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { getEnvOptions } from '../config/mocks';
import { HttpService } from '.';
import { HttpConfigType, config } from './http_config';
diff --git a/src/core/server/http/test_utils.ts b/src/core/server/http/test_utils.ts
index 4e1a88e967f8f..8a8c545b365b3 100644
--- a/src/core/server/http/test_utils.ts
+++ b/src/core/server/http/test_utils.ts
@@ -8,7 +8,7 @@
import { BehaviorSubject } from 'rxjs';
import moment from 'moment';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { ByteSizeValue } from '@kbn/config-schema';
import { Env } from '../config';
import { HttpService } from './http_service';
diff --git a/src/core/server/metrics/logging/get_ops_metrics_log.test.ts b/src/core/server/metrics/logging/get_ops_metrics_log.test.ts
index cba188c94c74e..3fd3c4a7a24d6 100644
--- a/src/core/server/metrics/logging/get_ops_metrics_log.test.ts
+++ b/src/core/server/metrics/logging/get_ops_metrics_log.test.ts
@@ -42,6 +42,7 @@ const testMetrics = {
memory: { heap: { used_in_bytes: 100 } },
uptime_in_millis: 1500,
event_loop_delay: 50,
+ event_loop_delay_histogram: { percentiles: { '50': 50, '75': 75, '95': 95, '99': 99 } },
},
os: {
load: {
@@ -56,7 +57,7 @@ describe('getEcsOpsMetricsLog', () => {
it('provides correctly formatted message', () => {
const result = getEcsOpsMetricsLog(createMockOpsMetrics(testMetrics));
expect(result.message).toMatchInlineSnapshot(
- `"memory: 100.0B uptime: 0:00:01 load: [10.00,20.00,30.00] delay: 50.000"`
+ `"memory: 100.0B uptime: 0:00:01 load: [10.00,20.00,30.00] mean delay: 50.000 delay histogram: { 50: 50.000; 95: 95.000; 99: 99.000 }"`
);
});
@@ -70,6 +71,7 @@ describe('getEcsOpsMetricsLog', () => {
const missingMetrics = {
...baseMetrics,
process: {},
+ processes: [],
os: {},
} as unknown as OpsMetrics;
const logMeta = getEcsOpsMetricsLog(missingMetrics);
@@ -77,39 +79,41 @@ describe('getEcsOpsMetricsLog', () => {
});
it('provides an ECS-compatible response', () => {
- const logMeta = getEcsOpsMetricsLog(createBaseOpsMetrics());
- expect(logMeta).toMatchInlineSnapshot(`
+ const logMeta = getEcsOpsMetricsLog(createMockOpsMetrics(testMetrics));
+ expect(logMeta.meta).toMatchInlineSnapshot(`
Object {
- "message": "memory: 1.0B load: [1.00,1.00,1.00] delay: 1.000",
- "meta": Object {
- "event": Object {
- "category": Array [
- "process",
- "host",
- ],
- "kind": "metric",
- "type": Array [
- "info",
- ],
- },
- "host": Object {
- "os": Object {
- "load": Object {
- "15m": 1,
- "1m": 1,
- "5m": 1,
- },
+ "event": Object {
+ "category": Array [
+ "process",
+ "host",
+ ],
+ "kind": "metric",
+ "type": Array [
+ "info",
+ ],
+ },
+ "host": Object {
+ "os": Object {
+ "load": Object {
+ "15m": 30,
+ "1m": 10,
+ "5m": 20,
},
},
- "process": Object {
- "eventLoopDelay": 1,
- "memory": Object {
- "heap": Object {
- "usedInBytes": 1,
- },
+ },
+ "process": Object {
+ "eventLoopDelay": 50,
+ "eventLoopDelayHistogram": Object {
+ "50": 50,
+ "95": 95,
+ "99": 99,
+ },
+ "memory": Object {
+ "heap": Object {
+ "usedInBytes": 100,
},
- "uptime": 0,
},
+ "uptime": 1,
},
}
`);
diff --git a/src/core/server/metrics/logging/get_ops_metrics_log.ts b/src/core/server/metrics/logging/get_ops_metrics_log.ts
index 7e13f35889ec7..6211407ae86f0 100644
--- a/src/core/server/metrics/logging/get_ops_metrics_log.ts
+++ b/src/core/server/metrics/logging/get_ops_metrics_log.ts
@@ -30,10 +30,29 @@ export function getEcsOpsMetricsLog(metrics: OpsMetrics) {
// HH:mm:ss message format for backward compatibility
const uptimeValMsg = uptimeVal ? `uptime: ${numeral(uptimeVal).format('00:00:00')} ` : '';
- // Event loop delay is in ms
+ // Event loop delay metrics are in ms
const eventLoopDelayVal = process?.event_loop_delay;
const eventLoopDelayValMsg = eventLoopDelayVal
- ? `delay: ${numeral(process?.event_loop_delay).format('0.000')}`
+ ? `mean delay: ${numeral(process?.event_loop_delay).format('0.000')}`
+ : '';
+
+ const eventLoopDelayPercentiles = process?.event_loop_delay_histogram?.percentiles;
+
+ // Extract 50th, 95th and 99th percentiles for log meta
+ const eventLoopDelayHistVals = eventLoopDelayPercentiles
+ ? {
+ 50: eventLoopDelayPercentiles[50],
+ 95: eventLoopDelayPercentiles[95],
+ 99: eventLoopDelayPercentiles[99],
+ }
+ : undefined;
+ // Format message from 50th, 95th and 99th percentiles
+ const eventLoopDelayHistMsg = eventLoopDelayPercentiles
+ ? ` delay histogram: { 50: ${numeral(eventLoopDelayPercentiles['50']).format(
+ '0.000'
+ )}; 95: ${numeral(eventLoopDelayPercentiles['95']).format('0.000')}; 99: ${numeral(
+ eventLoopDelayPercentiles['99']
+ ).format('0.000')} }`
: '';
const loadEntries = {
@@ -65,6 +84,7 @@ export function getEcsOpsMetricsLog(metrics: OpsMetrics) {
},
},
eventLoopDelay: eventLoopDelayVal,
+ eventLoopDelayHistogram: eventLoopDelayHistVals,
},
host: {
os: {
@@ -75,7 +95,13 @@ export function getEcsOpsMetricsLog(metrics: OpsMetrics) {
};
return {
- message: `${processMemoryUsedInBytesMsg}${uptimeValMsg}${loadValsMsg}${eventLoopDelayValMsg}`,
+ message: [
+ processMemoryUsedInBytesMsg,
+ uptimeValMsg,
+ loadValsMsg,
+ eventLoopDelayValMsg,
+ eventLoopDelayHistMsg,
+ ].join(''),
meta,
};
}
diff --git a/src/core/server/metrics/metrics_service.test.ts b/src/core/server/metrics/metrics_service.test.ts
index d7de41fd7ccf7..27043b8fa2c8a 100644
--- a/src/core/server/metrics/metrics_service.test.ts
+++ b/src/core/server/metrics/metrics_service.test.ts
@@ -203,6 +203,7 @@ describe('MetricsService', () => {
},
"process": Object {
"eventLoopDelay": undefined,
+ "eventLoopDelayHistogram": undefined,
"memory": Object {
"heap": Object {
"usedInBytes": undefined,
diff --git a/src/core/server/plugins/discovery/plugins_discovery.test.ts b/src/core/server/plugins/discovery/plugins_discovery.test.ts
index 958e051d0476d..a6ffdff4422be 100644
--- a/src/core/server/plugins/discovery/plugins_discovery.test.ts
+++ b/src/core/server/plugins/discovery/plugins_discovery.test.ts
@@ -7,7 +7,7 @@
*/
// must be before mocks imports to avoid conflicting with `REPO_ROOT` accessor.
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { mockPackage, scanPluginSearchPathsMock } from './plugins_discovery.test.mocks';
import mockFs from 'mock-fs';
import { loggingSystemMock } from '../../logging/logging_system.mock';
diff --git a/src/core/server/plugins/integration_tests/plugins_service.test.ts b/src/core/server/plugins/integration_tests/plugins_service.test.ts
index 4170d9422f277..ebbb3fa473b6d 100644
--- a/src/core/server/plugins/integration_tests/plugins_service.test.ts
+++ b/src/core/server/plugins/integration_tests/plugins_service.test.ts
@@ -7,7 +7,7 @@
*/
// must be before mocks imports to avoid conflicting with `REPO_ROOT` accessor.
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { mockPackage, mockDiscover } from './plugins_service.test.mocks';
import { join } from 'path';
diff --git a/src/core/server/plugins/plugin.test.ts b/src/core/server/plugins/plugin.test.ts
index 513e893992005..92cbda2a69cfe 100644
--- a/src/core/server/plugins/plugin.test.ts
+++ b/src/core/server/plugins/plugin.test.ts
@@ -8,7 +8,7 @@
import { join } from 'path';
import { BehaviorSubject } from 'rxjs';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { schema } from '@kbn/config-schema';
import { Env } from '../config';
diff --git a/src/core/server/plugins/plugin_context.test.ts b/src/core/server/plugins/plugin_context.test.ts
index 867d4d978314b..7bcf392ed510b 100644
--- a/src/core/server/plugins/plugin_context.test.ts
+++ b/src/core/server/plugins/plugin_context.test.ts
@@ -8,7 +8,7 @@
import { duration } from 'moment';
import { first } from 'rxjs/operators';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { fromRoot } from '@kbn/utils';
import {
createPluginInitializerContext,
diff --git a/src/core/server/plugins/plugins_config.test.ts b/src/core/server/plugins/plugins_config.test.ts
index d65b057fb65c0..b9225054e63ef 100644
--- a/src/core/server/plugins/plugins_config.test.ts
+++ b/src/core/server/plugins/plugins_config.test.ts
@@ -6,7 +6,7 @@
* Side Public License, v 1.
*/
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { getEnvOptions } from '../config/mocks';
import { PluginsConfig, PluginsConfigType } from './plugins_config';
import { Env } from '../config';
diff --git a/src/core/server/plugins/plugins_service.test.ts b/src/core/server/plugins/plugins_service.test.ts
index 0c077d732c67b..5a05817d2111f 100644
--- a/src/core/server/plugins/plugins_service.test.ts
+++ b/src/core/server/plugins/plugins_service.test.ts
@@ -11,7 +11,8 @@ import { mockDiscover, mockPackage } from './plugins_service.test.mocks';
import { resolve, join } from 'path';
import { BehaviorSubject, from } from 'rxjs';
import { schema } from '@kbn/config-schema';
-import { createAbsolutePathSerializer, REPO_ROOT } from '@kbn/dev-utils';
+import { createAbsolutePathSerializer } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { ConfigPath, ConfigService, Env } from '../config';
import { rawConfigServiceMock, getEnvOptions } from '../config/mocks';
diff --git a/src/core/server/plugins/plugins_system.test.ts b/src/core/server/plugins/plugins_system.test.ts
index 4cd8e4c551bea..3d8a47005b362 100644
--- a/src/core/server/plugins/plugins_system.test.ts
+++ b/src/core/server/plugins/plugins_system.test.ts
@@ -14,7 +14,7 @@ import {
import { BehaviorSubject } from 'rxjs';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { Env } from '../config';
import { configServiceMock, getEnvOptions } from '../config/mocks';
import { CoreContext } from '../core_context';
diff --git a/src/core/server/preboot/preboot_service.test.ts b/src/core/server/preboot/preboot_service.test.ts
index dd4b1cb7d1df0..77242f0c5765f 100644
--- a/src/core/server/preboot/preboot_service.test.ts
+++ b/src/core/server/preboot/preboot_service.test.ts
@@ -7,7 +7,7 @@
*/
import { nextTick } from '@kbn/test/jest';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { LoggerFactory } from '@kbn/logging';
import { Env } from '@kbn/config';
import { getEnvOptions } from '../config/mocks';
diff --git a/src/core/server/root/index.test.ts b/src/core/server/root/index.test.ts
index 7eba051a128f0..6ea3e05b9c2c2 100644
--- a/src/core/server/root/index.test.ts
+++ b/src/core/server/root/index.test.ts
@@ -10,7 +10,7 @@ import { rawConfigService, configService, logger, mockServer } from './index.tes
import { BehaviorSubject } from 'rxjs';
import { filter, first } from 'rxjs/operators';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { getEnvOptions } from '../config/mocks';
import { Root } from '.';
import { Env } from '../config';
diff --git a/src/core/server/saved_objects/migrations/integration_tests/7.7.2_xpack_100k.test.ts b/src/core/server/saved_objects/migrations/integration_tests/7.7.2_xpack_100k.test.ts
index c22c6154c2605..139cd298d28ed 100644
--- a/src/core/server/saved_objects/migrations/integration_tests/7.7.2_xpack_100k.test.ts
+++ b/src/core/server/saved_objects/migrations/integration_tests/7.7.2_xpack_100k.test.ts
@@ -8,7 +8,7 @@
import path from 'path';
import { unlink } from 'fs/promises';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { Env } from '@kbn/config';
import { getEnvOptions } from '../../../config/mocks';
import * as kbnTestServer from '../../../../test_helpers/kbn_server';
diff --git a/src/core/server/saved_objects/migrations/integration_tests/7_13_0_failed_action_tasks.test.ts b/src/core/server/saved_objects/migrations/integration_tests/7_13_0_failed_action_tasks.test.ts
index 2def8e375c81f..479b1e78e1b72 100644
--- a/src/core/server/saved_objects/migrations/integration_tests/7_13_0_failed_action_tasks.test.ts
+++ b/src/core/server/saved_objects/migrations/integration_tests/7_13_0_failed_action_tasks.test.ts
@@ -19,8 +19,7 @@ async function removeLogFile() {
await fs.unlink(logFilePath).catch(() => void 0);
}
-// FLAKY: https://github.com/elastic/kibana/issues/118626
-describe.skip('migration from 7.13 to 7.14+ with many failed action_tasks', () => {
+describe('migration from 7.13 to 7.14+ with many failed action_tasks', () => {
let esServer: kbnTestServer.TestElasticsearchUtils;
let root: Root;
let startES: () => Promise;
diff --git a/src/core/server/saved_objects/migrations/integration_tests/migration_from_older_v1.test.ts b/src/core/server/saved_objects/migrations/integration_tests/migration_from_older_v1.test.ts
index 0ed9262017263..c341463b78910 100644
--- a/src/core/server/saved_objects/migrations/integration_tests/migration_from_older_v1.test.ts
+++ b/src/core/server/saved_objects/migrations/integration_tests/migration_from_older_v1.test.ts
@@ -10,7 +10,7 @@ import Path from 'path';
import Fs from 'fs';
import Util from 'util';
import Semver from 'semver';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { Env } from '@kbn/config';
import { getEnvOptions } from '../../../config/mocks';
import * as kbnTestServer from '../../../../test_helpers/kbn_server';
diff --git a/src/core/server/saved_objects/migrations/integration_tests/migration_from_same_v1.test.ts b/src/core/server/saved_objects/migrations/integration_tests/migration_from_same_v1.test.ts
index 15d985daccba6..34d1317755c14 100644
--- a/src/core/server/saved_objects/migrations/integration_tests/migration_from_same_v1.test.ts
+++ b/src/core/server/saved_objects/migrations/integration_tests/migration_from_same_v1.test.ts
@@ -10,7 +10,7 @@ import Path from 'path';
import Fs from 'fs';
import Util from 'util';
import Semver from 'semver';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { Env } from '@kbn/config';
import { getEnvOptions } from '../../../config/mocks';
import * as kbnTestServer from '../../../../test_helpers/kbn_server';
diff --git a/src/core/server/saved_objects/migrations/integration_tests/type_registrations.test.ts b/src/core/server/saved_objects/migrations/integration_tests/type_registrations.test.ts
index 7597657e7706c..4ff66151db925 100644
--- a/src/core/server/saved_objects/migrations/integration_tests/type_registrations.test.ts
+++ b/src/core/server/saved_objects/migrations/integration_tests/type_registrations.test.ts
@@ -34,6 +34,7 @@ const previouslyRegisteredTypes = [
'cases-sub-case',
'cases-user-actions',
'config',
+ 'connector_token',
'core-usage-stats',
'dashboard',
'endpoint:user-artifact',
diff --git a/src/core/server/saved_objects/saved_objects_service.test.ts b/src/core/server/saved_objects/saved_objects_service.test.ts
index a4f6c019c9624..a8bda95af46f9 100644
--- a/src/core/server/saved_objects/saved_objects_service.test.ts
+++ b/src/core/server/saved_objects/saved_objects_service.test.ts
@@ -19,7 +19,7 @@ import {
import { BehaviorSubject } from 'rxjs';
import { RawPackageInfo } from '@kbn/config';
import { ByteSizeValue } from '@kbn/config-schema';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { SavedObjectsService } from './saved_objects_service';
import { mockCoreContext } from '../core_context.mock';
diff --git a/src/core/server/saved_objects/service/lib/repository.test.ts b/src/core/server/saved_objects/service/lib/repository.test.ts
index 1668df7a82253..ebab5898a0eb9 100644
--- a/src/core/server/saved_objects/service/lib/repository.test.ts
+++ b/src/core/server/saved_objects/service/lib/repository.test.ts
@@ -2272,7 +2272,16 @@ describe('SavedObjectsRepository', () => {
it(`self-generates an id if none is provided`, async () => {
await createSuccess(type, attributes);
- expect(client.create).toHaveBeenCalledWith(
+ expect(client.create).toHaveBeenNthCalledWith(
+ 1,
+ expect.objectContaining({
+ id: expect.objectContaining(/index-pattern:[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/),
+ }),
+ expect.anything()
+ );
+ await createSuccess(type, attributes, { id: '' });
+ expect(client.create).toHaveBeenNthCalledWith(
+ 2,
expect.objectContaining({
id: expect.objectContaining(/index-pattern:[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/),
}),
@@ -4161,6 +4170,13 @@ describe('SavedObjectsRepository', () => {
await test({});
});
+ it(`throws when id is empty`, async () => {
+ await expect(
+ savedObjectsRepository.incrementCounter(type, '', counterFields)
+ ).rejects.toThrowError(createBadRequestError('id cannot be empty'));
+ expect(client.update).not.toHaveBeenCalled();
+ });
+
it(`throws when counterField is not CounterField type`, async () => {
const test = async (field: unknown[]) => {
await expect(
@@ -4687,6 +4703,13 @@ describe('SavedObjectsRepository', () => {
expect(client.update).not.toHaveBeenCalled();
});
+ it(`throws when id is empty`, async () => {
+ await expect(savedObjectsRepository.update(type, '', attributes)).rejects.toThrowError(
+ createBadRequestError('id cannot be empty')
+ );
+ expect(client.update).not.toHaveBeenCalled();
+ });
+
it(`throws when ES is unable to find the document during get`, async () => {
client.get.mockResolvedValueOnce(
elasticsearchClientMock.createSuccessTransportRequestPromise(
diff --git a/src/core/server/saved_objects/service/lib/repository.ts b/src/core/server/saved_objects/service/lib/repository.ts
index 53bc6f158bf93..9af85499295b5 100644
--- a/src/core/server/saved_objects/service/lib/repository.ts
+++ b/src/core/server/saved_objects/service/lib/repository.ts
@@ -303,7 +303,6 @@ export class SavedObjectsRepository {
options: SavedObjectsCreateOptions = {}
): Promise> {
const {
- id = SavedObjectsUtils.generateId(),
migrationVersion,
coreMigrationVersion,
overwrite = false,
@@ -313,6 +312,7 @@ export class SavedObjectsRepository {
initialNamespaces,
version,
} = options;
+ const id = options.id || SavedObjectsUtils.generateId();
const namespace = normalizeNamespace(options.namespace);
this.validateInitialNamespaces(type, initialNamespaces);
@@ -1231,6 +1231,9 @@ export class SavedObjectsRepository {
if (!this._allowedTypes.includes(type)) {
throw SavedObjectsErrorHelpers.createGenericNotFoundError(type, id);
}
+ if (!id) {
+ throw SavedObjectsErrorHelpers.createBadRequestError('id cannot be empty'); // prevent potentially upserting a saved object with an empty ID
+ }
const { version, references, upsert, refresh = DEFAULT_REFRESH_SETTING } = options;
const namespace = normalizeNamespace(options.namespace);
@@ -1754,6 +1757,10 @@ export class SavedObjectsRepository {
upsertAttributes,
} = options;
+ if (!id) {
+ throw SavedObjectsErrorHelpers.createBadRequestError('id cannot be empty'); // prevent potentially upserting a saved object with an empty ID
+ }
+
const normalizedCounterFields = counterFields.map((counterField) => {
/**
* no counterField configs provided, instead a field name string was passed.
diff --git a/src/core/server/server.test.ts b/src/core/server/server.test.ts
index 112693aae0279..48547883d5f67 100644
--- a/src/core/server/server.test.ts
+++ b/src/core/server/server.test.ts
@@ -26,7 +26,7 @@ import {
} from './server.test.mocks';
import { BehaviorSubject } from 'rxjs';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { rawConfigServiceMock, getEnvOptions } from './config/mocks';
import { Env } from './config';
import { Server } from './server';
diff --git a/src/core/server/ui_settings/integration_tests/index.test.ts b/src/core/server/ui_settings/integration_tests/index.test.ts
index ef635e90dac70..3f85beb2acec6 100644
--- a/src/core/server/ui_settings/integration_tests/index.test.ts
+++ b/src/core/server/ui_settings/integration_tests/index.test.ts
@@ -7,7 +7,7 @@
*/
import { Env } from '@kbn/config';
-import { REPO_ROOT } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import { getEnvOptions } from '../../config/mocks';
import { startServers, stopServers } from './lib';
import { docExistsSuite } from './doc_exists';
diff --git a/src/core/test_helpers/kbn_server.ts b/src/core/test_helpers/kbn_server.ts
index 58720be637e2f..c326c7a35df63 100644
--- a/src/core/test_helpers/kbn_server.ts
+++ b/src/core/test_helpers/kbn_server.ts
@@ -6,7 +6,8 @@
* Side Public License, v 1.
*/
-import { ToolingLog, REPO_ROOT } from '@kbn/dev-utils';
+import { ToolingLog } from '@kbn/dev-utils';
+import { REPO_ROOT } from '@kbn/utils';
import {
createTestEsCluster,
CreateTestEsClusterOptions,
diff --git a/src/core/types/elasticsearch/search.ts b/src/core/types/elasticsearch/search.ts
index c28bf3c258f77..ac93a45da3258 100644
--- a/src/core/types/elasticsearch/search.ts
+++ b/src/core/types/elasticsearch/search.ts
@@ -9,6 +9,11 @@
import { ValuesType, UnionToIntersection } from 'utility-types';
import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+interface AggregationsAggregationContainer extends Record {
+ aggs?: any;
+ aggregations?: any;
+}
+
type InvalidAggregationRequest = unknown;
// ensures aggregations work with requests where aggregation options are a union type,
@@ -31,7 +36,7 @@ type KeysOfSources = T extends [any]
? KeyOfSource & KeyOfSource & KeyOfSource & KeyOfSource
: Record;
-type CompositeKeysOf =
+type CompositeKeysOf =
TAggregationContainer extends {
composite: { sources: [...infer TSource] };
}
@@ -40,7 +45,7 @@ type CompositeKeysOf =
+type TopMetricKeysOf =
TAggregationContainer extends { top_metrics: { metrics: { field: infer TField } } }
? TField
: TAggregationContainer extends { top_metrics: { metrics: Array<{ field: infer TField }> } }
@@ -92,17 +97,9 @@ type HitsOf<
>
>;
-type AggregationTypeName = Exclude<
- keyof estypes.AggregationsAggregationContainer,
- 'aggs' | 'aggregations'
->;
+type AggregationMap = Partial>;
-type AggregationMap = Partial>;
-
-type TopLevelAggregationRequest = Pick<
- estypes.AggregationsAggregationContainer,
- 'aggs' | 'aggregations'
->;
+type TopLevelAggregationRequest = Pick;
type MaybeKeyed<
TAggregationContainer,
@@ -113,448 +110,460 @@ type MaybeKeyed<
: { buckets: TBucket[] };
export type AggregateOf<
- TAggregationContainer extends estypes.AggregationsAggregationContainer,
+ TAggregationContainer extends AggregationsAggregationContainer,
TDocument
-> = (Record & {
- adjacency_matrix: {
- buckets: Array<
- {
- key: string;
- doc_count: number;
- } & SubAggregateOf
- >;
- };
- auto_date_histogram: {
- interval: string;
- buckets: Array<
- {
- key: number;
- key_as_string: string;
- doc_count: number;
- } & SubAggregateOf
- >;
- };
- avg: {
- value: number | null;
- value_as_string?: string;
- };
- avg_bucket: {
- value: number | null;
- };
- boxplot: {
- min: number | null;
- max: number | null;
- q1: number | null;
- q2: number | null;
- q3: number | null;
- };
- bucket_script: {
- value: unknown;
- };
- cardinality: {
- value: number;
- };
- children: {
- doc_count: number;
- } & SubAggregateOf;
- composite: {
- after_key: CompositeKeysOf;
- buckets: Array<
- {
+> = ValuesType<
+ Pick<
+ Record & {
+ adjacency_matrix: {
+ buckets: Array<
+ {
+ key: string;
+ doc_count: number;
+ } & SubAggregateOf
+ >;
+ };
+ auto_date_histogram: {
+ interval: string;
+ buckets: Array<
+ {
+ key: number;
+ key_as_string: string;
+ doc_count: number;
+ } & SubAggregateOf
+ >;
+ };
+ avg: {
+ value: number | null;
+ value_as_string?: string;
+ };
+ avg_bucket: {
+ value: number | null;
+ };
+ boxplot: {
+ min: number | null;
+ max: number | null;
+ q1: number | null;
+ q2: number | null;
+ q3: number | null;
+ };
+ bucket_script: {
+ value: unknown;
+ };
+ cardinality: {
+ value: number;
+ };
+ children: {
doc_count: number;
- key: CompositeKeysOf;
- } & SubAggregateOf
- >;
- };
- cumulative_cardinality: {
- value: number;
- };
- cumulative_sum: {
- value: number;
- };
- date_histogram: MaybeKeyed<
- TAggregationContainer,
- {
- key: number;
- key_as_string: string;
- doc_count: number;
- } & SubAggregateOf
- >;
- date_range: MaybeKeyed<
- TAggregationContainer,
- Partial<{ from: string | number; from_as_string: string }> &
- Partial<{ to: string | number; to_as_string: string }> & {
+ } & SubAggregateOf;
+ composite: {
+ after_key: CompositeKeysOf;
+ buckets: Array<
+ {
+ doc_count: number;
+ key: CompositeKeysOf;
+ } & SubAggregateOf
+ >;
+ };
+ cumulative_cardinality: {
+ value: number;
+ };
+ cumulative_sum: {
+ value: number;
+ };
+ date_histogram: MaybeKeyed<
+ TAggregationContainer,
+ {
+ key: number;
+ key_as_string: string;
+ doc_count: number;
+ } & SubAggregateOf
+ >;
+ date_range: MaybeKeyed<
+ TAggregationContainer,
+ Partial<{ from: string | number; from_as_string: string }> &
+ Partial<{ to: string | number; to_as_string: string }> & {
+ doc_count: number;
+ key: string;
+ }
+ >;
+ derivative:
+ | {
+ value: number | null;
+ }
+ | undefined;
+ extended_stats: {
+ count: number;
+ min: number | null;
+ max: number | null;
+ avg: number | null;
+ sum: number;
+ sum_of_squares: number | null;
+ variance: number | null;
+ variance_population: number | null;
+ variance_sampling: number | null;
+ std_deviation: number | null;
+ std_deviation_population: number | null;
+ std_deviation_sampling: number | null;
+ std_deviation_bounds: {
+ upper: number | null;
+ lower: number | null;
+ upper_population: number | null;
+ lower_population: number | null;
+ upper_sampling: number | null;
+ lower_sampling: number | null;
+ };
+ } & (
+ | {
+ min_as_string: string;
+ max_as_string: string;
+ avg_as_string: string;
+ sum_of_squares_as_string: string;
+ variance_population_as_string: string;
+ variance_sampling_as_string: string;
+ std_deviation_as_string: string;
+ std_deviation_population_as_string: string;
+ std_deviation_sampling_as_string: string;
+ std_deviation_bounds_as_string: {
+ upper: string;
+ lower: string;
+ upper_population: string;
+ lower_population: string;
+ upper_sampling: string;
+ lower_sampling: string;
+ };
+ }
+ | {}
+ );
+ extended_stats_bucket: {
+ count: number;
+ min: number | null;
+ max: number | null;
+ avg: number | null;
+ sum: number | null;
+ sum_of_squares: number | null;
+ variance: number | null;
+ variance_population: number | null;
+ variance_sampling: number | null;
+ std_deviation: number | null;
+ std_deviation_population: number | null;
+ std_deviation_sampling: number | null;
+ std_deviation_bounds: {
+ upper: number | null;
+ lower: number | null;
+ upper_population: number | null;
+ lower_population: number | null;
+ upper_sampling: number | null;
+ lower_sampling: number | null;
+ };
+ };
+ filter: {
doc_count: number;
- key: string;
- }
- >;
- derivative:
- | {
- value: number | null;
- }
- | undefined;
- extended_stats: {
- count: number;
- min: number | null;
- max: number | null;
- avg: number | null;
- sum: number;
- sum_of_squares: number | null;
- variance: number | null;
- variance_population: number | null;
- variance_sampling: number | null;
- std_deviation: number | null;
- std_deviation_population: number | null;
- std_deviation_sampling: number | null;
- std_deviation_bounds: {
- upper: number | null;
- lower: number | null;
- upper_population: number | null;
- lower_population: number | null;
- upper_sampling: number | null;
- lower_sampling: number | null;
- };
- } & (
- | {
- min_as_string: string;
- max_as_string: string;
- avg_as_string: string;
- sum_of_squares_as_string: string;
- variance_population_as_string: string;
- variance_sampling_as_string: string;
- std_deviation_as_string: string;
- std_deviation_population_as_string: string;
- std_deviation_sampling_as_string: string;
- std_deviation_bounds_as_string: {
- upper: string;
- lower: string;
- upper_population: string;
- lower_population: string;
- upper_sampling: string;
- lower_sampling: string;
+ } & SubAggregateOf;
+ filters: {
+ buckets: TAggregationContainer extends { filters: { filters: any[] } }
+ ? Array<
+ {
+ doc_count: number;
+ } & SubAggregateOf
+ >
+ : TAggregationContainer extends { filters: { filters: Record } }
+ ? {
+ [key in keyof TAggregationContainer['filters']['filters']]: {
+ doc_count: number;
+ } & SubAggregateOf;
+ } & (TAggregationContainer extends {
+ filters: { other_bucket_key: infer TOtherBucketKey };
+ }
+ ? Record<
+ TOtherBucketKey & string,
+ { doc_count: number } & SubAggregateOf
+ >
+ : unknown) &
+ (TAggregationContainer extends { filters: { other_bucket: true } }
+ ? {
+ _other: { doc_count: number } & SubAggregateOf<
+ TAggregationContainer,
+ TDocument
+ >;
+ }
+ : unknown)
+ : unknown;
+ };
+ geo_bounds: {
+ top_left: {
+ lat: number | null;
+ lon: number | null;
};
- }
- | {}
- );
- extended_stats_bucket: {
- count: number;
- min: number | null;
- max: number | null;
- avg: number | null;
- sum: number | null;
- sum_of_squares: number | null;
- variance: number | null;
- variance_population: number | null;
- variance_sampling: number | null;
- std_deviation: number | null;
- std_deviation_population: number | null;
- std_deviation_sampling: number | null;
- std_deviation_bounds: {
- upper: number | null;
- lower: number | null;
- upper_population: number | null;
- lower_population: number | null;
- upper_sampling: number | null;
- lower_sampling: number | null;
- };
- };
- filter: {
- doc_count: number;
- } & SubAggregateOf;
- filters: {
- buckets: TAggregationContainer extends { filters: { filters: any[] } }
- ? Array<
+ bottom_right: {
+ lat: number | null;
+ lon: number | null;
+ };
+ };
+ geo_centroid: {
+ count: number;
+ location: {
+ lat: number;
+ lon: number;
+ };
+ };
+ geo_distance: MaybeKeyed<
+ TAggregationContainer,
+ {
+ from: number;
+ to?: number;
+ doc_count: number;
+ } & SubAggregateOf
+ >;
+ geo_hash: {
+ buckets: Array<
{
doc_count: number;
+ key: string;
} & SubAggregateOf
- >
- : TAggregationContainer extends { filters: { filters: Record } }
- ? {
- [key in keyof TAggregationContainer['filters']['filters']]: {
+ >;
+ };
+ geotile_grid: {
+ buckets: Array<
+ {
doc_count: number;
- } & SubAggregateOf;
- } & (TAggregationContainer extends { filters: { other_bucket_key: infer TOtherBucketKey } }
- ? Record<
- TOtherBucketKey & string,
- { doc_count: number } & SubAggregateOf
- >
- : unknown) &
- (TAggregationContainer extends { filters: { other_bucket: true } }
- ? { _other: { doc_count: number } & SubAggregateOf }
- : unknown)
- : unknown;
- };
- geo_bounds: {
- top_left: {
- lat: number | null;
- lon: number | null;
- };
- bottom_right: {
- lat: number | null;
- lon: number | null;
- };
- };
- geo_centroid: {
- count: number;
- location: {
- lat: number;
- lon: number;
- };
- };
- geo_distance: MaybeKeyed<
- TAggregationContainer,
- {
- from: number;
- to?: number;
- doc_count: number;
- } & SubAggregateOf
- >;
- geo_hash: {
- buckets: Array<
- {
+ key: string;
+ } & SubAggregateOf
+ >;
+ };
+ global: {
doc_count: number;
- key: string;
- } & SubAggregateOf
- >;
- };
- geotile_grid: {
- buckets: Array<
- {
+ } & SubAggregateOf;
+ histogram: MaybeKeyed<
+ TAggregationContainer,
+ {
+ key: number;
+ doc_count: number;
+ } & SubAggregateOf
+ >;
+ ip_range: MaybeKeyed<
+ TAggregationContainer,
+ {
+ key: string;
+ from?: string;
+ to?: string;
+ doc_count: number;
+ },
+ TAggregationContainer extends { ip_range: { ranges: Array } }
+ ? TRangeType extends { key: infer TKeys }
+ ? TKeys
+ : string
+ : string
+ >;
+ inference: {
+ value: number;
+ prediction_probability: number;
+ prediction_score: number;
+ };
+ max: {
+ value: number | null;
+ value_as_string?: string;
+ };
+ max_bucket: {
+ value: number | null;
+ };
+ min: {
+ value: number | null;
+ value_as_string?: string;
+ };
+ min_bucket: {
+ value: number | null;
+ };
+ median_absolute_deviation: {
+ value: number | null;
+ };
+ moving_avg:
+ | {
+ value: number | null;
+ }
+ | undefined;
+ moving_fn: {
+ value: number | null;
+ };
+ moving_percentiles: TAggregationContainer extends Record
+ ? Array<{ key: number; value: number | null }>
+ : Record | undefined;
+ missing: {
doc_count: number;
- key: string;
- } & SubAggregateOf
- >;
- };
- global: {
- doc_count: number;
- } & SubAggregateOf;
- histogram: MaybeKeyed<
- TAggregationContainer,
- {
- key: number;
- doc_count: number;
- } & SubAggregateOf
- >;
- ip_range: MaybeKeyed<
- TAggregationContainer,
- {
- key: string;
- from?: string;
- to?: string;
- doc_count: number;
- },
- TAggregationContainer extends { ip_range: { ranges: Array } }
- ? TRangeType extends { key: infer TKeys }
- ? TKeys
- : string
- : string
- >;
- inference: {
- value: number;
- prediction_probability: number;
- prediction_score: number;
- };
- max: {
- value: number | null;
- value_as_string?: string;
- };
- max_bucket: {
- value: number | null;
- };
- min: {
- value: number | null;
- value_as_string?: string;
- };
- min_bucket: {
- value: number | null;
- };
- median_absolute_deviation: {
- value: number | null;
- };
- moving_avg:
- | {
+ } & SubAggregateOf;
+ multi_terms: {
+ doc_count_error_upper_bound: number;
+ sum_other_doc_count: number;
+ buckets: Array<
+ {
+ doc_count: number;
+ key: string[];
+ } & SubAggregateOf
+ >;
+ };
+ nested: {
+ doc_count: number;
+ } & SubAggregateOf;
+ normalize: {
value: number | null;
- }
- | undefined;
- moving_fn: {
- value: number | null;
- };
- moving_percentiles: TAggregationContainer extends Record
- ? Array<{ key: number; value: number | null }>
- : Record | undefined;
- missing: {
- doc_count: number;
- } & SubAggregateOf;
- multi_terms: {
- doc_count_error_upper_bound: number;
- sum_other_doc_count: number;
- buckets: Array<
- {
+ // TODO: should be perhaps based on input? ie when `format` is specified
+ value_as_string?: string;
+ };
+ parent: {
doc_count: number;
- key: string[];
- } & SubAggregateOf
- >;
- };
- nested: {
- doc_count: number;
- } & SubAggregateOf;
- normalize: {
- value: number | null;
- // TODO: should be perhaps based on input? ie when `format` is specified
- value_as_string?: string;
- };
- parent: {
- doc_count: number;
- } & SubAggregateOf;
- percentiles: {
- values: TAggregationContainer extends Record
- ? Array<{ key: number; value: number | null }>
- : Record;
- };
- percentile_ranks: {
- values: TAggregationContainer extends Record
- ? Array<{ key: number; value: number | null }>
- : Record;
- };
- percentiles_bucket: {
- values: TAggregationContainer extends Record
- ? Array<{ key: number; value: number | null }>
- : Record;
- };
- range: MaybeKeyed<
- TAggregationContainer,
- {
- key: string;
- from?: number;
- from_as_string?: string;
- to?: number;
- to_as_string?: string;
- doc_count: number;
- },
- TAggregationContainer extends { range: { ranges: Array } }
- ? TRangeType extends { key: infer TKeys }
- ? TKeys
- : string
- : string
- >;
- rare_terms: Array<
- {
- key: string | number;
- doc_count: number;
- } & SubAggregateOf
- >;
- rate: {
- value: number | null;
- };
- reverse_nested: {
- doc_count: number;
- } & SubAggregateOf;
- sampler: {
- doc_count: number;
- } & SubAggregateOf;
- scripted_metric: {
- value: unknown;
- };
- serial_diff: {
- value: number | null;
- // TODO: should be perhaps based on input? ie when `format` is specified
- value_as_string?: string;
- };
- significant_terms: {
- doc_count: number;
- bg_count: number;
- buckets: Array<
- {
- key: string | number;
- score: number;
+ } & SubAggregateOf;
+ percentiles: {
+ values: TAggregationContainer extends Record
+ ? Array<{ key: number; value: number | null }>
+ : Record;
+ };
+ percentile_ranks: {
+ values: TAggregationContainer extends Record
+ ? Array<{ key: number; value: number | null }>
+ : Record;
+ };
+ percentiles_bucket: {
+ values: TAggregationContainer extends Record
+ ? Array<{ key: number; value: number | null }>
+ : Record;
+ };
+ range: MaybeKeyed<
+ TAggregationContainer,
+ {
+ key: string;
+ from?: number;
+ from_as_string?: string;
+ to?: number;
+ to_as_string?: string;
+ doc_count: number;
+ },
+ TAggregationContainer extends { range: { ranges: Array } }
+ ? TRangeType extends { key: infer TKeys }
+ ? TKeys
+ : string
+ : string
+ >;
+ rare_terms: Array<
+ {
+ key: string | number;
+ doc_count: number;
+ } & SubAggregateOf