[Data table] Add telemetry for table vis split mode (#88604)

* Add telemetry for table vis * Update telemetry schema * Add unit tests * Update license * Use soClient instead of esClient, update tests Co-authored-by: Kibana Machine <[email protected]>
elastic · Jan 25, 2021 · 72ef3b1 · 72ef3b1
1 parent 2ff5235
commit 72ef3b1
Show file tree

Hide file tree

Showing 30 changed files with 398 additions and 56 deletions.
diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
@@ -5247,6 +5247,36 @@
         }
       }
     },
+    "vis_type_table": {
+      "properties": {
+        "total": {
+          "type": "long"
+        },
+        "total_split": {
+          "type": "long"
+        },
+        "split_columns": {
+          "properties": {
+            "total": {
+              "type": "long"
+            },
+            "enabled": {
+              "type": "long"
+            }
+          }
+        },
+        "split_rows": {
+          "properties": {
+            "total": {
+              "type": "long"
+            },
+            "enabled": {
+              "type": "long"
+            }
+          }
+        }
+      }
+    },
     "vis_type_vega": {
       "properties": {
         "vega_lib_specs_total": {

diff --git a/src/plugins/vis_type_table/common/index.ts b/src/plugins/vis_type_table/common/index.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
+ * and the Server Side Public License, v 1; you may not use this file except in
+ * compliance with, at your election, the Elastic License or the Server Side
+ * Public License, v 1.
+ */
+
+export * from './types';
diff --git a/src/plugins/vis_type_table/common/types.ts b/src/plugins/vis_type_table/common/types.ts
@@ -0,0 +1,28 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * and the Server Side Public License, v 1; you may not use this file except in
+ * compliance with, at your election, the Elastic License or the Server Side
+ * Public License, v 1.
+ */
+
+export const VIS_TYPE_TABLE = 'table';
+
+export enum AggTypes {
+  SUM = 'sum',
+  AVG = 'avg',
+  MIN = 'min',
+  MAX = 'max',
+  COUNT = 'count',
+}
+
+export interface TableVisParams {
+  perPage: number | '';
+  showPartialRows: boolean;
+  showMetricsAtAllLevels: boolean;
+  showToolbar: boolean;
+  showTotal: boolean;
+  totalFunc: AggTypes;
+  percentageCol: string;
+  row?: boolean;
+}
diff --git a/src/plugins/vis_type_table/jest.config.js b/src/plugins/vis_type_table/jest.config.js
@@ -11,4 +11,5 @@ module.exports = {
   rootDir: '../../..',
   roots: ['<rootDir>/src/plugins/vis_type_table'],
   testRunner: 'jasmine2',
+  collectCoverageFrom: ['<rootDir>/src/plugins/vis_type_table/**/*.{js,ts,tsx}'],
 };
diff --git a/src/plugins/vis_type_table/public/components/table_vis_options.tsx b/src/plugins/vis_type_table/public/components/table_vis_options.tsx
@@ -19,7 +19,7 @@ import {
   NumberInputOption,
   VisOptionsProps,
 } from '../../../vis_default_editor/public';
-import { TableVisParams } from '../types';
+import { TableVisParams } from '../../common';
 import { totalAggregations } from './utils';
 
 const { tabifyGetColumns } = search;

diff --git a/src/plugins/vis_type_table/public/components/table_vis_options_lazy.tsx b/src/plugins/vis_type_table/public/components/table_vis_options_lazy.tsx
@@ -9,7 +9,7 @@
 import React, { lazy, Suspense } from 'react';
 import { EuiLoadingSpinner } from '@elastic/eui';
 import { VisOptionsProps } from 'src/plugins/vis_default_editor/public';
-import { TableVisParams } from '../types';
+import { TableVisParams } from '../../common';
 
 const TableOptionsComponent = lazy(() => import('./table_vis_options'));
 

diff --git a/src/plugins/vis_type_table/public/components/utils.ts b/src/plugins/vis_type_table/public/components/utils.ts
@@ -7,7 +7,7 @@
  */
 
 import { i18n } from '@kbn/i18n';
-import { AggTypes } from '../types';
+import { AggTypes } from '../../common';
 
 const totalAggregations = [
   {

diff --git a/src/plugins/vis_type_table/public/legacy/table_vis_legacy_fn.ts b/src/plugins/vis_type_table/public/legacy/table_vis_legacy_fn.ts
@@ -10,6 +10,7 @@ import { i18n } from '@kbn/i18n';
 import { ExpressionFunctionDefinition, Datatable, Render } from 'src/plugins/expressions/public';
 import { tableVisLegacyResponseHandler, TableContext } from './table_vis_legacy_response_handler';
 import { TableVisConfig } from '../types';
+import { VIS_TYPE_TABLE } from '../../common';
 
 export type Input = Datatable;
 
@@ -19,7 +20,7 @@ interface Arguments {
 
 export interface TableVisRenderValue {
   visData: TableContext;
-  visType: 'table';
+  visType: typeof VIS_TYPE_TABLE;
   visConfig: TableVisConfig;
 }
 
@@ -53,7 +54,7 @@ export const createTableVisLegacyFn = (): TableExpressionFunctionDefinition => (
       as: 'table_vis',
       value: {
         visData: convertedData,
-        visType: 'table',
+        visType: VIS_TYPE_TABLE,
         visConfig,
       },
     };

diff --git a/src/plugins/vis_type_table/public/legacy/table_vis_legacy_type.ts b/src/plugins/vis_type_table/public/legacy/table_vis_legacy_type.ts
@@ -12,11 +12,11 @@ import { BaseVisTypeOptions } from '../../../visualizations/public';
 
 import { TableOptions } from '../components/table_vis_options_lazy';
 import { VIS_EVENT_TO_TRIGGER } from '../../../visualizations/public';
+import { TableVisParams, VIS_TYPE_TABLE } from '../../common';
 import { toExpressionAst } from '../to_ast';
-import { TableVisParams } from '../types';
 
 export const tableVisLegacyTypeDefinition: BaseVisTypeOptions<TableVisParams> = {
-  name: 'table',
+  name: VIS_TYPE_TABLE,
   title: i18n.translate('visTypeTable.tableVisTitle', {
     defaultMessage: 'Data table',
   }),

diff --git a/src/plugins/vis_type_table/public/table_vis_fn.ts b/src/plugins/vis_type_table/public/table_vis_fn.ts
@@ -10,6 +10,7 @@ import { i18n } from '@kbn/i18n';
 import { tableVisResponseHandler, TableContext } from './table_vis_response_handler';
 import { ExpressionFunctionDefinition, Datatable, Render } from '../../expressions/public';
 import { TableVisConfig } from './types';
+import { VIS_TYPE_TABLE } from '../common';
 
 export type Input = Datatable;
 
@@ -19,7 +20,7 @@ interface Arguments {
 
 export interface TableVisRenderValue {
   visData: TableContext;
-  visType: 'table';
+  visType: typeof VIS_TYPE_TABLE;
   visConfig: TableVisConfig;
 }
 
@@ -56,7 +57,7 @@ export const createTableVisFn = (): TableExpressionFunctionDefinition => ({
       as: 'table_vis',
       value: {
         visData: convertedData,
-        visType: 'table',
+        visType: VIS_TYPE_TABLE,
         visConfig,
       },
     };

diff --git a/src/plugins/vis_type_table/public/table_vis_type.ts b/src/plugins/vis_type_table/public/table_vis_type.ts
@@ -10,13 +10,13 @@ import { i18n } from '@kbn/i18n';
 import { AggGroupNames } from '../../data/public';
 import { BaseVisTypeOptions } from '../../visualizations/public';
 
+import { TableVisParams, VIS_TYPE_TABLE } from '../common';
 import { TableOptions } from './components/table_vis_options_lazy';
 import { VIS_EVENT_TO_TRIGGER } from '../../../plugins/visualizations/public';
 import { toExpressionAst } from './to_ast';
-import { TableVisParams } from './types';
 
 export const tableVisTypeDefinition: BaseVisTypeOptions<TableVisParams> = {
-  name: 'table',
+  name: VIS_TYPE_TABLE,
   title: i18n.translate('visTypeTable.tableVisTitle', {
     defaultMessage: 'Data table',
   }),

diff --git a/src/plugins/vis_type_table/public/to_ast.test.ts b/src/plugins/vis_type_table/public/to_ast.test.ts
@@ -8,7 +8,7 @@
 
 import { Vis } from 'src/plugins/visualizations/public';
 import { toExpressionAst } from './to_ast';
-import { AggTypes, TableVisParams } from './types';
+import { AggTypes, TableVisParams } from '../common';
 
 const mockSchemas = {
   metric: [{ accessor: 1, format: { id: 'number' }, params: {}, label: 'Count', aggType: 'count' }],

diff --git a/src/plugins/vis_type_table/public/to_ast.ts b/src/plugins/vis_type_table/public/to_ast.ts
@@ -12,8 +12,9 @@ import {
 } from '../../data/public';
 import { buildExpression, buildExpressionFunction } from '../../expressions/public';
 import { getVisSchemas, Vis, BuildPipelineParams } from '../../visualizations/public';
+import { TableVisParams } from '../common';
 import { TableExpressionFunctionDefinition } from './table_vis_fn';
-import { TableVisConfig, TableVisParams } from './types';
+import { TableVisConfig } from './types';
 
 const buildTableVisConfig = (
   schemas: ReturnType<typeof getVisSchemas>,

diff --git a/src/plugins/vis_type_table/public/types.ts b/src/plugins/vis_type_table/public/types.ts
@@ -8,14 +8,7 @@
 
 import { IFieldFormat } from 'src/plugins/data/public';
 import { SchemaConfig } from 'src/plugins/visualizations/public';
-
-export enum AggTypes {
-  SUM = 'sum',
-  AVG = 'avg',
-  MIN = 'min',
-  MAX = 'max',
-  COUNT = 'count',
-}
+import { TableVisParams } from '../common';
 
 export interface Dimensions {
   buckets: SchemaConfig[];
@@ -44,16 +37,6 @@ export interface TableVisUseUiStateProps {
   setColumnsWidth: (column: ColumnWidthData) => void;
 }
 
-export interface TableVisParams {
-  perPage: number | '';
-  showPartialRows: boolean;
-  showMetricsAtAllLevels: boolean;
-  showToolbar: boolean;
-  showTotal: boolean;
-  totalFunc: AggTypes;
-  percentageCol: string;
-}
-
 export interface TableVisConfig extends TableVisParams {
   title: string;
   dimensions: Dimensions;

diff --git a/src/plugins/vis_type_table/public/utils/use/use_formatted_columns.ts b/src/plugins/vis_type_table/public/utils/use/use_formatted_columns.ts
@@ -9,8 +9,9 @@
 import { useMemo } from 'react';
 import { chain, findIndex } from 'lodash';
 
+import { AggTypes } from '../../../common';
 import { Table } from '../../table_vis_response_handler';
-import { FormattedColumn, TableVisConfig, AggTypes } from '../../types';
+import { FormattedColumn, TableVisConfig } from '../../types';
 import { getFormatService } from '../../services';
 import { addPercentageColumn } from '../add_percentage_column';
 

diff --git a/src/plugins/vis_type_table/public/utils/use/use_pagination.ts b/src/plugins/vis_type_table/public/utils/use/use_pagination.ts
@@ -7,7 +7,7 @@
  */
 
 import { useCallback, useEffect, useMemo, useState } from 'react';
-import { TableVisParams } from '../../types';
+import { TableVisParams } from '../../../common';
 
 export const usePagination = (visParams: TableVisParams, rowCount: number) => {
   const [pagination, setPagination] = useState({

diff --git a/src/plugins/vis_type_table/server/index.ts b/src/plugins/vis_type_table/server/index.ts
@@ -6,9 +6,11 @@
  * Public License, v 1.
  */
 
-import { PluginConfigDescriptor } from 'kibana/server';
+import { CoreSetup, PluginConfigDescriptor } from 'kibana/server';
+import { UsageCollectionSetup } from 'src/plugins/usage_collection/server';
 
 import { configSchema, ConfigSchema } from '../config';
+import { registerVisTypeTableUsageCollector } from './usage_collector';
 
 export const config: PluginConfigDescriptor<ConfigSchema> = {
   exposeToBrowser: {
@@ -21,6 +23,10 @@ export const config: PluginConfigDescriptor<ConfigSchema> = {
 };
 
 export const plugin = () => ({
-  setup() {},
+  setup(core: CoreSetup, plugins: { usageCollection?: UsageCollectionSetup }) {
+    if (plugins.usageCollection) {
+      registerVisTypeTableUsageCollector(plugins.usageCollection);
+    }
+  },
   start() {},
 });
diff --git a/src/plugins/vis_type_table/server/usage_collector/get_stats.test.ts b/src/plugins/vis_type_table/server/usage_collector/get_stats.test.ts
@@ -0,0 +1,67 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * and the Server Side Public License, v 1; you may not use this file except in
+ * compliance with, at your election, the Elastic License or the Server Side
+ * Public License, v 1.
+ */
+
+import { SavedObjectsClientContract } from 'kibana/server';
+import { getStats } from './get_stats';
+
+const mockVisualizations = {
+  saved_objects: [
+    {
+      attributes: {
+        visState:
+          '{"type": "table","aggs": [{ "schema": "metric" }, { "schema": "bucket" }, { "schema": "split", "enabled": true }], "params": { "row": true }}',
+      },
+    },
+    {
+      attributes: {
+        visState:
+          '{"type": "table","aggs": [{ "schema": "metric" }, { "schema": "bucket" }, { "schema": "split", "enabled": false }], "params": { "row": true }}',
+      },
+    },
+    {
+      attributes: {
+        visState:
+          '{"type": "table","aggs": [{ "schema": "metric" }, { "schema": "split", "enabled": true }], "params": { "row": false }}',
+      },
+    },
+    {
+      attributes: {
+        visState: '{"type": "table","aggs": [{ "schema": "metric" }, { "schema": "bucket" }]}',
+      },
+    },
+    {
+      attributes: { visState: '{"type": "histogram"}' },
+    },
+  ],
+};
+
+describe('vis_type_table getStats', () => {
+  const mockSoClient = ({
+    find: jest.fn().mockResolvedValue(mockVisualizations),
+  } as unknown) as SavedObjectsClientContract;
+
+  test('Returns stats from saved objects for table vis only', async () => {
+    const result = await getStats(mockSoClient);
+    expect(mockSoClient.find).toHaveBeenCalledWith({
+      type: 'visualization',
+      perPage: 10000,
+    });
+    expect(result).toEqual({
+      total: 4,
+      total_split: 3,
+      split_columns: {
+        total: 1,
+        enabled: 1,
+      },
+      split_rows: {
+        total: 2,
+        enabled: 1,
+      },
+    });
+  });
+});