[ML] User Annotations

x-pack/plugins/ml/common/constants/annotations.ts

@@ -0,0 +1,10 @@
+/*
+ * 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.
+ */
+
+export enum ANNOTATION_TYPE {
+  ANNOTATION = 'annotation',
+  COMMENT = 'comment',
+}

x-pack/plugins/ml/common/constants/feature_flags.ts

@@ -0,0 +1,14 @@
+/*
+ * 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.
+ */
+
+// This flag is used on the server side as the default setting.
+// Plugin initialization does some additional integrity checks and tests if the necessary
+// indices and aliases exist. Based on that the final setting will be available
+// as an injectedVar on the client side and can be accessed like:
+//
+// import chrome from 'ui/chrome';
+// const mlAnnotationsEnabled = chrome.getInjected('mlAnnotationsEnabled', false);
+export const FEATURE_ANNOTATIONS_ENABLED = true;

x-pack/plugins/ml/common/constants/index_patterns.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+export const ML_ANNOTATIONS_INDEX_ALIAS_READ = '.ml-annotations-read';
+export const ML_ANNOTATIONS_INDEX_ALIAS_WRITE = '.ml-annotations-write';
+export const ML_ANNOTATIONS_INDEX_PATTERN = '.ml-annotations-6';
+
+export const ML_RESULTS_INDEX_PATTERN = '.ml-anomalies-*';
+export const ML_NOTIFICATION_INDEX_PATTERN = '.ml-notifications';

x-pack/plugins/ml/common/constants/search.ts

@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export const ANNOTATIONS_TABLE_DEFAULT_QUERY_SIZE = 500;
+export const ANOMALIES_TABLE_DEFAULT_QUERY_SIZE = 500;

x-pack/plugins/ml/common/types/annotations.ts

@@ -0,0 +1,94 @@
+/*
+ * 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.
+ */
+
+// The Annotation interface is based on annotation documents stored in the
+// `.ml-annotations-6` index, accessed via the `.ml-annotations-[read|write]` aliases.
+
+// Annotation document mapping:
+// PUT .ml-annotations-6
+// {
+//   "mappings": {
+//     "annotation": {
+//       "properties": {
+//         "annotation": {
+//           "type": "text"
+//         },
+//         "create_time": {
+//           "type": "date",
+//           "format": "epoch_millis"
+//         },
+//         "create_username": {
+//           "type": "keyword"
+//         },
+//         "timestamp": {
+//           "type": "date",
+//           "format": "epoch_millis"
+//         },
+//         "end_timestamp": {
+//           "type": "date",
+//           "format": "epoch_millis"
+//         },
+//         "job_id": {
+//           "type": "keyword"
+//         },
+//         "modified_time": {
+//           "type": "date",
+//           "format": "epoch_millis"
+//         },
+//         "modified_username": {
+//           "type": "keyword"
+//         },
+//         "type": {
+//           "type": "keyword"
+//         }
+//       }
+//     }
+//   }
+// }
+
+// Alias
+// POST /_aliases
+// {
+//     "actions" : [
+//         { "add" : { "index" : ".ml-annotations-6", "alias" : ".ml-annotations-read" } },
+//         { "add" : { "index" : ".ml-annotations-6", "alias" : ".ml-annotations-write" } }
+//     ]
+// }
+
+import { ANNOTATION_TYPE } from '../constants/annotations';
+
+export interface Annotation {
+  _id?: string;
+  create_time?: number;
+  create_username?: string;
+  modified_time?: number;
+  modified_username?: string;
+  key?: string;
+
+  timestamp: number;
+  end_timestamp?: number;
+  annotation: string;
+  job_id: string;
+  type: ANNOTATION_TYPE.ANNOTATION | ANNOTATION_TYPE.COMMENT;
+}
+
+export function isAnnotation(arg: any): arg is Annotation {
+  return (
+    arg.timestamp !== undefined &&
+    typeof arg.annotation === 'string' &&
+    typeof arg.job_id === 'string' &&
+    (arg.type === ANNOTATION_TYPE.ANNOTATION || arg.type === ANNOTATION_TYPE.COMMENT)
+  );
+}
+
+export interface Annotations extends Array<Annotation> {}
+
+export function isAnnotations(arg: any): arg is Annotations {
+  if (Array.isArray(arg) === false) {
+    return false;
+  }
+  return arg.every((d: Annotation) => isAnnotation(d));
+}

x-pack/plugins/ml/common/types/common.ts

@@ -0,0 +1,9 @@
+/*
+ * 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.
+ */
+
+export interface Dictionary<TValue> {
+  [id: string]: TValue;
+}

x-pack/plugins/ml/common/types/jobs.ts

@@ -0,0 +1,53 @@
+/*
+ * 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.
+ */
+
+// TS TODO: This is not yet a fully fledged representation of the job data structure,
+// but it fulfills some basic TypeScript related needs.
+export interface MlJob {
+  analysis_config: {
+    bucket_span: string;
+    detectors: object[];
+    influencers: string[];
+  };
+  analysis_limits: {
+    categorization_examples_limit: number;
+    model_memory_limit: string;
+  };
+  create_time: number;
+  custom_settings: object;
+  data_counts: object;
+  data_description: {
+    time_field: string;
+    time_format: string;
+  };
+  datafeed_config: object;
+  description: string;
+  established_model_memory: number;
+  finished_time: number;
+  job_id: string;
+  job_type: string;
+  job_version: string;
+  model_plot_config: object;
+  model_size_stats: object;
+  model_snapshot_id: string;
+  model_snapshot_min_version: string;
+  model_snapshot_retention_days: number;
+  results_index_name: string;
+  state: string;
+}
+
+export function isMlJob(arg: any): arg is MlJob {
+  return typeof arg.job_id === 'string';
+}
+
+export interface MlJobs extends Array<MlJob> {}
+
+export function isMlJobs(arg: any): arg is MlJobs {
+  if (Array.isArray(arg) === false) {
+    return false;
+  }
+  return arg.every((d: MlJob) => isMlJob(d));
+}

x-pack/plugins/ml/index.js

@@ -9,7 +9,9 @@
 import { resolve } from 'path';
 import Boom from 'boom';
 import { checkLicense } from './server/lib/check_license';
+import { isAnnotationsFeatureAvailable } from './server/lib/check_annotations';
 import { mirrorPluginStatus } from '../../server/lib/mirror_plugin_status';
+import { annotationRoutes } from './server/routes/annotations';
 import { jobRoutes } from './server/routes/anomaly_detectors';
 import { dataFeedRoutes } from './server/routes/datafeeds';
 import { indicesRoutes } from './server/routes/indices';
@@ -52,8 +54,7 @@ export const ml = (kibana) => {
       },
     },
 
-
-    init: function (server) {
+    init: async function (server) {
       const thisPlugin = this;
       const xpackMainPlugin = server.plugins.xpack_main;
       mirrorPluginStatus(xpackMainPlugin, thisPlugin);
@@ -77,14 +78,18 @@ export const ml = (kibana) => {
         ]
       };
 
+      const mlAnnotationsEnabled = await isAnnotationsFeatureAvailable(server);
+
       server.injectUiAppVars('ml', () => {
         const config = server.config();
         return {
           kbnIndex: config.get('kibana.index'),
           esServerUrl: config.get('elasticsearch.url'),
+          mlAnnotationsEnabled,
         };
       });
 
+      annotationRoutes(server, commonRouteConfig);
       jobRoutes(server, commonRouteConfig);
       dataFeedRoutes(server, commonRouteConfig);
       indicesRoutes(server, commonRouteConfig);