[Enterprise Search] Add missing Enterprise Search Overview telemetry …

…collectors/schema (#81858) * Add Enterprise Search cannot connect telemetry event * Add missing server-side telemetry collectors & schema
elastic · Oct 28, 2020 · eb30e95 · eb30e95
1 parent ac70e1e
commit eb30e95
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/...ch/public/applications/enterprise_search/components/error_connecting/error_connecting.tsx b/...ch/public/applications/enterprise_search/components/error_connecting/error_connecting.tsx
@@ -7,10 +7,12 @@
 import React from 'react';
 import { EuiPage, EuiPageContent } from '@elastic/eui';
 
+import { SendEnterpriseSearchTelemetry as SendTelemetry } from '../../../shared/telemetry';
 import { ErrorStatePrompt } from '../../../shared/error_state';
 
 export const ErrorConnecting: React.FC = () => (
   <EuiPage restrictWidth>
+    <SendTelemetry action="error" metric="cannot_connect" />
     <EuiPageContent>
       <ErrorStatePrompt />
     </EuiPageContent>

diff --git a/x-pack/plugins/enterprise_search/server/collectors/enterprise_search/telemetry.test.ts b/x-pack/plugins/enterprise_search/server/collectors/enterprise_search/telemetry.test.ts
@@ -20,6 +20,8 @@ describe('Enterprise Search Telemetry Usage Collector', () => {
     get: () => ({
       attributes: {
         'ui_viewed.overview': 10,
+        'ui_viewed.setup_guide': 5,
+        'ui_error.cannot_connect': 1,
         'ui_clicked.app_search': 2,
         'ui_clicked.workplace_search': 3,
       },
@@ -53,6 +55,10 @@ describe('Enterprise Search Telemetry Usage Collector', () => {
       expect(savedObjectsCounts).toEqual({
         ui_viewed: {
           overview: 10,
+          setup_guide: 5,
+        },
+        ui_error: {
+          cannot_connect: 1,
         },
         ui_clicked: {
           app_search: 2,
@@ -74,6 +80,10 @@ describe('Enterprise Search Telemetry Usage Collector', () => {
       expect(savedObjectsCounts).toEqual({
         ui_viewed: {
           overview: 0,
+          setup_guide: 0,
+        },
+        ui_error: {
+          cannot_connect: 0,
         },
         ui_clicked: {
           app_search: 0,

diff --git a/x-pack/plugins/enterprise_search/server/collectors/enterprise_search/telemetry.ts b/x-pack/plugins/enterprise_search/server/collectors/enterprise_search/telemetry.ts
@@ -13,6 +13,10 @@ import { getSavedObjectAttributesFromRepo } from '../lib/telemetry';
 interface ITelemetry {
   ui_viewed: {
     overview: number;
+    setup_guide: number;
+  };
+  ui_error: {
+    cannot_connect: number;
   };
   ui_clicked: {
     app_search: number;
@@ -38,6 +42,10 @@ export const registerTelemetryUsageCollector = (
     schema: {
       ui_viewed: {
         overview: { type: 'long' },
+        setup_guide: { type: 'long' },
+      },
+      ui_error: {
+        cannot_connect: { type: 'long' },
       },
       ui_clicked: {
         app_search: { type: 'long' },
@@ -63,6 +71,10 @@ const fetchTelemetryMetrics = async (savedObjects: SavedObjectsServiceStart, log
   const defaultTelemetrySavedObject: ITelemetry = {
     ui_viewed: {
       overview: 0,
+      setup_guide: 0,
+    },
+    ui_error: {
+      cannot_connect: 0,
     },
     ui_clicked: {
       app_search: 0,
@@ -78,6 +90,10 @@ const fetchTelemetryMetrics = async (savedObjects: SavedObjectsServiceStart, log
   return {
     ui_viewed: {
       overview: get(savedObjectAttributes, 'ui_viewed.overview', 0),
+      setup_guide: get(savedObjectAttributes, 'ui_viewed.setup_guide', 0),
+    },
+    ui_error: {
+      cannot_connect: get(savedObjectAttributes, 'ui_error.cannot_connect', 0),
     },
     ui_clicked: {
       app_search: get(savedObjectAttributes, 'ui_clicked.app_search', 0),

diff --git a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
@@ -1706,6 +1706,16 @@
           "properties": {
             "overview": {
               "type": "long"
+            },
+            "setup_guide": {
+              "type": "long"
+            }
+          }
+        },
+        "ui_error": {
+          "properties": {
+            "cannot_connect": {
+              "type": "long"
             }
           }
         },