[APM] Annotations API (#64796)

elastic · May 5, 2020 · 399eed7 · 399eed7
1 parent af8f9fa
commit 399eed7
Show file tree

Hide file tree

Showing 51 changed files with 1,640 additions and 266 deletions.
diff --git a/x-pack/plugins/apm/common/annotations.ts b/x-pack/plugins/apm/common/annotations.ts
@@ -11,6 +11,6 @@ export enum AnnotationType {
 export interface Annotation {
   type: AnnotationType;
   id: string;
-  time: number;
+  '@timestamp': number;
   text: string;
 }
diff --git a/x-pack/plugins/apm/kibana.json b/x-pack/plugins/apm/kibana.json
@@ -16,9 +16,13 @@
     "taskManager",
     "actions",
     "alerting",
+    "observability",
     "security"
   ],
   "server": true,
   "ui": true,
-  "configPath": ["xpack", "apm"]
+  "configPath": [
+    "xpack",
+    "apm"
+  ]
 }
diff --git a/x-pack/plugins/apm/public/components/shared/charts/CustomPlot/AnnotationsPlot.tsx b/x-pack/plugins/apm/public/components/shared/charts/CustomPlot/AnnotationsPlot.tsx
@@ -34,7 +34,7 @@ const style = {
 export function AnnotationsPlot(props: Props) {
   const { plotValues, annotations } = props;
 
-  const tickValues = annotations.map(annotation => annotation.time);
+  const tickValues = annotations.map(annotation => annotation['@timestamp']);
 
   return (
     <>
@@ -46,12 +46,12 @@ export function AnnotationsPlot(props: Props) {
           key={annotation.id}
           style={{
             position: 'absolute',
-            left: plotValues.x(annotation.time) - 8,
+            left: plotValues.x(annotation['@timestamp']) - 8,
             top: -2
           }}
         >
           <EuiToolTip
-            title={asAbsoluteDateTime(annotation.time, 'seconds')}
+            title={asAbsoluteDateTime(annotation['@timestamp'], 'seconds')}
             content={
               <EuiFlexGroup>
                 <EuiFlexItem grow={true}>

diff --git a/x-pack/plugins/apm/public/context/ChartsSyncContext.tsx b/x-pack/plugins/apm/public/context/ChartsSyncContext.tsx
@@ -28,7 +28,7 @@ const ChartsSyncContextProvider: React.FC = ({ children }) => {
     callApmApi => {
       if (start && end && serviceName) {
         return callApmApi({
-          pathname: '/api/apm/services/{serviceName}/annotations',
+          pathname: '/api/apm/services/{serviceName}/annotation/search',
           params: {
             path: {
               serviceName

diff --git a/x-pack/plugins/apm/scripts/optimize-tsconfig/tsconfig.json b/x-pack/plugins/apm/scripts/optimize-tsconfig/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "include": [
     "./plugins/apm/**/*",
+    "./plugins/observability/**/*",
     "./typings/**/*"
   ],
   "exclude": [

diff --git a/x-pack/plugins/apm/server/lib/helpers/create_or_update_index.ts b/x-pack/plugins/apm/server/lib/helpers/create_or_update_index.ts
diff --git a/x-pack/plugins/apm/server/lib/helpers/es_client.ts b/x-pack/plugins/apm/server/lib/helpers/es_client.ts
@@ -7,10 +7,10 @@
 /* eslint-disable no-console */
 import {
   IndexDocumentParams,
-  IndicesDeleteParams,
   SearchParams,
   IndicesCreateParams,
-  DeleteDocumentResponse
+  DeleteDocumentResponse,
+  DeleteDocumentParams
 } from 'elasticsearch';
 import { cloneDeep, isString, merge } from 'lodash';
 import { KibanaRequest } from 'src/core/server';
@@ -204,7 +204,9 @@ export function getESClient(
     index: <Body>(params: APMIndexDocumentParams<Body>) => {
       return callEs('index', params);
     },
-    delete: (params: IndicesDeleteParams): Promise<DeleteDocumentResponse> => {
+    delete: (
+      params: Omit<DeleteDocumentParams, 'type'>
+    ): Promise<DeleteDocumentResponse> => {
       return callEs('delete', params);
     },
     indicesCreate: (params: IndicesCreateParams) => {

diff --git a/x-pack/plugins/apm/server/lib/services/annotations/get_derived_service_annotations.ts b/x-pack/plugins/apm/server/lib/services/annotations/get_derived_service_annotations.ts
@@ -0,0 +1,111 @@
+/*
+ * 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 { isNumber } from 'lodash';
+import { Annotation, AnnotationType } from '../../../../common/annotations';
+import { SetupTimeRange, Setup } from '../../helpers/setup_request';
+import { ESFilter } from '../../../../typings/elasticsearch';
+import { rangeFilter } from '../../helpers/range_filter';
+import {
+  PROCESSOR_EVENT,
+  SERVICE_NAME,
+  SERVICE_VERSION
+} from '../../../../common/elasticsearch_fieldnames';
+import { getEnvironmentUiFilterES } from '../../helpers/convert_ui_filters/get_environment_ui_filter_es';
+
+export async function getDerivedServiceAnnotations({
+  setup,
+  serviceName,
+  environment
+}: {
+  serviceName: string;
+  environment?: string;
+  setup: Setup & SetupTimeRange;
+}) {
+  const { start, end, client, indices } = setup;
+
+  const filter: ESFilter[] = [
+    { term: { [PROCESSOR_EVENT]: 'transaction' } },
+    { term: { [SERVICE_NAME]: serviceName } }
+  ];
+
+  const environmentFilter = getEnvironmentUiFilterES(environment);
+
+  if (environmentFilter) {
+    filter.push(environmentFilter);
+  }
+
+  const versions =
+    (
+      await client.search({
+        index: indices['apm_oss.transactionIndices'],
+        body: {
+          size: 0,
+          query: {
+            bool: {
+              filter: filter.concat({ range: rangeFilter(start, end) })
+            }
+          },
+          aggs: {
+            versions: {
+              terms: {
+                field: SERVICE_VERSION
+              }
+            }
+          }
+        }
+      })
+    ).aggregations?.versions.buckets.map(bucket => bucket.key) ?? [];
+
+  if (versions.length <= 1) {
+    return [];
+  }
+  const annotations = await Promise.all(
+    versions.map(async version => {
+      const response = await client.search({
+        index: indices['apm_oss.transactionIndices'],
+        body: {
+          size: 0,
+          query: {
+            bool: {
+              filter: filter.concat({
+                term: {
+                  [SERVICE_VERSION]: version
+                }
+              })
+            }
+          },
+          aggs: {
+            first_seen: {
+              min: {
+                field: '@timestamp'
+              }
+            }
+          }
+        }
+      });
+
+      const firstSeen = response.aggregations?.first_seen.value;
+
+      if (!isNumber(firstSeen)) {
+        throw new Error(
+          'First seen for version was unexpectedly undefined or null.'
+        );
+      }
+
+      if (firstSeen < start || firstSeen > end) {
+        return null;
+      }
+
+      return {
+        type: AnnotationType.VERSION,
+        id: version,
+        '@timestamp': firstSeen,
+        text: version
+      };
+    })
+  );
+  return annotations.filter(Boolean) as Annotation[];
+}
diff --git a/x-pack/plugins/apm/server/lib/services/annotations/get_stored_annotations.ts b/x-pack/plugins/apm/server/lib/services/annotations/get_stored_annotations.ts
@@ -0,0 +1,76 @@
+/*
+ * 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 { APICaller } from 'kibana/server';
+import { SERVICE_NAME } from '../../../../common/elasticsearch_fieldnames';
+import { ESSearchResponse } from '../../../../typings/elasticsearch';
+import { ScopedAnnotationsClient } from '../../../../../observability/server';
+import { Annotation, AnnotationType } from '../../../../common/annotations';
+import { Annotation as ESAnnotation } from '../../../../../observability/common/annotations';
+import { SetupTimeRange, Setup } from '../../helpers/setup_request';
+import { getEnvironmentUiFilterES } from '../../helpers/convert_ui_filters/get_environment_ui_filter_es';
+
+export async function getStoredAnnotations({
+  setup,
+  serviceName,
+  environment,
+  apiCaller,
+  annotationsClient
+}: {
+  setup: Setup & SetupTimeRange;
+  serviceName: string;
+  environment?: string;
+  apiCaller: APICaller;
+  annotationsClient: ScopedAnnotationsClient;
+}): Promise<Annotation[]> {
+  try {
+    const environmentFilter = getEnvironmentUiFilterES(environment);
+
+    const response: ESSearchResponse<ESAnnotation, any> = (await apiCaller(
+      'search',
+      {
+        index: annotationsClient.index,
+        body: {
+          size: 50,
+          query: {
+            bool: {
+              filter: [
+                {
+                  range: {
+                    '@timestamp': {
+                      gte: setup.start,
+                      lt: setup.end
+                    }
+                  }
+                },
+                { term: { 'annotation.type': 'deployment' } },
+                { term: { tags: 'apm' } },
+                { term: { [SERVICE_NAME]: serviceName } },
+                ...(environmentFilter ? [environmentFilter] : [])
+              ]
+            }
+          }
+        }
+      }
+    )) as any;
+
+    return response.hits.hits.map(hit => {
+      return {
+        type: AnnotationType.VERSION,
+        id: hit._id,
+        '@timestamp': new Date(hit._source['@timestamp']).getTime(),
+        text: hit._source.message
+      };
+    });
+  } catch (error) {
+    // index is only created when an annotation has been indexed,
+    // so we should handle this error gracefully
+    if (error.body?.error?.type === 'index_not_found_exception') {
+      return [];
+    }
+    throw error;
+  }
+}