feat: 🎸 connect dasdhboard telemetry to persistable state (#99498)

* feat: 🎸 connect dasdhboard telemetry to persistable state * fix: 🐛 do not mutate .telemetry() stats objects * feat: 🎸 populate stats object with embeddable telemetry * feat: 🎸 embeddable telemetry schema * feat: 🎸 update telemetry schema * feat: 🎸 add descriptions to dashboard collector * chore: 🤖 update telemetry schema Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Jun 3, 2021 · 1d39d36 · 1d39d36
1 parent 4e5652d
commit 1d39d36
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 8 deletions.
diff --git a/src/plugins/dashboard/server/usage/dashboard_telemetry.ts b/src/plugins/dashboard/server/usage/dashboard_telemetry.ts
@@ -41,13 +41,17 @@ export interface DashboardCollectorData {
   visualizationByValue: {
     [key: string]: number;
   };
+  embeddable: {
+    [key: string]: number;
+  };
 }
 
 export const getEmptyTelemetryData = (): DashboardCollectorData => ({
   panels: 0,
   panelsByValue: 0,
   lensByValue: {},
   visualizationByValue: {},
+  embeddable: {},
 });
 
 type DashboardCollectorFunction = (
@@ -115,6 +119,23 @@ export const collectForPanels: DashboardCollectorFunction = (panels, collectorDa
   collectByValueLensInfo(panels, collectorData);
 };
 
+export const collectEmbeddableData = (
+  panels: SavedDashboardPanel730ToLatest[],
+  collectorData: DashboardCollectorData,
+  embeddableService: EmbeddablePersistableStateService
+) => {
+  for (const panel of panels) {
+    collectorData.embeddable = embeddableService.telemetry(
+      {
+        ...panel.embeddableConfig,
+        id: panel.id || '',
+        type: panel.type,
+      },
+      collectorData.embeddable
+    );
+  }
+};
+
 export async function collectDashboardTelemetry(
   savedObjectClient: Pick<ISavedObjectsRepository, 'find'>,
   embeddableService: EmbeddablePersistableStateService
@@ -134,6 +155,7 @@ export async function collectDashboardTelemetry(
     ) as unknown) as SavedDashboardPanel730ToLatest[];
 
     collectForPanels(panels, collectorData);
+    collectEmbeddableData(panels, collectorData, embeddableService);
   }
 
   return collectorData;

diff --git a/src/plugins/dashboard/server/usage/register_collector.ts b/src/plugins/dashboard/server/usage/register_collector.ts
@@ -27,11 +27,28 @@ export function registerDashboardUsageCollector(
       lensByValue: {
         DYNAMIC_KEY: {
           type: 'long',
+          _meta: {
+            description:
+              'Collection of telemetry metrics for Lens visualizations, which are added to dashboard by "value".',
+          },
         },
       },
       visualizationByValue: {
         DYNAMIC_KEY: {
           type: 'long',
+          _meta: {
+            description:
+              'Collection of telemetry metrics for visualizations, which are added to dashboard by "value".',
+          },
+        },
+      },
+      embeddable: {
+        DYNAMIC_KEY: {
+          type: 'long',
+          _meta: {
+            description:
+              'Collection of telemetry metrics that embeddable service reports. Embeddable service internally calls each embeddable, which in turn calls its dynamic actions, which calls each drill down attached to that embeddable.',
+          },
         },
       },
     },

diff --git a/src/plugins/embeddable/public/plugin.tsx b/src/plugins/embeddable/public/plugin.tsx
@@ -236,7 +236,7 @@ export class EmbeddablePublicPlugin implements Plugin<EmbeddableSetup, Embeddabl
     return (
       this.enhancements.get(id) || {
         id: 'unknown',
-        telemetry: () => ({}),
+        telemetry: (state, stats) => stats,
         inject: identity,
         extract: (state: SerializableState) => {
           return { state, references: [] };

diff --git a/src/plugins/embeddable/server/plugin.ts b/src/plugins/embeddable/server/plugin.ts
@@ -90,7 +90,7 @@ export class EmbeddableServerPlugin implements Plugin<EmbeddableSetup, Embeddabl
     return (
       this.enhancements.get(id) || {
         id: 'unknown',
-        telemetry: () => ({}),
+        telemetry: (state, stats) => stats,
         inject: identity,
         extract: (state: SerializableState) => {
           return { state, references: [] };
@@ -119,7 +119,7 @@ export class EmbeddableServerPlugin implements Plugin<EmbeddableSetup, Embeddabl
     return (
       this.embeddableFactories.get(embeddableFactoryId) || {
         id: 'unknown',
-        telemetry: () => ({}),
+        telemetry: (state, stats) => stats,
         inject: (state: EmbeddableStateWithType) => state,
         extract: (state: EmbeddableStateWithType) => {
           return { state, references: [] };

diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
@@ -11,14 +11,30 @@
         "lensByValue": {
           "properties": {
             "DYNAMIC_KEY": {
-              "type": "long"
+              "type": "long",
+              "_meta": {
+                "description": "Collection of telemetry metrics for Lens visualizations, which are added to dashboard by \"value\"."
+              }
             }
           }
         },
         "visualizationByValue": {
           "properties": {
             "DYNAMIC_KEY": {
-              "type": "long"
+              "type": "long",
+              "_meta": {
+                "description": "Collection of telemetry metrics for visualizations, which are added to dashboard by \"value\"."
+              }
+            }
+          }
+        },
+        "embeddable": {
+          "properties": {
+            "DYNAMIC_KEY": {
+              "type": "long",
+              "_meta": {
+                "description": "Collection of telemetry metrics that embeddable service reports. Embeddable service internally calls each embeddable, which in turn calls its dynamic actions, which calls each drill down attached to that embeddable."
+              }
             }
           }
         }

diff --git a/x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts b/x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts
@@ -123,7 +123,7 @@ export class ActionFactory<
   }
 
   public telemetry(state: SerializedEvent, telemetryData: Record<string, any>) {
-    return this.def.telemetry ? this.def.telemetry(state, telemetryData) : {};
+    return this.def.telemetry ? this.def.telemetry(state, telemetryData) : telemetryData;
   }
 
   public extract(state: SerializedEvent) {

diff --git a/x-pack/plugins/ui_actions_enhanced/server/plugin.ts b/x-pack/plugins/ui_actions_enhanced/server/plugin.ts
@@ -52,7 +52,7 @@ export class AdvancedUiActionsServerPlugin
 
     this.actionFactories.set(definition.id, {
       id: definition.id,
-      telemetry: definition.telemetry || (() => ({})),
+      telemetry: definition.telemetry || ((state, stats) => stats),
       inject: definition.inject || identity,
       extract:
         definition.extract ||

diff --git a/x-pack/plugins/ui_actions_enhanced/server/telemetry/dynamic_actions_collector.ts b/x-pack/plugins/ui_actions_enhanced/server/telemetry/dynamic_actions_collector.ts
@@ -10,8 +10,9 @@ import { getMetricKey } from './get_metric_key';
 
 export const dynamicActionsCollector = (
   state: DynamicActionsState,
-  stats: Record<string, any>
+  currentStats: Record<string, any>
 ): Record<string, any> => {
+  const stats: Record<string, any> = { ...currentStats };
   const countMetricKey = getMetricKey('count');
 
   stats[countMetricKey] = state.events.length + (stats[countMetricKey] || 0);