Add category examples route

x-pack/legacy/plugins/infra/common/http_api/log_analysis/results/index.ts

@@ -6,4 +6,5 @@
 
 export * from './log_entry_categories';
 export * from './log_entry_category_datasets';
+export * from './log_entry_category_examples';
 export * from './log_entry_rate';

x-pack/legacy/plugins/infra/common/http_api/log_analysis/results/log_entry_category_examples.ts

@@ -0,0 +1,74 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import * as rt from 'io-ts';
+
+import {
+  badRequestErrorRT,
+  forbiddenErrorRT,
+  timeRangeRT,
+  routeTimingMetadataRT,
+} from '../../shared';
+
+export const LOG_ANALYSIS_GET_LOG_ENTRY_CATEGORY_EXAMPLES_PATH =
+  '/api/infra/log_analysis/results/log_entry_category_examples';
+
+/**
+ * request
+ */
+
+export const getLogEntryCategoryExamplesRequestPayloadRT = rt.type({
+  data: rt.type({
+    // the category to fetch the examples for
+    categoryId: rt.number,
+    // the number of examples to fetch
+    exampleCount: rt.number,
+    // the id of the source configuration
+    sourceId: rt.string,
+    // the time range to fetch the category examples from
+    timeRange: timeRangeRT,
+  }),
+});
+
+export type GetLogEntryCategoryExamplesRequestPayload = rt.TypeOf<
+  typeof getLogEntryCategoryExamplesRequestPayloadRT
+>;
+
+/**
+ * response
+ */
+
+const logEntryCategoryExampleRT = rt.type({
+  timestamp: rt.number,
+  message: rt.string,
+});
+
+export type LogEntryCategoryExample = rt.TypeOf<typeof logEntryCategoryExampleRT>;
+
+export const getLogEntryCategoryExamplesSuccessReponsePayloadRT = rt.intersection([
+  rt.type({
+    data: rt.type({
+      examples: rt.array(logEntryCategoryExampleRT),
+    }),
+  }),
+  rt.partial({
+    timing: routeTimingMetadataRT,
+  }),
+]);
+
+export type GetLogEntryCategoryExamplesSuccessResponsePayload = rt.TypeOf<
+  typeof getLogEntryCategoryExamplesSuccessReponsePayloadRT
+>;
+
+export const getLogEntryCategoryExamplesResponsePayloadRT = rt.union([
+  getLogEntryCategoryExamplesSuccessReponsePayloadRT,
+  badRequestErrorRT,
+  forbiddenErrorRT,
+]);
+
+export type GetLogEntryCategoryExamplesReponsePayload = rt.TypeOf<
+  typeof getLogEntryCategoryExamplesResponsePayloadRT
+>;

x-pack/legacy/plugins/infra/common/log_analysis/job_parameters.ts

@@ -28,3 +28,10 @@ export const jobSourceConfigurationRT = rt.type({
 });
 
 export type JobSourceConfiguration = rt.TypeOf<typeof jobSourceConfigurationRT>;
+
+export const jobCustomSettingsRT = rt.partial({
+  job_revision: rt.number,
+  logs_source_config: rt.partial(jobSourceConfigurationRT.props),
+});
+
+export type JobCustomSettings = rt.TypeOf<typeof jobCustomSettingsRT>;

x-pack/legacy/plugins/infra/public/containers/logs/log_analysis/api/ml_api_types.ts

@@ -6,13 +6,6 @@
 
 import * as rt from 'io-ts';
 
-import { jobSourceConfigurationRT } from '../../../../../common/log_analysis';
-
-export const jobCustomSettingsRT = rt.partial({
-  job_revision: rt.number,
-  logs_source_config: rt.partial(jobSourceConfigurationRT.props),
-});
-
 export const getMlCapabilitiesResponsePayloadRT = rt.type({
   capabilities: rt.type({
     canGetJobs: rt.boolean,

x-pack/legacy/plugins/infra/public/containers/logs/log_analysis/api/ml_get_jobs_summary_api.ts

@@ -4,14 +4,14 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { pipe } from 'fp-ts/lib/pipeable';
 import { fold } from 'fp-ts/lib/Either';
 import { identity } from 'fp-ts/lib/function';
+import { pipe } from 'fp-ts/lib/pipeable';
 import * as rt from 'io-ts';
 import { npStart } from 'ui/new_platform';
-import { jobCustomSettingsRT } from './ml_api_types';
-import { throwErrors, createPlainError } from '../../../../../common/runtime_types';
-import { getJobId } from '../../../../../common/log_analysis';
+
+import { getJobId, jobCustomSettingsRT } from '../../../../../common/log_analysis';
+import { createPlainError, throwErrors } from '../../../../../common/runtime_types';
 
 export const callJobsSummaryAPI = async <JobType extends string>(
   spaceId: string,

x-pack/legacy/plugins/infra/public/containers/logs/log_analysis/api/ml_get_module.ts

@@ -5,12 +5,13 @@
  */
 
 import { fold } from 'fp-ts/lib/Either';
-import { pipe } from 'fp-ts/lib/pipeable';
 import { identity } from 'fp-ts/lib/function';
+import { pipe } from 'fp-ts/lib/pipeable';
 import * as rt from 'io-ts';
 import { npStart } from 'ui/new_platform';
-import { throwErrors, createPlainError } from '../../../../../common/runtime_types';
-import { jobCustomSettingsRT } from './ml_api_types';
+
+import { jobCustomSettingsRT } from '../../../../../common/log_analysis';
+import { createPlainError, throwErrors } from '../../../../../common/runtime_types';
 
 export const callGetMlModuleAPI = async (moduleId: string) => {
   const response = await npStart.core.http.fetch(`/api/ml/modules/get_module/${moduleId}`, {

x-pack/legacy/plugins/infra/public/containers/logs/log_analysis/api/ml_setup_module_api.ts

@@ -5,12 +5,13 @@
  */
 
 import { fold } from 'fp-ts/lib/Either';
-import { pipe } from 'fp-ts/lib/pipeable';
 import { identity } from 'fp-ts/lib/function';
+import { pipe } from 'fp-ts/lib/pipeable';
 import * as rt from 'io-ts';
 import { npStart } from 'ui/new_platform';
-import { throwErrors, createPlainError } from '../../../../../common/runtime_types';
-import { getJobIdPrefix } from '../../../../../common/log_analysis';
+
+import { getJobIdPrefix, jobCustomSettingsRT } from '../../../../../common/log_analysis';
+import { createPlainError, throwErrors } from '../../../../../common/runtime_types';
 
 export const callSetupMlModuleAPI = async (
   moduleId: string,
@@ -48,7 +49,10 @@ const setupMlModuleTimeParamsRT = rt.partial({
   end: rt.number,
 });
 
-const setupMlModuleJobOverridesRT = rt.object;
+const setupMlModuleJobOverridesRT = rt.type({
+  job_id: rt.string,
+  custom_settings: jobCustomSettingsRT,
+});
 
 export type SetupMlModuleJobOverrides = rt.TypeOf<typeof setupMlModuleJobOverridesRT>;
 

x-pack/legacy/plugins/infra/server/infra_server.ts

@@ -14,6 +14,7 @@ import { InfraBackendLibs } from './lib/infra_types';
 import {
   initGetLogEntryCategoriesRoute,
   initGetLogEntryCategoryDatasetsRoute,
+  initGetLogEntryCategoryExamplesRoute,
   initGetLogEntryRateRoute,
   initValidateLogAnalysisIndicesRoute,
 } from './routes/log_analysis';
@@ -45,6 +46,7 @@ export const initInfraServer = (libs: InfraBackendLibs) => {
   initIpToHostName(libs);
   initGetLogEntryCategoriesRoute(libs);
   initGetLogEntryCategoryDatasetsRoute(libs);
+  initGetLogEntryCategoryExamplesRoute(libs);
   initGetLogEntryRateRoute(libs);
   initSnapshotRoute(libs);
   initNodeDetailsRoute(libs);

x-pack/legacy/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts

@@ -176,6 +176,11 @@ export class KibanaFramework {
     method: 'indices.get' | 'ml.getBuckets',
     options?: object
   ): Promise<InfraDatabaseGetIndicesResponse>;
+  callWithRequest(
+    requestContext: RequestHandlerContext,
+    method: 'ml.getJobs',
+    options?: object
+  ): Promise<object>;
   callWithRequest(
     requestContext: RequestHandlerContext,
     endpoint: string,

x-pack/legacy/plugins/infra/server/lib/log_analysis/errors.ts

@@ -4,9 +4,32 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+/* eslint-disable max-classes-per-file */
+
 export class NoLogAnalysisResultsIndexError extends Error {
   constructor(message?: string) {
     super(message);
     Object.setPrototypeOf(this, new.target.prototype);
   }
 }
+
+export class NoLogAnalysisMlJobError extends Error {
+  constructor(message?: string) {
+    super(message);
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+export class InsufficientLogAnalysisMlJobConfigurationError extends Error {
+  constructor(message?: string) {
+    super(message);
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+export class UnknownCategoryError extends Error {
+  constructor(categoryId: number) {
+    super(`Unknown ml category ${categoryId}`);
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}