Address various telemetry issues

- index: fixed per elastic#43673 - add schema and generate json per elastic#64942
cee-chen · Jul 2, 2020 · f06f7a2 · f06f7a2
1 parent ec5f3e8
commit f06f7a2
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 2 deletions.
diff --git a/x-pack/plugins/enterprise_search/server/collectors/app_search/telemetry.ts b/x-pack/plugins/enterprise_search/server/collectors/app_search/telemetry.ts
@@ -12,7 +12,11 @@ import {
 } from 'src/core/server';
 import { UsageCollectionSetup } from 'src/plugins/usage_collection/server';
 
-import { AS_TELEMETRY_NAME, ITelemetrySavedObject } from '../../saved_objects/app_search/telemetry';
+import {
+  AS_TELEMETRY_NAME,
+  ITelemetrySavedObject,
+  appSearchTelemetrySchema,
+} from '../../saved_objects/app_search/telemetry';
 
 /**
  * Register the telemetry collector
@@ -22,10 +26,11 @@ export const registerTelemetryUsageCollector = (
   usageCollection: UsageCollectionSetup,
   savedObjects: SavedObjectsServiceStart
 ) => {
-  const telemetryUsageCollector = usageCollection.makeUsageCollector({
+  const telemetryUsageCollector = usageCollection.makeUsageCollector<ITelemetrySavedObject>({
     type: 'app_search',
     fetch: async () => fetchTelemetryMetrics(savedObjects),
     isReady: () => true,
+    schema: appSearchTelemetrySchema,
   });
   usageCollection.registerCollector(telemetryUsageCollector);
 };

diff --git a/x-pack/plugins/enterprise_search/server/saved_objects/app_search/telemetry.ts b/x-pack/plugins/enterprise_search/server/saved_objects/app_search/telemetry.ts
@@ -24,6 +24,22 @@ export interface ITelemetrySavedObject {
   };
 }
 
+export const appSearchTelemetrySchema = {
+  ui_viewed: {
+    setup_guide: { type: 'long' },
+    engines_overview: { type: 'long' },
+  },
+  ui_error: {
+    cannot_connect: { type: 'long' },
+    no_as_account: { type: 'long' },
+  },
+  ui_clicked: {
+    create_first_engine_button: { type: 'long' },
+    header_launch_button: { type: 'long' },
+    engine_table_link: { type: 'long' },
+  },
+};
+
 export const appSearchTelemetryType: SavedObjectsType = {
   name: AS_TELEMETRY_NAME,
   hidden: false,
@@ -35,10 +51,12 @@ export const appSearchTelemetryType: SavedObjectsType = {
           setup_guide: {
             type: 'long',
             null_value: 0,
+            index: false,
           },
           engines_overview: {
             type: 'long',
             null_value: 0,
+            index: false,
           },
         },
       },
@@ -47,10 +65,12 @@ export const appSearchTelemetryType: SavedObjectsType = {
           cannot_connect: {
             type: 'long',
             null_value: 0,
+            index: false,
           },
           no_as_account: {
             type: 'long',
             null_value: 0,
+            index: false,
           },
         },
       },
@@ -59,14 +79,17 @@ export const appSearchTelemetryType: SavedObjectsType = {
           create_first_engine_button: {
             type: 'long',
             null_value: 0,
+            index: false,
           },
           header_launch_button: {
             type: 'long',
             null_value: 0,
+            index: false,
           },
           engine_table_link: {
             type: 'long',
             null_value: 0,
+            index: false,
           },
         },
       },

diff --git a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
@@ -7,6 +7,43 @@
         }
       }
     },
+    "app_search": {
+      "properties": {
+        "ui_viewed": {
+          "properties": {
+            "setup_guide": {
+              "type": "long"
+            },
+            "engines_overview": {
+              "type": "long"
+            }
+          }
+        },
+        "ui_error": {
+          "properties": {
+            "cannot_connect": {
+              "type": "long"
+            },
+            "no_as_account": {
+              "type": "long"
+            }
+          }
+        },
+        "ui_clicked": {
+          "properties": {
+            "create_first_engine_button": {
+              "type": "long"
+            },
+            "header_launch_button": {
+              "type": "long"
+            },
+            "engine_table_link": {
+              "type": "long"
+            }
+          }
+        }
+      }
+    },
     "fileUploadTelemetry": {
       "properties": {
         "filesUploadedTotalCount": {