[data views] add usage counters to data views REST api endpoints

src/plugins/data_views/common/constants.ts

@@ -40,3 +40,5 @@ export const DATA_VIEW_SAVED_OBJECT_TYPE = 'index-pattern';
  */
 
 export const INDEX_PATTERN_SAVED_OBJECT_TYPE = DATA_VIEW_SAVED_OBJECT_TYPE;
+
+export const PLUGIN_NAME = 'DataViews';

src/plugins/data_views/server/constants.ts

@@ -25,3 +25,5 @@ export const SPECIFIC_SCRIPTED_FIELD_PATH_LEGACY = `${SCRIPTED_FIELD_PATH_LEGACY
 export const SERVICE_KEY = 'data_view';
 export const SERVICE_KEY_LEGACY = 'index_pattern';
 export type SERVICE_KEY_TYPE = typeof SERVICE_KEY | typeof SERVICE_KEY_LEGACY;
+
+export const CREATE_DATA_VIEW_COUNTER_NAME = `POST ${DATA_VIEW_PATH}`;

src/plugins/data_views/server/mocks.ts

@@ -6,10 +6,27 @@
  * Side Public License, v 1.
  */
 
+import { DataViewsService } from 'src/plugins/data_views/common';
+
 export function createIndexPatternsStartMock() {
   const dataViewsServiceFactory = jest.fn().mockResolvedValue({ get: jest.fn() });
   return {
     indexPatternsServiceFactory: dataViewsServiceFactory,
     dataViewsServiceFactory,
   };
 }
+
+export const dataViewsService = {
+  find: jest.fn((search) => [{ id: search, title: search }]),
+  ensureDefaultIndexPattern: jest.fn(),
+  ensureDefaultDataView: jest.fn().mockReturnValue(Promise.resolve({})),
+  get: jest.fn().mockReturnValue(Promise.resolve({})),
+  clearCache: jest.fn(),
+  createAndSave: jest.fn(),
+  setDefault: jest.fn(),
+  delete: jest.fn(),
+  hasUserDataView: jest.fn(),
+  getDefaultId: jest.fn(),
+  updateSavedObject: jest.fn(),
+  refreshFields: jest.fn(),
+} as unknown as jest.Mocked<DataViewsService>;

src/plugins/data_views/server/plugin.ts

@@ -42,8 +42,9 @@ export class DataViewsServerPlugin
   ) {
     core.savedObjects.registerType(dataViewSavedObjectType);
     core.capabilities.registerProvider(capabilitiesProvider);
+    const dataViewRestCounter = usageCollection?.createUsageCounter('dataViewsRestApi');
 
-    registerRoutes(core.http, core.getStartServices);
+    registerRoutes(core.http, core.getStartServices, dataViewRestCounter);
 
     expressions.registerFunction(getIndexPatternLoad({ getStartServices: core.getStartServices }));
     registerIndexPatternsUsageCollector(core.getStartServices, usageCollection);

src/plugins/data_views/server/rest_api_routes/create_data_view.test.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 { createDataView } from './create_data_view';
+import { dataViewsService } from '../mocks';
+import { getUsageCollection } from './test_utils';
+
+describe('create data view', () => {
+  it('call usageCollection', () => {
+    const usageCollection = getUsageCollection();
+    createDataView({
+      dataViewsService,
+      spec: {},
+      counterName: 'POST /path',
+      usageCollection,
+    });
+    expect(usageCollection.incrementCounter).toBeCalledTimes(1);
+  });
+});

src/plugins/data_views/server/routes/create_index_pattern.ts → src/plugins/data_views/server/rest_api_routes/create_data_view.ts

@@ -6,8 +6,9 @@
  * Side Public License, v 1.
  */
 
+import { UsageCounter } from 'src/plugins/usage_collection/server';
 import { schema } from '@kbn/config-schema';
-import { DataViewSpec } from 'src/plugins/data_views/common';
+import { DataViewSpec, DataViewsService } from 'src/plugins/data_views/common';
 import { handleErrors } from './util/handle_errors';
 import {
   fieldSpecSchema,
@@ -23,6 +24,27 @@ import {
   SERVICE_KEY_LEGACY,
 } from '../constants';
 
+interface CreateDataViewArgs {
+  dataViewsService: DataViewsService;
+  usageCollection?: UsageCounter;
+  spec: DataViewSpec;
+  override?: boolean;
+  refreshFields?: boolean;
+  counterName: string;
+}
+
+export const createDataView = async ({
+  dataViewsService,
+  usageCollection,
+  spec,
+  override,
+  refreshFields,
+  counterName,
+}: CreateDataViewArgs) => {
+  usageCollection?.incrementCounter({ counterName });
+  return dataViewsService.createAndSave(spec, override, !refreshFields);
+};
+
 const indexPatternSpecSchema = schema.object({
   title: schema.string(),
   version: schema.maybe(schema.string()),
@@ -59,7 +81,8 @@ const registerCreateDataViewRouteFactory =
     getStartServices: StartServicesAccessor<
       DataViewsServerPluginStartDependencies,
       DataViewsServerPluginStart
-    >
+    >,
+    usageCollection?: UsageCounter
   ) => {
     router.post(
       {
@@ -79,7 +102,8 @@ const registerCreateDataViewRouteFactory =
           const savedObjectsClient = ctx.core.savedObjects.client;
           const elasticsearchClient = ctx.core.elasticsearch.client.asCurrentUser;
           const [, , { dataViewsServiceFactory }] = await getStartServices();
-          const indexPatternsService = await dataViewsServiceFactory(
+
+          const dataViewsService = await dataViewsServiceFactory(
             savedObjectsClient,
             elasticsearchClient,
             req
@@ -88,19 +112,22 @@ const registerCreateDataViewRouteFactory =
 
           const spec = serviceKey === SERVICE_KEY ? body.data_view : body.index_pattern;
 
-          const indexPattern = await indexPatternsService.createAndSave(
-            spec as DataViewSpec,
-            body.override,
-            !body.refresh_fields
-          );
+          const dataView = await createDataView({
+            dataViewsService,
+            usageCollection,
+            spec: spec as DataViewSpec,
+            override: body.override,
+            refreshFields: body.refresh_fields,
+            counterName: `${req.route.method} ${path}`,
+          });
 
           return res.ok({
             headers: {
               'content-type': 'application/json',
             },
-            body: JSON.stringify({
-              [serviceKey]: indexPattern.toSpec(),
-            }),
+            body: {
+              [serviceKey]: dataView.toSpec(),
+            },
           });
         })
       )

src/plugins/data_views/server/rest_api_routes/default_data_view.test.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { setDefault, getDefault } from './default_data_view';
+import { dataViewsService } from '../mocks';
+import { getUsageCollection } from './test_utils';
+
+describe('default data view', () => {
+  it('set - calls usageCollection', () => {
+    const usageCollection = getUsageCollection();
+    setDefault({
+      dataViewsService,
+      counterName: 'POST /path',
+      usageCollection,
+      newDefaultId: '1',
+      force: false,
+    });
+    expect(usageCollection.incrementCounter).toBeCalledTimes(1);
+  });
+
+  it('get - calls usageCollection', () => {
+    const usageCollection = getUsageCollection();
+    getDefault({
+      dataViewsService,
+      counterName: 'GET /path',
+      usageCollection,
+    });
+    expect(usageCollection.incrementCounter).toBeCalledTimes(1);
+  });
+});

src/plugins/data_views/server/routes/default_index_pattern.ts → src/plugins/data_views/server/rest_api_routes/default_data_view.ts

@@ -6,20 +6,57 @@
  * Side Public License, v 1.
  */
 
+import { UsageCounter } from 'src/plugins/usage_collection/server';
 import { schema } from '@kbn/config-schema';
+import { DataViewsService } from 'src/plugins/data_views/common';
 import { IRouter, StartServicesAccessor } from '../../../../core/server';
 import type { DataViewsServerPluginStartDependencies, DataViewsServerPluginStart } from '../types';
 import { handleErrors } from './util/handle_errors';
 import { SERVICE_PATH, SERVICE_PATH_LEGACY, SERVICE_KEY, SERVICE_KEY_LEGACY } from '../constants';
 
+interface GetDefaultArgs {
+  dataViewsService: DataViewsService;
+  usageCollection?: UsageCounter;
+  counterName: string;
+}
+
+export const getDefault = async ({
+  dataViewsService,
+  usageCollection,
+  counterName,
+}: GetDefaultArgs) => {
+  usageCollection?.incrementCounter({ counterName });
+  return dataViewsService.getDefaultId();
+};
+
+interface SetDefaultArgs {
+  dataViewsService: DataViewsService;
+  usageCollection?: UsageCounter;
+  counterName: string;
+  newDefaultId: string;
+  force: boolean;
+}
+
+export const setDefault = async ({
+  dataViewsService,
+  usageCollection,
+  counterName,
+  newDefaultId,
+  force,
+}: SetDefaultArgs) => {
+  usageCollection?.incrementCounter({ counterName });
+  return dataViewsService.setDefault(newDefaultId, force);
+};
+
 const manageDefaultIndexPatternRoutesFactory =
   (path: string, serviceKey: string) =>
   (
     router: IRouter,
     getStartServices: StartServicesAccessor<
       DataViewsServerPluginStartDependencies,
       DataViewsServerPluginStart
-    >
+    >,
+    usageCollection?: UsageCounter
   ) => {
     router.get(
       {
@@ -30,17 +67,21 @@ const manageDefaultIndexPatternRoutesFactory =
         const savedObjectsClient = ctx.core.savedObjects.client;
         const elasticsearchClient = ctx.core.elasticsearch.client.asCurrentUser;
         const [, , { dataViewsServiceFactory }] = await getStartServices();
-        const indexPatternsService = await dataViewsServiceFactory(
+        const dataViewsService = await dataViewsServiceFactory(
           savedObjectsClient,
           elasticsearchClient,
           req
         );
 
-        const defaultIndexPatternId = await indexPatternsService.getDefaultId();
+        const id = await getDefault({
+          dataViewsService,
+          usageCollection,
+          counterName: `${req.route.method} ${path}`,
+        });
 
         return res.ok({
           body: {
-            [`${serviceKey}_id`]: defaultIndexPatternId,
+            [`${serviceKey}_id`]: id,
           },
         });
       })
@@ -65,7 +106,7 @@ const manageDefaultIndexPatternRoutesFactory =
         const savedObjectsClient = ctx.core.savedObjects.client;
         const elasticsearchClient = ctx.core.elasticsearch.client.asCurrentUser;
         const [, , { dataViewsServiceFactory }] = await getStartServices();
-        const indexPatternsService = await dataViewsServiceFactory(
+        const dataViewsService = await dataViewsServiceFactory(
           savedObjectsClient,
           elasticsearchClient,
           req
@@ -74,7 +115,13 @@ const manageDefaultIndexPatternRoutesFactory =
         const newDefaultId = req.body[`${serviceKey}_id`] as string;
         const force = req.body.force as boolean;
 
-        await indexPatternsService.setDefault(newDefaultId, force);
+        await setDefault({
+          dataViewsService,
+          usageCollection,
+          counterName: `${req.route.method} ${path}`,
+          newDefaultId,
+          force,
+        });
 
         return res.ok({
           body: {

src/plugins/data_views/server/rest_api_routes/delete_data_view.test.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 { deleteDataView } from './delete_data_view';
+import { dataViewsService } from '../mocks';
+import { getUsageCollection } from './test_utils';
+
+describe('delete data view', () => {
+  it('call usageCollection', () => {
+    const usageCollection = getUsageCollection();
+    deleteDataView({
+      dataViewsService,
+      counterName: 'DELETE /path',
+      usageCollection,
+      id: '1',
+    });
+    expect(usageCollection.incrementCounter).toBeCalledTimes(1);
+  });
+});

src/plugins/data_views/server/routes/delete_index_pattern.ts → src/plugins/data_views/server/rest_api_routes/delete_data_view.ts

@@ -6,20 +6,40 @@
  * Side Public License, v 1.
  */
 
+import { UsageCounter } from 'src/plugins/usage_collection/server';
 import { schema } from '@kbn/config-schema';
+import { DataViewsService } from 'src/plugins/data_views/common';
 import { handleErrors } from './util/handle_errors';
 import { IRouter, StartServicesAccessor } from '../../../../core/server';
 import type { DataViewsServerPluginStartDependencies, DataViewsServerPluginStart } from '../types';
 import { SPECIFIC_DATA_VIEW_PATH, SPECIFIC_DATA_VIEW_PATH_LEGACY } from '../constants';
 
+interface DeleteDataViewArgs {
+  dataViewsService: DataViewsService;
+  usageCollection?: UsageCounter;
+  counterName: string;
+  id: string;
+}
+
+export const deleteDataView = async ({
+  dataViewsService,
+  usageCollection,
+  counterName,
+  id,
+}: DeleteDataViewArgs) => {
+  usageCollection?.incrementCounter({ counterName });
+  return dataViewsService.delete(id);
+};
+
 const deleteIndexPatternRouteFactory =
   (path: string) =>
   (
     router: IRouter,
     getStartServices: StartServicesAccessor<
       DataViewsServerPluginStartDependencies,
       DataViewsServerPluginStart
-    >
+    >,
+    usageCollection?: UsageCounter
   ) => {
     router.delete(
       {
@@ -41,14 +61,19 @@ const deleteIndexPatternRouteFactory =
           const savedObjectsClient = ctx.core.savedObjects.client;
           const elasticsearchClient = ctx.core.elasticsearch.client.asCurrentUser;
           const [, , { dataViewsServiceFactory }] = await getStartServices();
-          const indexPatternsService = await dataViewsServiceFactory(
+          const dataViewsService = await dataViewsServiceFactory(
             savedObjectsClient,
             elasticsearchClient,
             req
           );
           const id = req.params.id;
 
-          await indexPatternsService.delete(id);
+          await deleteDataView({
+            dataViewsService,
+            usageCollection,
+            counterName: `${req.route.method} ${path}`,
+            id,
+          });
 
           return res.ok({
             headers: {