[Usage collection] Usage counters (#96696)

Co-authored-by: Alejandro Fernández Haro <[email protected]>

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsserviceprovider.start.md

@@ -8,7 +8,7 @@
 
 ```typescript
 start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps): {
-        indexPatternsServiceFactory: (savedObjectsClient: Pick<import("../../../../core/server").SavedObjectsClient, "get" | "delete" | "create" | "bulkCreate" | "checkConflicts" | "find" | "bulkGet" | "resolve" | "update" | "addToNamespaces" | "deleteFromNamespaces" | "bulkUpdate" | "removeReferencesTo" | "openPointInTimeForType" | "closePointInTime" | "createPointInTimeFinder" | "errors">, elasticsearchClient: ElasticsearchClient) => Promise<IndexPatternsCommonService>;
+        indexPatternsServiceFactory: (savedObjectsClient: Pick<import("../../../../core/server").SavedObjectsClient, "update" | "get" | "delete" | "create" | "bulkCreate" | "checkConflicts" | "find" | "bulkGet" | "resolve" | "addToNamespaces" | "deleteFromNamespaces" | "bulkUpdate" | "removeReferencesTo" | "openPointInTimeForType" | "closePointInTime" | "createPointInTimeFinder" | "errors">, elasticsearchClient: ElasticsearchClient) => Promise<IndexPatternsCommonService>;
     };
 ```
 
@@ -22,6 +22,6 @@ start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps):
 <b>Returns:</b>
 
 `{
-        indexPatternsServiceFactory: (savedObjectsClient: Pick<import("../../../../core/server").SavedObjectsClient, "get" | "delete" | "create" | "bulkCreate" | "checkConflicts" | "find" | "bulkGet" | "resolve" | "update" | "addToNamespaces" | "deleteFromNamespaces" | "bulkUpdate" | "removeReferencesTo" | "openPointInTimeForType" | "closePointInTime" | "createPointInTimeFinder" | "errors">, elasticsearchClient: ElasticsearchClient) => Promise<IndexPatternsCommonService>;
+        indexPatternsServiceFactory: (savedObjectsClient: Pick<import("../../../../core/server").SavedObjectsClient, "update" | "get" | "delete" | "create" | "bulkCreate" | "checkConflicts" | "find" | "bulkGet" | "resolve" | "addToNamespaces" | "deleteFromNamespaces" | "bulkUpdate" | "removeReferencesTo" | "openPointInTimeForType" | "closePointInTime" | "createPointInTimeFinder" | "errors">, elasticsearchClient: ElasticsearchClient) => Promise<IndexPatternsCommonService>;
     }`
 

src/plugins/data/server/server.api.md

@@ -56,6 +56,7 @@ import { PublicMethodsOf } from '@kbn/utility-types';
 import { RecursiveReadonly } from '@kbn/utility-types';
 import { RequestAdapter } from 'src/plugins/inspector/common';
 import { RequestHandlerContext } from 'src/core/server';
+import * as Rx from 'rxjs';
 import { SavedObject } from 'kibana/server';
 import { SavedObject as SavedObject_2 } from 'src/core/server';
 import { SavedObjectsClientContract } from 'src/core/server';

src/plugins/kibana_usage_collection/server/collectors/application_usage/telemetry_application_usage_collector.test.ts

@@ -10,7 +10,7 @@ import { savedObjectsRepositoryMock, loggingSystemMock } from '../../../../../co
 import {
   Collector,
   createUsageCollectionSetupMock,
-} from '../../../../usage_collection/server/usage_collection.mock';
+} from '../../../../usage_collection/server/mocks';
 import { MAIN_APP_DEFAULT_VIEW_ID } from '../../../../usage_collection/common/constants';
 import { createCollectorFetchContextMock } from 'src/plugins/usage_collection/server/mocks';
 import {

src/plugins/kibana_usage_collection/server/collectors/cloud/cloud_provider_collector.test.ts

@@ -12,25 +12,23 @@ import {
   Collector,
   createUsageCollectionSetupMock,
   createCollectorFetchContextMock,
-} from '../../../../usage_collection/server/usage_collection.mock';
+} from '../../../../usage_collection/server/mocks';
 
 import { registerCloudProviderUsageCollector } from './cloud_provider_collector';
 
 describe('registerCloudProviderUsageCollector', () => {
   let collector: Collector<unknown>;
   const logger = loggingSystemMock.createLogger();
-
-  const usageCollectionMock = createUsageCollectionSetupMock();
-  usageCollectionMock.makeUsageCollector.mockImplementation((config) => {
-    collector = new Collector(logger, config);
-    return createUsageCollectionSetupMock().makeUsageCollector(config);
-  });
-
   const mockedFetchContext = createCollectorFetchContextMock();
 
   beforeEach(() => {
     cloudDetailsMock.mockClear();
     detectCloudServiceMock.mockClear();
+    const usageCollectionMock = createUsageCollectionSetupMock();
+    usageCollectionMock.makeUsageCollector.mockImplementation((config) => {
+      collector = new Collector(logger, config);
+      return createUsageCollectionSetupMock().makeUsageCollector(config);
+    });
     registerCloudProviderUsageCollector(usageCollectionMock);
   });
 

src/plugins/kibana_usage_collection/server/collectors/core/index.test.ts

@@ -9,7 +9,7 @@
 import {
   Collector,
   createUsageCollectionSetupMock,
-} from '../../../../usage_collection/server/usage_collection.mock';
+} from '../../../../usage_collection/server/mocks';
 import { createCollectorFetchContextMock } from 'src/plugins/usage_collection/server/mocks';
 import { registerCoreUsageCollector } from '.';
 import { coreUsageDataServiceMock, loggingSystemMock } from '../../../../../core/server/mocks';

src/plugins/kibana_usage_collection/server/collectors/index.ts

@@ -20,3 +20,7 @@ export {
   registerUiCounterSavedObjectType,
   registerUiCountersRollups,
 } from './ui_counters';
+export {
+  registerUsageCountersRollups,
+  registerUsageCountersUsageCollector,
+} from './usage_counters';

src/plugins/kibana_usage_collection/server/collectors/kibana/index.test.ts

@@ -15,7 +15,7 @@ import {
   Collector,
   createCollectorFetchContextMock,
   createUsageCollectionSetupMock,
-} from '../../../../usage_collection/server/usage_collection.mock';
+} from '../../../../usage_collection/server/mocks';
 import { registerKibanaUsageCollector } from './';
 
 const logger = loggingSystemMock.createLogger();

src/plugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.test.ts

@@ -11,7 +11,7 @@ import {
   Collector,
   createUsageCollectionSetupMock,
   createCollectorFetchContextMock,
-} from '../../../../usage_collection/server/usage_collection.mock';
+} from '../../../../usage_collection/server/mocks';
 
 import {
   registerManagementUsageCollector,

src/plugins/kibana_usage_collection/server/collectors/ops_stats/index.test.ts

@@ -11,7 +11,7 @@ import {
   Collector,
   createUsageCollectionSetupMock,
   createCollectorFetchContextMock,
-} from '../../../../usage_collection/server/usage_collection.mock';
+} from '../../../../usage_collection/server/mocks';
 
 import { registerOpsStatsCollector } from './';
 import { OpsMetrics } from '../../../../../core/server';

src/plugins/kibana_usage_collection/server/collectors/ui_counters/__fixtures__/ui_counter_saved_objects.ts

@@ -0,0 +1,51 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { UICounterSavedObject } from '../ui_counter_saved_object_type';
+export const rawUiCounters: UICounterSavedObject[] = [
+  {
+    type: 'ui-counter',
+    id: 'Kibana_home:23102020:click:different_type',
+    attributes: {
+      count: 1,
+    },
+    references: [],
+    updated_at: '2020-11-24T11:27:57.067Z',
+    version: 'WzI5NDRd',
+  },
+  {
+    type: 'ui-counter',
+    id: 'Kibana_home:25102020:loaded:intersecting_event',
+    attributes: {
+      count: 1,
+    },
+    references: [],
+    updated_at: '2020-10-25T11:27:57.067Z',
+    version: 'WzI5NDRd',
+  },
+  {
+    type: 'ui-counter',
+    id: 'Kibana_home:23102020:loaded:intersecting_event',
+    attributes: {
+      count: 3,
+    },
+    references: [],
+    updated_at: '2020-10-23T11:27:57.067Z',
+    version: 'WzI5NDRd',
+  },
+  {
+    type: 'ui-counter',
+    id: 'Kibana_home:24112020:click:only_reported_in_ui_counters',
+    attributes: {
+      count: 1,
+    },
+    references: [],
+    updated_at: '2020-11-24T11:27:57.067Z',
+    version: 'WzI5NDRd',
+  },
+];

src/plugins/kibana_usage_collection/server/collectors/ui_counters/__fixtures__/usage_counter_saved_objects.ts

@@ -0,0 +1,104 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { UsageCountersSavedObject } from '../../../../../usage_collection/server';
+
+export const rawUsageCounters: UsageCountersSavedObject[] = [
+  {
+    type: 'usage-counters',
+    id: 'uiCounter:09042021:count:myApp:my_event',
+    attributes: {
+      count: 1,
+      counterName: 'myApp:my_event',
+      counterType: 'count',
+      domainId: 'uiCounter',
+    },
+    references: [],
+    coreMigrationVersion: '8.0.0',
+    updated_at: '2021-04-09T08:17:57.693Z',
+  },
+  {
+    type: 'usage-counters',
+    id: 'uiCounter:23102020:loaded:Kibana_home:intersecting_event',
+    attributes: {
+      count: 60,
+      counterName: 'Kibana_home:intersecting_event',
+      counterType: 'loaded',
+      domainId: 'uiCounter',
+    },
+    references: [],
+    coreMigrationVersion: '8.0.0',
+    updated_at: '2020-10-23T11:27:57.067Z',
+  },
+  {
+    type: 'usage-counters',
+    id: 'uiCounter:09042021:count:myApp:my_event_4457914848544',
+    attributes: {
+      count: 0,
+      counterName: 'myApp:my_event_4457914848544',
+      counterType: 'count',
+      domainId: 'uiCounter',
+    },
+    references: [],
+    coreMigrationVersion: '8.0.0',
+    updated_at: '2021-04-09T08:18:03.030Z',
+  },
+  {
+    type: 'usage-counters',
+    id: 'uiCounter:09042021:count:myApp:my_event_malformed',
+    attributes: {
+      // @ts-expect-error
+      count: 'malformed',
+      counterName: 'myApp:my_event_malformed',
+      counterType: 'count',
+      domainId: 'uiCounter',
+    },
+    references: [],
+    coreMigrationVersion: '8.0.0',
+    updated_at: '2021-04-09T08:18:03.030Z',
+  },
+  {
+    type: 'usage-counters',
+    id: 'anotherDomainId:09042021:count:some_event_name',
+    attributes: {
+      count: 4,
+      counterName: 'some_event_name',
+      counterType: 'count',
+      domainId: 'anotherDomainId',
+    },
+    references: [],
+    coreMigrationVersion: '8.0.0',
+    updated_at: '2021-04-09T08:18:03.030Z',
+  },
+  {
+    type: 'usage-counters',
+    id: 'uiCounter:09042021:count:myApp:my_event_4457914848544_2',
+    attributes: {
+      count: 8,
+      counterName: 'myApp:my_event_4457914848544_2',
+      counterType: 'count',
+      domainId: 'uiCounter',
+    },
+    references: [],
+    coreMigrationVersion: '8.0.0',
+    updated_at: '2021-04-09T08:18:03.031Z',
+  },
+  {
+    type: 'usage-counters',
+    id: 'uiCounter:09042021:count:myApp:only_reported_in_usage_counters',
+    attributes: {
+      count: 1,
+      counterName: 'myApp:only_reported_in_usage_counters',
+      counterType: 'count',
+      domainId: 'uiCounter',
+    },
+    references: [],
+    coreMigrationVersion: '8.0.0',
+    updated_at: '2021-04-09T08:18:03.031Z',
+  },
+];