[7.x] [Usage Collection] Supports field descriptions as meta data (#9…

…2701) (#93295) * [Usage Collection] Supports field descriptions as meta data (#92701) Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # src/plugins/kibana_usage_collection/server/collectors/management/schema.ts * Updates schema
elastic · Mar 2, 2021 · 765b083 · 765b083
1 parent 04cb7d9
commit 765b083
Show file tree

Hide file tree

Showing 23 changed files with 7,067 additions and 1,640 deletions.
diff --git a/packages/kbn-telemetry-tools/src/tools/__fixture__/all_extracted_collectors.ts b/packages/kbn-telemetry-tools/src/tools/__fixture__/all_extracted_collectors.ts
@@ -13,6 +13,7 @@ import { parsedIndexedInterfaceWithNoMatchingSchema } from './parsed_indexed_int
 import { parsedNestedCollector } from './parsed_nested_collector';
 import { parsedSchemaDefinedWithSpreadsCollector } from './parsed_schema_defined_with_spreads_collector';
 import { parsedWorkingCollector } from './parsed_working_collector';
+import { parsedCollectorWithDescription } from './parsed_working_collector_with_description';
 import { ParsedUsageCollection } from '../ts_parser';
 
 export const allExtractedCollectors: ParsedUsageCollection[] = [
@@ -22,5 +23,6 @@ export const allExtractedCollectors: ParsedUsageCollection[] = [
   parsedIndexedInterfaceWithNoMatchingSchema,
   parsedNestedCollector,
   parsedSchemaDefinedWithSpreadsCollector,
+  parsedCollectorWithDescription,
   parsedWorkingCollector,
 ];
diff --git a/packages/kbn-telemetry-tools/src/tools/__fixture__/mock_schema_with_descriptions.json b/packages/kbn-telemetry-tools/src/tools/__fixture__/mock_schema_with_descriptions.json
@@ -0,0 +1,57 @@
+{
+  "properties": {
+    "my_working_collector_with_description": {
+      "properties": {
+        "flat": {
+          "type": "keyword",
+          "_meta": {
+            "description": "A flat keyword string"
+          }
+        },
+        "my_index_signature_prop": {
+          "properties": {
+            "avg": {
+              "type": "float"
+            },
+            "count": {
+              "type": "long"
+            },
+            "max": {
+              "type": "long"
+            },
+            "min": {
+              "type": "long"
+            }
+          }
+        },
+        "my_str": {
+          "type": "text"
+        },
+        "my_objects": {
+          "properties": {
+            "total": {
+              "type": "long"
+            },
+            "type": {
+              "type": "boolean"
+            }
+          }
+        },
+        "my_array": {
+          "type": "array",
+          "items": {
+            "properties": {
+              "total": {
+                "type": "long"
+              },
+              "type": {
+                "type": "boolean"
+              }
+            }
+          }
+        },
+        "my_str_array": { "type": "array", "items": { "type": "keyword" } }
+      }
+    }
+  }
+}
diff --git a/...es/kbn-telemetry-tools/src/tools/__fixture__/parsed_working_collector_with_description.ts b/...es/kbn-telemetry-tools/src/tools/__fixture__/parsed_working_collector_with_description.ts
@@ -0,0 +1,109 @@
+/*
+ * 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 { SyntaxKind } from 'typescript';
+import { ParsedUsageCollection } from '../ts_parser';
+
+export const parsedCollectorWithDescription: ParsedUsageCollection = [
+  'src/fixtures/telemetry_collectors/working_collector_with_description.ts',
+  {
+    collectorName: 'my_working_collector_with_description',
+    schema: {
+      value: {
+        flat: {
+          type: 'keyword',
+          _meta: {
+            description: 'A flat keyword string',
+          },
+        },
+        my_str: {
+          type: 'text',
+        },
+        my_index_signature_prop: {
+          avg: {
+            type: 'float',
+          },
+          count: {
+            type: 'long',
+          },
+          max: {
+            type: 'long',
+          },
+          min: {
+            type: 'long',
+          },
+        },
+        my_objects: {
+          total: {
+            type: 'long',
+          },
+          type: {
+            type: 'boolean',
+          },
+        },
+        my_array: {
+          type: 'array',
+          items: {
+            total: {
+              type: 'long',
+            },
+            type: { type: 'boolean' },
+          },
+        },
+        my_str_array: { type: 'array', items: { type: 'keyword' } },
+      },
+    },
+    fetch: {
+      typeName: 'Usage',
+      typeDescriptor: {
+        flat: {
+          kind: SyntaxKind.StringKeyword,
+          type: 'StringKeyword',
+        },
+        my_str: {
+          kind: SyntaxKind.StringKeyword,
+          type: 'StringKeyword',
+        },
+        my_index_signature_prop: {
+          '@@INDEX@@': {
+            kind: SyntaxKind.NumberKeyword,
+            type: 'NumberKeyword',
+          },
+        },
+        my_objects: {
+          total: {
+            kind: SyntaxKind.NumberKeyword,
+            type: 'NumberKeyword',
+          },
+          type: {
+            kind: SyntaxKind.BooleanKeyword,
+            type: 'BooleanKeyword',
+          },
+        },
+        my_array: {
+          items: {
+            total: {
+              kind: SyntaxKind.NumberKeyword,
+              type: 'NumberKeyword',
+            },
+            type: {
+              kind: SyntaxKind.BooleanKeyword,
+              type: 'BooleanKeyword',
+            },
+          },
+        },
+        my_str_array: {
+          items: {
+            kind: SyntaxKind.StringKeyword,
+            type: 'StringKeyword',
+          },
+        },
+      },
+    },
+  },
+];
diff --git a/packages/kbn-telemetry-tools/src/tools/extract_collectors.test.ts b/packages/kbn-telemetry-tools/src/tools/extract_collectors.test.ts
@@ -24,7 +24,7 @@ describe('extractCollectors', () => {
     const programPaths = await getProgramPaths(configs[0]);
 
     const results = [...extractCollectors(programPaths, tsConfig)];
-    expect(results).toHaveLength(8);
+    expect(results).toHaveLength(9);
     expect(results).toStrictEqual(allExtractedCollectors);
   });
 });
diff --git a/packages/kbn-telemetry-tools/src/tools/manage_schema.test.ts b/packages/kbn-telemetry-tools/src/tools/manage_schema.test.ts
@@ -8,6 +8,7 @@
 
 import { generateMapping } from './manage_schema';
 import { parsedWorkingCollector } from './__fixture__/parsed_working_collector';
+import { parsedCollectorWithDescription } from './__fixture__/parsed_working_collector_with_description';
 import * as path from 'path';
 import { readFile } from 'fs';
 import { promisify } from 'util';
@@ -25,4 +26,9 @@ describe('generateMapping', () => {
     const result = generateMapping([parsedWorkingCollector]);
     expect(result).toEqual(mockSchema);
   });
+  it('generates a mapping file that includes _meta.description fields', async () => {
+    const mockSchema = await parseJsonFile('mock_schema_with_descriptions.json');
+    const result = generateMapping([parsedCollectorWithDescription]);
+    expect(result).toEqual(mockSchema);
+  });
 });
diff --git a/src/fixtures/telemetry_collectors/working_collector_with_description.ts b/src/fixtures/telemetry_collectors/working_collector_with_description.ts
@@ -0,0 +1,102 @@
+/*
+ * 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 { CollectorSet } from '../../plugins/usage_collection/server/collector';
+import { loggerMock } from '../../core/server/logging/logger.mock';
+
+const { makeUsageCollector } = new CollectorSet({
+  logger: loggerMock.create(),
+  maximumWaitTimeForAllCollectorsInS: 0,
+});
+
+interface MyObject {
+  total: number;
+  type: boolean;
+}
+
+interface Usage {
+  flat?: string;
+  my_str?: string;
+  my_objects: MyObject;
+  my_array?: MyObject[];
+  my_str_array?: string[];
+  my_index_signature_prop?: {
+    [key: string]: number;
+  };
+}
+
+const SOME_NUMBER: number = 123;
+
+export const myCollector = makeUsageCollector<Usage>({
+  type: 'my_working_collector_with_description',
+  isReady: () => true,
+  fetch() {
+    const testString = '123';
+    // query ES and get some data
+
+    // summarize the data into a model
+    // return the modeled object that includes whatever you want to track
+    try {
+      return {
+        flat: 'hello',
+        my_str: testString,
+        my_objects: {
+          total: SOME_NUMBER,
+          type: true,
+        },
+        my_array: [
+          {
+            total: SOME_NUMBER,
+            type: true,
+          },
+        ],
+        my_str_array: ['hello', 'world'],
+      };
+    } catch (err) {
+      return {
+        my_objects: {
+          total: 0,
+          type: true,
+        },
+      };
+    }
+  },
+  schema: {
+    flat: {
+      type: 'keyword',
+      _meta: {
+        description: 'A flat keyword string',
+      },
+    },
+    my_str: {
+      type: 'text',
+    },
+    my_objects: {
+      total: {
+        type: 'long',
+      },
+      type: { type: 'boolean' },
+    },
+    my_array: {
+      type: 'array',
+      items: {
+        total: {
+          type: 'long',
+        },
+        type: { type: 'boolean' },
+      },
+    },
+    my_str_array: { type: 'array', items: { type: 'keyword' } },
+    my_index_signature_prop: {
+      count: { type: 'long' },
+      avg: { type: 'float' },
+      max: { type: 'long' },
+      min: { type: 'long' },
+    },
+  },
+});
diff --git a/src/plugins/kibana_usage_collection/README.md b/src/plugins/kibana_usage_collection/README.md
@@ -3,9 +3,16 @@
 This plugin registers the basic usage collectors from Kibana:
 
 - [Application Usage](./server/collectors/application_usage/README.md)
-- UI Metrics
-- Ops stats
-- Number of Saved Objects per type
-- [User-changed UI Settings](./server/collectors/management/README.md)
-- CSP configuration
 - Core Metrics
+- CSP configuration
+- Kibana: Number of Saved Objects per type
+- Localization data
+- [User-changed UI Settings](./server/collectors/management/README.md)
+- Ops stats
+- UI Counts
+- UI Metrics
+
+
+
+
+
diff --git a/src/plugins/kibana_usage_collection/server/collectors/application_usage/README.md b/src/plugins/kibana_usage_collection/server/collectors/application_usage/README.md
@@ -10,7 +10,7 @@ To track a sub view inside your application (ie a flyout, a tab, form step, etc)
 
 #### For a React Component
 
-For tracking an application view rendered using react the simplest way is to wrap your component with the `TrackApplicationView` Higher order component:
+For tracking an application view rendered using react the simplest way is to wrap your component with the `TrackApplicationView` Higher order component exposed from the `usageCollection` plugin. You will need to add the plugin to plugin's `kibana.json` file as an item in the `optionalPlugins` and `requiredBundles` declarations:
 
 kibana.json
 ```json
@@ -26,6 +26,7 @@ kibana.json
 
 At the application level, the application must be wrapped by the `ApplicationUsageTrackingProvider` provided in the `usageCollection`'s setup contract.
 
+For example:
 ```typescript jsx
 class MyPlugin implements Plugin {
   ...
@@ -69,7 +70,6 @@ const MyTrackedComponent = () => {
 Application Usage will automatically track the active minutes on screen and clicks for both the application and the `MyComponent` component whenever it is mounted on the screen. Application Usage pauses counting screen minutes whenever the user is tabbed to another browser window.
 
 The prop `viewId` is used as a unique identifier for your plugin. The Application Id is automatically attached to the tracked usage, based on the ID used when registering your app via `core.application.register`.
-
 ## Application Usage Telemetry Data
 
 This collector reports the number of general clicks and minutes on screen for each registered application in Kibana.
@@ -126,4 +126,4 @@ In order to keep the count of the events, this collector uses 3 Saved Objects:
 
 All the types use the shared fields `appId: 'keyword'`, `viewId: 'keyword'`, `numberOfClicks: 'long'` and `minutesOnScreen: 'float'`, but they are currently not added in the mappings because we don't use them for search purposes, and we need to be thoughtful with the number of mapped fields in the SavedObjects index ([#43673](https://github.com/elastic/kibana/issues/43673)). `application_usage_transactional` and `application_usage_daily` also store `timestamp: { type: 'date' }`.
 
-Rollups uses `appId` in the savedObject id for the default view. For other views `viewId` is concatenated. This keeps backwards compatiblity with previously stored documents on the clusters without requiring any form of migration.
+Rollups uses `appId` in the savedObject id for the default view. For other views `viewId` is concatenated. This keeps backwards compatiblity with previously stored documents on the clusters without requiring any form of migration.