[Telemetry] Report the Application Usage (time of usage + number of clicks)

src/legacy/core_plugins/application_usage/index.ts

@@ -0,0 +1,31 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Legacy } from '../../../../kibana';
+import { mappings } from './mappings';
+
+// eslint-disable-next-line import/no-default-export
+export default function ApplicationUsagePlugin(kibana: any) {
+  const config: Legacy.PluginSpecOptions = {
+    id: 'application_usage',
+    uiExports: { mappings }, // Needed to define the mappings for the SavedObjects
+  };
+
+  return new kibana.Plugin(config);
+}

src/legacy/core_plugins/application_usage/mappings.ts

@@ -0,0 +1,28 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export const mappings = {
+  application_usage: {
+    properties: {
+      appId: { type: 'keyword' },
+      numberOfClicks: { type: 'long' },
+      minutesOnScreen: { type: 'float' },
+    },
+  },
+};

src/legacy/core_plugins/application_usage/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "application_usage",
+  "version": "kibana"
+}

src/legacy/ui/public/chrome/api/sub_url_hooks.js

@@ -21,6 +21,7 @@ import url from 'url';
 
 import { unhashUrl } from '../../../../../plugins/kibana_utils/public';
 import { toastNotifications } from '../../notify/toasts';
+import { npStart } from '../../new_platform';
 
 export function registerSubUrlHooks(angularModule, internals) {
   angularModule.run(($rootScope, Private, $location) => {
@@ -40,6 +41,7 @@ export function registerSubUrlHooks(angularModule, internals) {
 
     function onRouteChange($event) {
       if (subUrlRouteFilter($event)) {
+        updateUsage($event);
         updateSubUrls();
       }
     }
@@ -67,6 +69,13 @@ export function registerSubUrlHooks(angularModule, internals) {
   });
 }
 
+function updateUsage($event) {
+  const scope = $event.targetScope;
+  const app = scope.chrome.getApp();
+  const appId = app.id === 'kibana' ? scope.getFirstPathSegment() : app.id;
+  if (npStart.plugins.applicationUsage) npStart.plugins.applicationUsage.__LEGACY.appChanged(appId);
+}
+
 /**
  *  Creates a function that will be called on each route change
  *  to determine if the event should be used to update the last

src/legacy/ui/public/new_platform/new_platform.ts

@@ -20,6 +20,7 @@ import { IScope } from 'angular';
 
 import { UiActionsStart, UiActionsSetup } from 'src/plugins/ui_actions/public';
 import { IEmbeddableStart, IEmbeddableSetup } from 'src/plugins/embeddable/public';
+import { ApplicationUsagePluginStart } from 'src/plugins/application_usage/public';
 import { LegacyCoreSetup, LegacyCoreStart, App, AppMountDeprecated } from '../../../../core/public';
 import { Plugin as DataPlugin } from '../../../../plugins/data/public';
 import { Plugin as ExpressionsPlugin } from '../../../../plugins/expressions/public';
@@ -82,6 +83,7 @@ export interface PluginsStart {
   management: ManagementStart;
   advancedSettings: AdvancedSettingsStart;
   telemetry?: TelemetryPluginStart;
+  applicationUsage?: ApplicationUsagePluginStart;
 }
 
 export const npSetup = {

src/plugins/application_usage/kibana.json

@@ -0,0 +1,9 @@
+{
+  "id": "applicationUsage",
+  "version": "kibana",
+  "server": true,
+  "ui": true,
+  "optionalPlugins": [
+    "usageCollection"
+  ]
+}

src/plugins/application_usage/public/constants.ts

@@ -0,0 +1,34 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*
+ * Key for the localStorage service
+ */
+export const LOCALSTORAGE_KEY = 'application_usage.aggregated';
+export const LOCALSTORAGE_KEY_LAST_REPORTED = 'application_usage.lastReported';
+
+/**
+ * List of appIds not to report usage from (due to legacy hacks)
+ */
+export const DO_NOT_REPORT = ['kibana'];
+
+/**
+ * Report to server every 10 minutes
+ */
+export const REPORT_INTERVAL = 10 * 60 * 1000;