[Advanced Settings] Introducing telemetry (#82860)

* [Advaned Settings] Introducing telemetry * Publishing doc changes * Move metric tracking to onSave method * Adding deprecated warning * Updating docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Nov 12, 2020 · 5551966 · 5551966
1 parent c3e5794
commit 5551966
Show file tree

Hide file tree

Showing 17 changed files with 109 additions and 6 deletions.
diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md
@@ -19,6 +19,7 @@ export interface UiSettingsParams<T = unknown>
 |  [category](./kibana-plugin-core-public.uisettingsparams.category.md) | <code>string[]</code> | used to group the configured setting in the UI |
 |  [deprecation](./kibana-plugin-core-public.uisettingsparams.deprecation.md) | <code>DeprecationSettings</code> | optional deprecation information. Used to generate a deprecation warning. |
 |  [description](./kibana-plugin-core-public.uisettingsparams.description.md) | <code>string</code> | description provided to a user in UI |
+|  [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) | <code>{</code><br/><code>        type: UiStatsMetricType;</code><br/><code>        name: string;</code><br/><code>    }</code> | Metric to track once this property changes |
 |  [name](./kibana-plugin-core-public.uisettingsparams.name.md) | <code>string</code> | title in the UI |
 |  [optionLabels](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) | <code>Record&lt;string, string&gt;</code> | text labels for 'select' type UI element |
 |  [options](./kibana-plugin-core-public.uisettingsparams.options.md) | <code>string[]</code> | array of permitted values for this setting |

diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) &gt; [metric](./kibana-plugin-core-public.uisettingsparams.metric.md)
+
+## UiSettingsParams.metric property
+
+> Warning: This API is now obsolete.
+> 
+> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place
+> 
+
+Metric to track once this property changes
+
+<b>Signature:</b>
+
+```typescript
+metric?: {
+        type: UiStatsMetricType;
+        name: string;
+    };
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md
@@ -19,6 +19,7 @@ export interface UiSettingsParams<T = unknown>
 |  [category](./kibana-plugin-core-server.uisettingsparams.category.md) | <code>string[]</code> | used to group the configured setting in the UI |
 |  [deprecation](./kibana-plugin-core-server.uisettingsparams.deprecation.md) | <code>DeprecationSettings</code> | optional deprecation information. Used to generate a deprecation warning. |
 |  [description](./kibana-plugin-core-server.uisettingsparams.description.md) | <code>string</code> | description provided to a user in UI |
+|  [metric](./kibana-plugin-core-server.uisettingsparams.metric.md) | <code>{</code><br/><code>        type: UiStatsMetricType;</code><br/><code>        name: string;</code><br/><code>    }</code> | Metric to track once this property changes |
 |  [name](./kibana-plugin-core-server.uisettingsparams.name.md) | <code>string</code> | title in the UI |
 |  [optionLabels](./kibana-plugin-core-server.uisettingsparams.optionlabels.md) | <code>Record&lt;string, string&gt;</code> | text labels for 'select' type UI element |
 |  [options](./kibana-plugin-core-server.uisettingsparams.options.md) | <code>string[]</code> | array of permitted values for this setting |

diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) &gt; [metric](./kibana-plugin-core-server.uisettingsparams.metric.md)
+
+## UiSettingsParams.metric property
+
+> Warning: This API is now obsolete.
+> 
+> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place
+> 
+
+Metric to track once this property changes
+
+<b>Signature:</b>
+
+```typescript
+metric?: {
+        type: UiStatsMetricType;
+        name: string;
+    };
+```
diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -38,6 +38,7 @@ import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport';
 import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
 import { Type } from '@kbn/config-schema';
 import { TypeOf } from '@kbn/config-schema';
+import { UiStatsMetricType } from '@kbn/analytics';
 import { UnregisterCallback } from 'history';
 import { UserProvidedValues as UserProvidedValues_2 } from 'src/core/server/types';
 
@@ -1362,6 +1363,11 @@ export interface UiSettingsParams<T = unknown> {
     // Warning: (ae-forgotten-export) The symbol "DeprecationSettings" needs to be exported by the entry point index.d.ts
     deprecation?: DeprecationSettings;
     description?: string;
+    // @deprecated
+    metric?: {
+        type: UiStatsMetricType;
+        name: string;
+    };
     name?: string;
     optionLabels?: Record<string, string>;
     options?: string[];

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -160,6 +160,7 @@ import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport';
 import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
 import { Type } from '@kbn/config-schema';
 import { TypeOf } from '@kbn/config-schema';
+import { UiStatsMetricType } from '@kbn/analytics';
 import { UpdateDocumentByQueryParams } from 'elasticsearch';
 import { UpdateDocumentParams } from 'elasticsearch';
 import { URL } from 'url';
@@ -2746,6 +2747,11 @@ export interface UiSettingsParams<T = unknown> {
     category?: string[];
     deprecation?: DeprecationSettings;
     description?: string;
+    // @deprecated
+    metric?: {
+        type: UiStatsMetricType;
+        name: string;
+    };
     name?: string;
     optionLabels?: Record<string, string>;
     options?: string[];

diff --git a/src/core/types/ui_settings.ts b/src/core/types/ui_settings.ts
@@ -17,6 +17,7 @@
  * under the License.
  */
 import { Type } from '@kbn/config-schema';
+import { UiStatsMetricType } from '@kbn/analytics';
 
 /**
  * UI element type to represent the settings.
@@ -80,6 +81,15 @@ export interface UiSettingsParams<T = unknown> {
    * Used to validate value on write and read.
    */
   schema: Type<T>;
+  /**
+   * Metric to track once this property changes
+   * @deprecated
+   * Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place
+   */
+  metric?: {
+    type: UiStatsMetricType;
+    name: string;
+  };
 }
 
 /**

diff --git a/src/plugins/advanced_settings/kibana.json b/src/plugins/advanced_settings/kibana.json
@@ -4,6 +4,6 @@
   "server": true,
   "ui": true,
   "requiredPlugins": ["management"],
-  "optionalPlugins": ["home"],
+  "optionalPlugins": ["home", "usageCollection"],
   "requiredBundles": ["kibanaReact", "home"]
 }
diff --git a/src/plugins/advanced_settings/public/management_app/advanced_settings.tsx b/src/plugins/advanced_settings/public/management_app/advanced_settings.tsx
@@ -22,6 +22,7 @@ import { Subscription } from 'rxjs';
 import { Comparators, EuiFlexGroup, EuiFlexItem, EuiSpacer, Query } from '@elastic/eui';
 
 import { useParams } from 'react-router-dom';
+import { UiStatsMetricType } from '@kbn/analytics';
 import { CallOuts } from './components/call_outs';
 import { Search } from './components/search';
 import { Form } from './components/form';
@@ -39,6 +40,7 @@ interface AdvancedSettingsProps {
   dockLinks: DocLinksStart['links'];
   toasts: ToastsStart;
   componentRegistry: ComponentRegistry['start'];
+  trackUiMetric?: (metricType: UiStatsMetricType, eventName: string | string[]) => void;
 }
 
 interface AdvancedSettingsComponentProps extends AdvancedSettingsProps {
@@ -241,6 +243,7 @@ export class AdvancedSettingsComponent extends Component<
           enableSaving={this.props.enableSaving}
           dockLinks={this.props.dockLinks}
           toasts={this.props.toasts}
+          trackUiMetric={this.props.trackUiMetric}
         />
         <PageFooter
           toasts={this.props.toasts}
@@ -263,6 +266,7 @@ export const AdvancedSettings = (props: AdvancedSettingsProps) => {
       dockLinks={props.dockLinks}
       toasts={props.toasts}
       componentRegistry={props.componentRegistry}
+      trackUiMetric={props.trackUiMetric}
     />
   );
 };
diff --git a/src/plugins/advanced_settings/public/management_app/components/form/form.tsx b/src/plugins/advanced_settings/public/management_app/components/form/form.tsx
@@ -36,6 +36,7 @@ import {
 import { FormattedMessage } from '@kbn/i18n/react';
 import { isEmpty } from 'lodash';
 import { i18n } from '@kbn/i18n';
+import { UiStatsMetricType } from '@kbn/analytics';
 import { toMountPoint } from '../../../../../kibana_react/public';
 import { DocLinksStart, ToastsStart } from '../../../../../../core/public';
 
@@ -56,6 +57,7 @@ interface FormProps {
   enableSaving: boolean;
   dockLinks: DocLinksStart['links'];
   toasts: ToastsStart;
+  trackUiMetric?: (metricType: UiStatsMetricType, eventName: string | string[]) => void;
 }
 
 interface FormState {
@@ -149,7 +151,7 @@ export class Form extends PureComponent<FormProps> {
       if (!setting) {
         return;
       }
-      const { defVal, type, requiresPageReload } = setting;
+      const { defVal, type, requiresPageReload, metric } = setting;
       let valueToSave = value;
       let equalsToDefault = false;
       switch (type) {
@@ -163,6 +165,11 @@ export class Form extends PureComponent<FormProps> {
           const isArray = Array.isArray(JSON.parse((defVal as string) || '{}'));
           valueToSave = valueToSave.trim();
           valueToSave = valueToSave || (isArray ? '[]' : '{}');
+        case 'boolean':
+          if (metric && this.props.trackUiMetric) {
+            const metricName = valueToSave ? `${metric.name}_on` : `${metric.name}_off`;
+            this.props.trackUiMetric(metric.type, metricName);
+          }
         default:
           equalsToDefault = valueToSave === defVal;
       }

diff --git a/src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts b/src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts
@@ -75,6 +75,7 @@ export function toEditableConfig({
     options: def.options,
     optionLabels: def.optionLabels,
     requiresPageReload: !!def.requiresPageReload,
+    metric: def.metric,
   };
 
   return conf;

diff --git a/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx b/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx
@@ -30,6 +30,7 @@ import { ManagementAppMountParams } from '../../../management/public';
 import { ComponentRegistry } from '../types';
 
 import './index.scss';
+import { UsageCollectionSetup } from '../../../usage_collection/public';
 
 const title = i18n.translate('advancedSettings.advancedSettingsLabel', {
   defaultMessage: 'Advanced Settings',
@@ -49,12 +50,14 @@ const readOnlyBadge = {
 export async function mountManagementSection(
   getStartServices: StartServicesAccessor,
   params: ManagementAppMountParams,
-  componentRegistry: ComponentRegistry['start']
+  componentRegistry: ComponentRegistry['start'],
+  usageCollection?: UsageCollectionSetup
 ) {
   params.setBreadcrumbs(crumb);
   const [{ uiSettings, notifications, docLinks, application, chrome }] = await getStartServices();
 
   const canSave = application.capabilities.advancedSettings.save as boolean;
+  const trackUiMetric = usageCollection?.reportUiStats.bind(usageCollection, 'advanced_settings');
 
   if (!canSave) {
     chrome.setBadge(readOnlyBadge);
@@ -71,6 +74,7 @@ export async function mountManagementSection(
               dockLinks={docLinks.links}
               uiSettings={uiSettings}
               componentRegistry={componentRegistry}
+              trackUiMetric={trackUiMetric}
             />
           </Route>
         </Switch>

diff --git a/src/plugins/advanced_settings/public/management_app/types.ts b/src/plugins/advanced_settings/public/management_app/types.ts
@@ -17,6 +17,7 @@
  * under the License.
  */
 
+import { UiStatsMetricType } from '@kbn/analytics';
 import { UiSettingsType, StringValidation, ImageValidation } from '../../../../core/public';
 
 export interface FieldSetting {
@@ -39,6 +40,10 @@ export interface FieldSetting {
     message: string;
     docLinksKey: string;
   };
+  metric?: {
+    type: UiStatsMetricType;
+    name: string;
+  };
 }
 
 // until eui searchbar and query are typed

diff --git a/src/plugins/advanced_settings/public/plugin.ts b/src/plugins/advanced_settings/public/plugin.ts
@@ -30,7 +30,10 @@ const title = i18n.translate('advancedSettings.advancedSettingsLabel', {
 
 export class AdvancedSettingsPlugin
   implements Plugin<AdvancedSettingsSetup, AdvancedSettingsStart, AdvancedSettingsPluginSetup> {
-  public setup(core: CoreSetup, { management, home }: AdvancedSettingsPluginSetup) {
+  public setup(
+    core: CoreSetup,
+    { management, home, usageCollection }: AdvancedSettingsPluginSetup
+  ) {
     const kibanaSection = management.sections.section.kibana;
 
     kibanaSection.registerApp({
@@ -41,7 +44,12 @@ export class AdvancedSettingsPlugin
         const { mountManagementSection } = await import(
           './management_app/mount_management_section'
         );
-        return mountManagementSection(core.getStartServices, params, component.start);
+        return mountManagementSection(
+          core.getStartServices,
+          params,
+          component.start,
+          usageCollection
+        );
       },
     });
 

diff --git a/src/plugins/advanced_settings/public/types.ts b/src/plugins/advanced_settings/public/types.ts
@@ -21,6 +21,7 @@ import { ComponentRegistry } from './component_registry';
 import { HomePublicPluginSetup } from '../../home/public';
 
 import { ManagementSetup } from '../../management/public';
+import { UsageCollectionSetup } from '../../usage_collection/public';
 
 export interface AdvancedSettingsSetup {
   component: ComponentRegistry['setup'];
@@ -32,6 +33,7 @@ export interface AdvancedSettingsStart {
 export interface AdvancedSettingsPluginSetup {
   management: ManagementSetup;
   home?: HomePublicPluginSetup;
+  usageCollection?: UsageCollectionSetup;
 }
 
 export { ComponentRegistry };
diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md
@@ -60,6 +60,7 @@ import { ShardsResponse } from 'elasticsearch';
 import { ToastInputFields } from 'src/core/public/notifications';
 import { Type } from '@kbn/config-schema';
 import { TypeOf } from '@kbn/config-schema';
+import { UiStatsMetricType } from '@kbn/analytics';
 import { Unit } from '@elastic/datemath';
 
 // Warning: (ae-forgotten-export) The symbol "AggConfigSerialized" needs to be exported by the entry point index.d.ts

diff --git a/src/plugins/discover/server/ui_settings.ts b/src/plugins/discover/server/ui_settings.ts
@@ -21,6 +21,7 @@ import { i18n } from '@kbn/i18n';
 import { schema } from '@kbn/config-schema';
 
 import { UiSettingsParams } from 'kibana/server';
+import { METRIC_TYPE } from '@kbn/analytics';
 import {
   DEFAULT_COLUMNS_SETTING,
   SAMPLE_SIZE_SETTING,
@@ -170,9 +171,13 @@ export const uiSettings: Record<string, UiSettingsParams> = {
     }),
     value: true,
     description: i18n.translate('discover.advancedSettings.discover.modifyColumnsOnSwitchText', {
-      defaultMessage: 'Remove columns that not available in the new index pattern.',
+      defaultMessage: 'Remove columns that are not available in the new index pattern.',
     }),
     category: ['discover'],
     schema: schema.boolean(),
+    metric: {
+      type: METRIC_TYPE.CLICK,
+      name: 'discover:modifyColumnsOnSwitchTitle',
+    },
   },
 };