[7.x] [Telemetry] Move to OSS (#45769) (#48370)

Author: Bamieh

.i18nrc.json

@@ -29,6 +29,7 @@
     "kbnESQuery": "packages/kbn-es-query",
     "inspector": "src/plugins/inspector",
     "kibana-react": "src/plugins/kibana_react",
+    "telemetry": "src/legacy/core_plugins/telemetry",
     "esUi": "src/plugins/es_ui_shared",
     "uiActions": "src/plugins/ui_actions"
   },

docs/settings/monitoring-settings.asciidoc

@@ -54,7 +54,7 @@ Specifies the password that {kib} uses for authentication when it retrieves data
 from the monitoring cluster. If not set, {kib} uses the value of the
 `elasticsearch.password` setting.
 
-`xpack.telemetry.enabled`::
+`telemetry.enabled`::
 Set to `true` (default) to send cluster statistics to Elastic. Reporting your
 cluster statistics helps us improve your user experience. Your data is never
 shared with anyone. Set to `false` to disable statistics reporting from any

src/dev/build/tasks/os_packages/docker_generator/resources/bin/kibana-docker

@@ -184,7 +184,7 @@ kibana_vars=(
     xpack.security.public.protocol
     xpack.security.public.hostname
     xpack.security.public.port
-    xpack.telemetry.enabled
+    telemetry.enabled
 )
 
 longopts=''

src/legacy/core_plugins/kibana/index.js

@@ -38,6 +38,7 @@ import * as systemApi from './server/lib/system_api';
 import mappings from './mappings.json';
 import { getUiSettingDefaults } from './ui_setting_defaults';
 import { makeKQLUsageCollector } from './server/lib/kql_usage_collector';
+import { registerCspCollector } from './server/lib/csp_usage_collector';
 import { injectVars } from './inject_vars';
 import { i18n } from '@kbn/i18n';
 
@@ -344,6 +345,7 @@ export default function (kibana) {
       registerFieldFormats(server);
       registerTutorials(server);
       makeKQLUsageCollector(server);
+      registerCspCollector(server);
       server.expose('systemApi', systemApi);
       server.injectUiAppVars('kibana', () => injectVars(server));
     },

src/legacy/core_plugins/kibana/public/home/components/telemetry_opt_in/telemetry_opt_in_card.tsx

@@ -24,7 +24,7 @@ import {
   EuiCard,
   EuiButton,
 } from '@elastic/eui';
-import { OptInMessage } from './opt_in_message';
+import { OptInMessage } from '../../../../../telemetry/public/components/opt_in_message';
 
 export interface Props {
   urlBasePath: string;

src/legacy/core_plugins/kibana/public/home/kibana_services.js

@@ -20,7 +20,7 @@
 import { uiModules } from 'ui/modules';
 import { npStart } from 'ui/new_platform';
 import { createUiStatsReporter, METRIC_TYPE } from '../../../ui_metric/public';
-import { TelemetryOptInProvider } from './telemetry_opt_in';
+import { TelemetryOptInProvider } from '../../../telemetry/public/services';
 
 export let indexPatternService;
 export let shouldShowTelemetryOptIn;

x-pack/legacy/plugins/oss_telemetry/server/lib/collectors/csp/csp_collector.test.ts renamed to src/legacy/core_plugins/kibana/server/lib/csp_usage_collector/csp_collector.test.ts

@@ -1,18 +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;
- * you may not use this file except in compliance with the Elastic License.
+ * 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 sinon from 'sinon';
-import { DEFAULT_CSP_RULES } from '../../../../../../../../src/legacy/server/csp';
-import {
-  getMockCallWithInternal,
-  getMockKbnServer,
-  getMockTaskFetch,
-} from '../../../../test_utils';
+import { Server } from 'hapi';
+import { DEFAULT_CSP_RULES } from '../../../../../server/csp';
 import { createCspCollector } from './csp_collector';
 
+interface MockConfig {
+  get: (x: string) => any;
+}
+
+const getMockKbnServer = (mockConfig: MockConfig) => ({
+  config: () => mockConfig,
+});
+
 test('fetches whether strict mode is enabled', async () => {
   const { collector, mockConfig } = setupCollector();
 
@@ -72,7 +89,7 @@ function setupCollector() {
   mockConfig.get.withArgs('csp.strict').returns(true);
   mockConfig.get.withArgs('csp.warnLegacyBrowsers').returns(true);
 
-  const mockKbnServer = getMockKbnServer(getMockCallWithInternal(), getMockTaskFetch(), mockConfig);
+  const mockKbnServer = getMockKbnServer(mockConfig);
 
-  return { mockConfig, collector: createCspCollector(mockKbnServer) };
+  return { mockConfig, collector: createCspCollector(mockKbnServer as Server) };
 }

src/legacy/core_plugins/kibana/server/lib/csp_usage_collector/csp_collector.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 { Server } from 'hapi';
+import { createCSPRuleString, DEFAULT_CSP_RULES } from '../../../../../server/csp';
+
+export function createCspCollector(server: Server) {
+  return {
+    type: 'csp',
+    isReady: () => true,
+    async fetch() {
+      const config = server.config();
+
+      // It's important that we do not send the value of csp.rules here as it
+      // can be customized with values that can be identifiable to given
+      // installs, such as URLs
+      const defaultRulesString = createCSPRuleString([...DEFAULT_CSP_RULES]);
+      const actualRulesString = createCSPRuleString(config.get('csp.rules'));
+
+      return {
+        strict: config.get('csp.strict'),
+        warnLegacyBrowsers: config.get('csp.warnLegacyBrowsers'),
+        rulesChangedFromDefault: defaultRulesString !== actualRulesString,
+      };
+    },
+  };
+}
+
+export function registerCspCollector(server: Server): void {
+  const { collectorSet } = server.usage;
+  const collector = collectorSet.makeUsageCollector(createCspCollector(server));
+  collectorSet.register(collector);
+}

src/legacy/core_plugins/kibana/server/lib/csp_usage_collector/index.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 { registerCspCollector } from './csp_collector';

src/legacy/core_plugins/telemetry/common/constants.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 { i18n } from '@kbn/i18n';
+
+/*
+ * config options opt into telemetry
+ * @type {string}
+ */
+export const CONFIG_TELEMETRY = 'telemetry:optIn';
+/*
+ * config description for opting into telemetry
+ * @type {string}
+ */
+export const getConfigTelemetryDesc = () => {
+  return i18n.translate('telemetry.telemetryConfigDescription', {
+    defaultMessage:
+      'Help us improve the Elastic Stack by providing usage statistics for basic features. We will not share this data outside of Elastic.',
+  });
+};
+
+/**
+ * The amount of time, in milliseconds, to wait between reports when enabled.
+ *
+ * Currently 24 hours.
+ * @type {Number}
+ */
+export const REPORT_INTERVAL_MS = 86400000;
+
+/*
+ * Key for the localStorage service
+ */
+export const LOCALSTORAGE_KEY = 'telemetry.data';
+
+/**
+ * Link to the Elastic Telemetry privacy statement.
+ */
+export const PRIVACY_STATEMENT_URL = `https://www.elastic.co/legal/telemetry-privacy-statement`;
+
+/**
+ * The type name used within the Monitoring index to publish localization stats.
+ * @type {string}
+ */
+export const KIBANA_LOCALIZATION_STATS_TYPE = 'localization';
+
+/**
+ * UI metric usage type
+ * @type {string}
+ */
+export const UI_METRIC_USAGE_TYPE = 'ui_metric';

src/legacy/core_plugins/telemetry/common/get_xpack_config_with_deprecated.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 { KibanaConfig } from 'src/legacy/server/kbn_server';
+
+export function getXpackConfigWithDeprecated(config: KibanaConfig, configPath: string) {
+  try {
+    const deprecatedXpackmainConfig = config.get(`xpack.xpack_main.${configPath}`);
+    if (typeof deprecatedXpackmainConfig !== 'undefined') {
+      return deprecatedXpackmainConfig;
+    }
+  } catch (err) {
+    // swallow error
+  }
+  try {
+    const deprecatedXpackConfig = config.get(`xpack.${configPath}`);
+    if (typeof deprecatedXpackConfig !== 'undefined') {
+      return deprecatedXpackConfig;
+    }
+  } catch (err) {
+    // swallow error
+  }
+
+  return config.get(configPath);
+}