[Telemetry] Collector Schema

.telemetryrc.json

@@ -0,0 +1,25 @@
+[
+  {
+    "output": "src/plugins/telemetry/mappings/legacy_oss_plugins.json",
+    "root": "src/legacy/core_plugins/",
+    "exclude": [
+      "src/legacy/core_plugins/testbed",
+      "src/legacy/core_plugins/elasticsearch",
+      "src/legacy/core_plugins/tests_bundle"
+    ]
+  },
+  {
+    "output": "src/plugins/telemetry/mappings/oss_plugins.json",
+    "root": "src/plugins/",
+    "exclude": [
+      "src/plugins/kibana_react/",
+      "src/plugins/testbed/",
+      "src/plugins/kibana_utils/",
+      "src/plugins/kibana_usage_collection/server/collectors/kibana/kibana_usage_collector.ts",
+      "src/plugins/kibana_usage_collection/server/collectors/application_usage/telemetry_application_usage_collector.ts",
+      "src/plugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.ts",
+      "src/plugins/kibana_usage_collection/server/collectors/ui_metric/telemetry_ui_metric_collector.ts",
+      "src/plugins/telemetry/server/collectors/usage/telemetry_usage_collector.ts"
+    ]
+  }
+]

scripts/telemetry_check.js

@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+require('../src/setup_node_env');
+require('../src/dev/run_telemetry_check');

scripts/telemetry_extract.js

@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+require('../src/setup_node_env');
+require('../src/dev/run_telemetry_extract');

src/dev/run_telemetry_check.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 Listr from 'listr';
+import chalk from 'chalk';
+import { createFailError, run } from '@kbn/dev-utils';
+
+import {
+  createTaskContext,
+  ErrorReporter,
+  parseConfigsTask,
+  extractCollectorsTask,
+  checkMatchingMappingTask,
+  generateMappingsTask,
+  checkCompatibleTypesTask,
+  writeToFileTask,
+  TaskContext,
+} from './telemetry/tasks';
+
+run(
+  async ({ flags: { fix = false }, log }) => {
+    if (typeof fix !== 'boolean') {
+      throw createFailError(`${chalk.white.bgRed(' TELEMETRY ERROR ')} --fix can't have a value`);
+    }
+
+    const list = new Listr([
+      {
+        title: 'Checking .telemetryrc.json files',
+        task: () => new Listr(parseConfigsTask(), { exitOnError: true }),
+      },
+      {
+        title: 'Extracting Collectors',
+        task: (context) => new Listr(extractCollectorsTask(context), { exitOnError: true }),
+      },
+      {
+        title: 'Checking Compatible collector.mapping with collector.fetch type',
+        task: (context) => new Listr(checkCompatibleTypesTask(context), { exitOnError: true }),
+      },
+      {
+        title: 'Checking Matching collector.mapping with mapped json file',
+        task: (context) => new Listr(checkMatchingMappingTask(context), { exitOnError: true }),
+      },
+      {
+        skip: ({ roots }: TaskContext) =>
+          !fix && roots.every((root) => !root.esMappingDiffs || !root.esMappingDiffs.length),
+        title: 'Generating new telemetry mappings',
+        task: (context) => new Listr(generateMappingsTask(context), { exitOnError: true }),
+      },
+      {
+        skip: ({ roots }: TaskContext) =>
+          !fix && roots.every((root) => !root.esMappingDiffs || !root.esMappingDiffs.length),
+        title: 'Updating telemetry mapping files',
+        task: (context) => new Listr(writeToFileTask(context), { exitOnError: true }),
+      },
+    ]);
+
+    try {
+      const context = createTaskContext();
+      await list.run(context);
+    } catch (error) {
+      process.exitCode = 1;
+      if (error instanceof ErrorReporter) {
+        error.errors.forEach((e: string | Error) => log.error(e));
+      } else {
+        log.error('Unhandled exception!');
+        log.error(error);
+      }
+    }
+    process.exit();
+  },
+  {
+    flags: {
+      allowUnexpected: true,
+      guessTypesForUnexpectedFlags: true,
+    },
+  }
+);

src/dev/run_telemetry_extract.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 Listr from 'listr';
+import { run } from '@kbn/dev-utils';
+
+import {
+  createTaskContext,
+  ErrorReporter,
+  parseConfigsTask,
+  extractCollectorsTask,
+  generateMappingsTask,
+  writeToFileTask,
+} from './telemetry/tasks';
+
+run(
+  async ({ flags: {}, log }) => {
+    const list = new Listr([
+      {
+        title: 'Parsing .telemetryrc.json files',
+        task: () => new Listr(parseConfigsTask(), { exitOnError: true }),
+      },
+      {
+        title: 'Extracting Telemetry Collectors',
+        task: (context) => new Listr(extractCollectorsTask(context), { exitOnError: true }),
+      },
+      {
+        title: 'Generating Mapping files',
+        task: (context) => new Listr(generateMappingsTask(context), { exitOnError: true }),
+      },
+      {
+        title: 'Writing to file',
+        task: (context) => new Listr(writeToFileTask(context), { exitOnError: true }),
+      },
+    ]);
+
+    try {
+      const context = createTaskContext();
+      await list.run(context);
+    } catch (error) {
+      process.exitCode = 1;
+      if (error instanceof ErrorReporter) {
+        error.errors.forEach((e: string | Error) => log.error(e));
+      } else {
+        log.error('Unhandled exception');
+        log.error(error);
+      }
+    }
+    process.exit();
+  },
+  {
+    flags: {
+      allowUnexpected: true,
+      guessTypesForUnexpectedFlags: true,
+    },
+  }
+);

src/dev/telemetry/__fixture__/.telemetryrc.json

@@ -0,0 +1,7 @@
+{
+  "root": ".",
+  "output": ".",
+  "exclude": [
+    "./unmapped_collector.ts"
+  ]
+}

src/dev/telemetry/__fixture__/constants.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 moment, { Moment } from 'moment';
+
+export interface Usage {
+  locale: string;
+}
+
+export interface WithUnion {
+  prop1: string | null;
+  prop2: string | null | undefined;
+  prop3?: string | null;
+  prop4: 'opt1' | 'opt2';
+  prop5: 123 | 431;
+}
+
+export interface WithMoment {
+  prop1: Moment;
+  prop2: moment.Moment;
+}
+
+export interface WithConflictingUnion {
+  prop1: 123 | 'str';
+}
+
+export interface WithUnsupportedUnion {
+  prop1: 123 | Moment;
+}

src/dev/telemetry/__fixture__/externally_defined_collector.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { CollectorSet, CollectorOptions } from '../../../plugins/usage_collection/server/collector';
+import { loggingServiceMock } from '../../../core/server/mocks';
+
+const collectorSet = new CollectorSet({
+  logger: loggingServiceMock.createLogger(),
+  maximumWaitTimeForAllCollectorsInS: 0,
+});
+
+interface Usage {
+  locale: string;
+}
+
+function createCollector(): CollectorOptions<Usage> {
+  return {
+    type: 'from_fn_collector',
+    isReady: () => true,
+    fetch(): Usage {
+      return {
+        locale: 'en',
+      };
+    },
+    mapping: {
+      locale: {
+        type: 'keyword',
+      },
+    },
+  };
+}
+
+export function defineCollectorFromVariable() {
+  const fromVarCollector: CollectorOptions<Usage> = {
+    type: 'from_variable_collector',
+    isReady: () => true,
+    fetch(): Usage {
+      return {
+        locale: 'en',
+      };
+    },
+    mapping: {
+      locale: {
+        type: 'keyword',
+      },
+    },
+  };
+
+  collectorSet.makeUsageCollector<Usage>(fromVarCollector);
+}
+
+export function defineCollectorFromFn() {
+  const fromFnCollector = createCollector();
+
+  collectorSet.makeUsageCollector<Usage>(fromFnCollector);
+}

src/dev/telemetry/__fixture__/file_with_no_collector.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 SOME_CONST: number = 123;