[ES|QL] Rename the setting to a more generic one and move to the gene…

…ral section (#182074) ## Summary Renames the setting from discover:enableESQL to enableESQL and moves it to the General Section <img width="985" alt="image" src="https://github.com/elastic/kibana/assets/17003240/ebafe7cd-4695-413c-a0e3-90e3574139e5"> We checked the telemetry and a very small percentage of users have switched off this setting. It was also on tech preview so we decided in favor of this change as more and more applications are using this setting to hide ESQL from their applications. <img width="850" alt="image" src="https://github.com/elastic/kibana/assets/17003240/404f2494-8a17-4a9d-943a-d9d72b324bc0"> ### Release note We renamed the advanced setting which hides the ES|QL from the UI from `discover:enableESQL` to `enableESQL`. You have to switch it off again if you want to disable ES|QL features from your kibana applications. --------- Co-authored-by: kibanamachine <[email protected]>
elastic · May 1, 2024 · f3d18fa · f3d18fa
1 parent 0842c60
commit f3d18fa
Show file tree

Hide file tree

Showing 40 changed files with 117 additions and 63 deletions.
diff --git a/config/serverless.yml b/config/serverless.yml
@@ -138,7 +138,7 @@ xpack.actions.queued.max: 10000
 # Disables ESQL in advanced settings (hides it from the UI)
 uiSettings:
   overrides:
-    discover:enableESQL: true
+    enableESQL: true
 
 # Task Manager
 xpack.task_manager.allow_reading_invalid_state: false

diff --git a/docs/discover/try-esql.asciidoc b/docs/discover/try-esql.asciidoc
@@ -11,7 +11,7 @@ In this tutorial we'll use the {kib} sample web logs in Discover and Lens to exp
 [[prerequisite]]
 === Prerequisite 
 
-To be able to select **Try {esql}** from the Data views menu the `discover:enableESQL` setting must be enabled from **Stack Management > Advanced Settings**. It is enabled by default. 
+To be able to select **Try {esql}** from the Data views menu the `enableESQL` setting must be enabled from **Stack Management > Advanced Settings**. It is enabled by default. 
 
 [float]
 [[tutorial-try-esql]]

diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc
@@ -209,6 +209,9 @@ The default selection in the time filter.
 The maximum height that a cell occupies in a table. Set to 0 to disable
 truncation.
 
+[[enableESQL]]`enableESQL`::
+This setting enables ES|QL in Kibana.
+
 [float]
 [[presentation-labs]]
 ==== Presentation Labs
@@ -290,9 +293,6 @@ in the current data view is used.
 The columns that appear by default on the *Discover* page. The default is
 `_source`.
 
-[[discover:enableESQL]]`discover:enableESQL`::
-experimental[] Allows ES|QL queries for search.
-
 [[discover-max-doc-fields-displayed]]`discover:maxDocFieldsDisplayed`::
 Specifies the maximum number of fields to show in the document column of the *Discover* table.
 

diff --git a/packages/kbn-discover-utils/index.ts b/packages/kbn-discover-utils/index.ts
@@ -13,7 +13,6 @@ export {
   DEFAULT_COLUMNS_SETTING,
   DOC_HIDE_TIME_COLUMN_SETTING,
   DOC_TABLE_LEGACY,
-  ENABLE_ESQL,
   FIELDS_LIMIT_SETTING,
   HIDE_ANNOUNCEMENTS,
   MAX_DOC_FIELDS_DISPLAYED,

diff --git a/packages/kbn-discover-utils/src/constants.ts b/packages/kbn-discover-utils/src/constants.ts
@@ -12,7 +12,6 @@ export const CONTEXT_TIE_BREAKER_FIELDS_SETTING = 'context:tieBreakerFields';
 export const DEFAULT_COLUMNS_SETTING = 'defaultColumns';
 export const DOC_HIDE_TIME_COLUMN_SETTING = 'doc_table:hideTimeColumn';
 export const DOC_TABLE_LEGACY = 'doc_table:legacy';
-export const ENABLE_ESQL = 'discover:enableESQL';
 export const FIELDS_LIMIT_SETTING = 'fields:popularLimit';
 export const HIDE_ANNOUNCEMENTS = 'hideAnnouncements';
 export const MAX_DOC_FIELDS_DISPLAYED = 'discover:maxDocFieldsDisplayed';

diff --git a/packages/kbn-esql-utils/constants.ts b/packages/kbn-esql-utils/constants.ts
@@ -9,3 +9,4 @@
 // we are expecting to retrieve this from an API instead
 // https://github.com/elastic/elasticsearch/issues/107069
 export const ESQL_LATEST_VERSION = '2024.04.01';
+export const ENABLE_ESQL = 'enableESQL';
diff --git a/packages/kbn-esql-utils/index.ts b/packages/kbn-esql-utils/index.ts
@@ -19,4 +19,4 @@ export {
   TextBasedLanguages,
 } from './src';
 
-export { ESQL_LATEST_VERSION } from './constants';
+export { ESQL_LATEST_VERSION, ENABLE_ESQL } from './constants';
diff --git a/packages/kbn-management/settings/setting_ids/index.ts b/packages/kbn-management/settings/setting_ids/index.ts
@@ -73,7 +73,7 @@ export const CONTEXT_DEFAULT_SIZE_ID = 'context:defaultSize';
 export const CONTEXT_STEP_ID = 'context:step';
 export const CONTEXT_TIE_BREAKER_FIELDS_ID = 'context:tieBreakerFields';
 export const DEFAULT_COLUMNS_ID = 'defaultColumns';
-export const DISCOVER_ENABLE_ESQL_ID = 'discover:enableESQL';
+export const ENABLE_ESQL_ID = 'enableESQL';
 export const DISCOVER_MAX_DOC_FIELDS_DISPLAYED_ID = 'discover:maxDocFieldsDisplayed';
 export const DISCOVER_MODIFY_COLUMNS_ON_SWITCH_ID = 'discover:modifyColumnsOnSwitch';
 export const DISCOVER_ROW_HEIGHT_OPTION_ID = 'discover:rowHeightOption';

diff --git a/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx b/src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx
@@ -10,7 +10,7 @@ import React, { useCallback, useEffect, useMemo, useRef } from 'react';
 import type { AggregateQuery, Query, TimeRange } from '@kbn/es-query';
 import { type DataView, DataViewType } from '@kbn/data-views-plugin/public';
 import { DataViewPickerProps } from '@kbn/unified-search-plugin/public';
-import { ENABLE_ESQL } from '@kbn/discover-utils';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
 import { TextBasedLanguages } from '@kbn/esql-utils';
 import {
   useSavedSearch,

diff --git a/src/plugins/discover/public/plugin.tsx b/src/plugins/discover/public/plugin.tsx
@@ -29,6 +29,7 @@ import { HomePublicPluginSetup } from '@kbn/home-plugin/public';
 import { Start as InspectorPublicPluginStart } from '@kbn/inspector-plugin/public';
 import { DataPublicPluginSetup, DataPublicPluginStart } from '@kbn/data-plugin/public';
 import { DEFAULT_APP_CATEGORIES } from '@kbn/core/public';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
 import { UsageCollectionSetup } from '@kbn/usage-collection-plugin/public';
 import { IndexPatternFieldEditorStart } from '@kbn/data-view-field-editor-plugin/public';
 import { DataViewsServicePublic } from '@kbn/data-views-plugin/public';
@@ -44,7 +45,7 @@ import type { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/
 import type { UnifiedDocViewerStart } from '@kbn/unified-doc-viewer-plugin/public';
 import { setStateToKbnUrl } from '@kbn/kibana-utils-plugin/public';
 import type { LensPublicStart } from '@kbn/lens-plugin/public';
-import { TRUNCATE_MAX_HEIGHT, ENABLE_ESQL } from '@kbn/discover-utils';
+import { TRUNCATE_MAX_HEIGHT } from '@kbn/discover-utils';
 import type { NoDataPagePluginStart } from '@kbn/no-data-page-plugin/public';
 import type {
   ObservabilityAIAssistantPublicSetup,

diff --git a/src/plugins/discover/server/ui_settings.ts b/src/plugins/discover/server/ui_settings.ts
@@ -30,7 +30,6 @@ import {
   TRUNCATE_MAX_HEIGHT,
   SHOW_FIELD_STATISTICS,
   ROW_HEIGHT_OPTION,
-  ENABLE_ESQL,
 } from '@kbn/discover-utils';
 import { DEFAULT_ROWS_PER_PAGE, ROWS_PER_PAGE_OPTIONS } from '../common/constants';
 
@@ -310,25 +309,4 @@ export const getUiSettings: (
     schema: schema.number({ min: 0 }),
     requiresPageReload: true,
   },
-  [ENABLE_ESQL]: {
-    name: i18n.translate('discover.advancedSettings.enableESQLTitle', {
-      defaultMessage: 'Enable ES|QL',
-    }),
-    value: true,
-    description: i18n.translate('discover.advancedSettings.enableESQLDescription', {
-      defaultMessage:
-        'This setting enables ES|QL in Kibana. By switching it off you will hide the ES|QL user interface from various applications. However, users will be able to access existing ES|QL saved searches, visualizations, etc. If you have feedback on this experience please reach out to us on {link}',
-      values: {
-        link:
-          `<a href="https://ela.st/esql-feedback" target="_blank" rel="noopener">` +
-          i18n.translate('discover.advancedSettings.enableESQL.discussLinkText', {
-            defaultMessage: 'https://ela.st/esql-feedback',
-          }) +
-          '</a>',
-      },
-    }),
-    requiresPageReload: true,
-    category: ['discover'],
-    schema: schema.boolean(),
-  },
 });
diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts b/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
@@ -539,7 +539,7 @@ export const stackManagementSchema: MakeSchemaFrom<UsageStats> = {
     type: 'boolean',
     _meta: { description: 'Non-default value of setting.' },
   },
-  'discover:enableESQL': {
+  enableESQL: {
     type: 'boolean',
     _meta: { description: 'Non-default value of setting.' },
   },

diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/types.ts b/src/plugins/kibana_usage_collection/server/collectors/management/types.ts
@@ -34,7 +34,7 @@ export interface UsageStats {
   'discover:searchFieldsFromSource': boolean;
   'discover:showFieldStatistics': boolean;
   'discover:showMultiFields': boolean;
-  'discover:enableESQL': boolean;
+  enableESQL: boolean;
   'discover:maxDocFieldsDisplayed': number;
   'securitySolution:rulesTableRefresh': string;
   'observability:enableInspectEsQueries': boolean;

diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
@@ -10254,7 +10254,7 @@
             "description": "Non-default value of setting."
           }
         },
-        "discover:enableESQL": {
+        "enableESQL": {
           "type": "boolean",
           "_meta": {
             "description": "Non-default value of setting."

diff --git a/src/plugins/text_based_languages/kibana.jsonc b/src/plugins/text_based_languages/kibana.jsonc
@@ -4,7 +4,7 @@
   "owner": "@elastic/kibana-esql",
   "plugin": {
     "id": "textBasedLanguages",
-    "server": false,
+    "server": true,
     "browser": true,
     "optionalPlugins": [
       "indexManagement"

diff --git a/src/plugins/text_based_languages/server/index.ts b/src/plugins/text_based_languages/server/index.ts
@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+export const plugin = async () => {
+  const { TextBasedLanguagesServerPlugin } = await import('./plugin');
+  return new TextBasedLanguagesServerPlugin();
+};
diff --git a/src/plugins/text_based_languages/server/plugin.ts b/src/plugins/text_based_languages/server/plugin.ts
@@ -0,0 +1,23 @@
+/*
+ * 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 { CoreSetup, CoreStart, Plugin } from '@kbn/core/server';
+import { getUiSettings } from './ui_settings';
+
+export class TextBasedLanguagesServerPlugin implements Plugin {
+  public setup(core: CoreSetup) {
+    core.uiSettings.register(getUiSettings());
+    return {};
+  }
+
+  public start(core: CoreStart) {
+    return {};
+  }
+
+  public stop() {}
+}
diff --git a/src/plugins/text_based_languages/server/ui_settings.ts b/src/plugins/text_based_languages/server/ui_settings.ts
@@ -0,0 +1,36 @@
+/*
+ * 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 { i18n } from '@kbn/i18n';
+import { schema } from '@kbn/config-schema';
+
+import type { UiSettingsParams } from '@kbn/core/server';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
+
+export const getUiSettings: () => Record<string, UiSettingsParams> = () => ({
+  [ENABLE_ESQL]: {
+    name: i18n.translate('textBasedLanguages.advancedSettings.enableESQLTitle', {
+      defaultMessage: 'Enable ES|QL',
+    }),
+    value: true,
+    description: i18n.translate('textBasedLanguages.advancedSettings.enableESQLDescription', {
+      defaultMessage:
+        'This setting enables ES|QL in Kibana. By switching it off you will hide the ES|QL user interface from various applications. However, users will be able to access existing ES|QL saved searches, visualizations, etc. If you have feedback on this experience please reach out to us on {link}',
+      values: {
+        link:
+          `<a href="https://ela.st/esql-feedback" target="_blank" rel="noopener">` +
+          i18n.translate('textBasedLanguages.advancedSettings.enableESQL.discussLinkText', {
+            defaultMessage: 'https://ela.st/esql-feedback',
+          }) +
+          '</a>',
+      },
+    }),
+    requiresPageReload: true,
+    schema: schema.boolean(),
+  },
+});
diff --git a/src/plugins/text_based_languages/tsconfig.json b/src/plugins/text_based_languages/tsconfig.json
@@ -15,7 +15,10 @@
     "@kbn/core",
     "@kbn/expressions-plugin",
     "@kbn/data-views-plugin",
-    "@kbn/index-management"
+    "@kbn/index-management",
+    "@kbn/i18n",
+    "@kbn/config-schema",
+    "@kbn/esql-utils"
   ],
   "exclude": [
     "target/**/*",

diff --git a/test/functional/apps/discover/group3/_request_counts.ts b/test/functional/apps/discover/group3/_request_counts.ts
@@ -37,7 +37,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       await kibanaServer.uiSettings.replace({
         defaultIndex: 'logstash-*',
         'bfetch:disable': true,
-        'discover:enableESQL': true,
+        enableESQL: true,
       });
       await PageObjects.timePicker.setDefaultAbsoluteRangeViaUiSettings();
     });

diff --git a/test/functional/apps/discover/group4/_esql_view.ts b/test/functional/apps/discover/group4/_esql_view.ts
@@ -35,7 +35,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
 
   const defaultSettings = {
     defaultIndex: 'logstash-*',
-    'discover:enableESQL': true,
+    enableESQL: true,
   };
 
   describe('discover esql view', async function () {

diff --git a/...lugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx b/...lugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx
@@ -32,7 +32,7 @@ import {
   UrlStateProvider,
 } from '@kbn/ml-url-state';
 import type { SavedSearch } from '@kbn/saved-search-plugin/public';
-import { ENABLE_ESQL } from '@kbn/discover-utils';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
 import { EuiCallOut } from '@elastic/eui';
 import { FormattedMessage } from '@kbn/i18n-react';
 import { getCoreStart, getPluginsStart } from '../../kibana_services';

diff --git a/x-pack/plugins/data_visualizer/tsconfig.json b/x-pack/plugins/data_visualizer/tsconfig.json
@@ -78,7 +78,6 @@
     "@kbn/visualization-utils",
     "@kbn/ml-time-buckets",
     "@kbn/aiops-log-rate-analysis",
-    "@kbn/discover-utils",
     "@kbn/react-kibana-context-render",
     "@kbn/react-kibana-context-theme"
   ],

diff --git a/x-pack/plugins/lens/public/embeddable/embeddable.tsx b/x-pack/plugins/lens/public/embeddable/embeddable.tsx
@@ -11,6 +11,7 @@ import type { Observable } from 'rxjs';
 import { css } from '@emotion/react';
 import { i18n } from '@kbn/i18n';
 import { render, unmountComponentAtNode } from 'react-dom';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
 import {
   DataViewBase,
   EsQueryConfig,
@@ -1556,7 +1557,7 @@ export class Embeddable
 
   public getIsEditable() {
     // for ES|QL, editing is allowed only if the advanced setting is on
-    if (Boolean(this.isTextBasedLanguage()) && !this.deps.uiSettings.get('discover:enableESQL')) {
+    if (Boolean(this.isTextBasedLanguage()) && !this.deps.uiSettings.get(ENABLE_ESQL)) {
       return false;
     }
     return (

diff --git a/x-pack/plugins/lens/public/trigger_actions/open_lens_config/create_action.test.tsx b/x-pack/plugins/lens/public/trigger_actions/open_lens_config/create_action.test.tsx
@@ -32,7 +32,7 @@ describe('create Lens panel action', () => {
         uiSettings: {
           ...core.uiSettings,
           get: (setting: string) => {
-            return setting === 'discover:enableESQL';
+            return setting === 'enableESQL';
           },
         },
       } as CoreStart;

diff --git a/x-pack/plugins/lens/public/trigger_actions/open_lens_config/create_action_helpers.ts b/x-pack/plugins/lens/public/trigger_actions/open_lens_config/create_action_helpers.ts
@@ -9,7 +9,7 @@ import type { CoreStart } from '@kbn/core/public';
 import { getLensAttributesFromSuggestion } from '@kbn/visualization-utils';
 import { IncompatibleActionError } from '@kbn/ui-actions-plugin/public';
 import { PresentationContainer } from '@kbn/presentation-containers';
-import { getESQLAdHocDataview, getIndexForESQLQuery } from '@kbn/esql-utils';
+import { getESQLAdHocDataview, getIndexForESQLQuery, ENABLE_ESQL } from '@kbn/esql-utils';
 import type { Datasource, Visualization } from '../../types';
 import type { LensPluginStartDependencies } from '../../plugin';
 import { fetchDataFromAggregateQuery } from '../../datasources/text_based/fetch_data_from_aggregate_query';
@@ -28,7 +28,7 @@ export const [getDatasourceMap, setDatasourceMap] = createGetterSetter<
 >('DatasourceMap', false);
 
 export function isCreateActionCompatible(core: CoreStart) {
-  return core.uiSettings.get('discover:enableESQL');
+  return core.uiSettings.get(ENABLE_ESQL);
 }
 
 export async function executeCreateAction({

diff --git a/...er_actions/open_lens_config/in_app_embeddable_edit/in_app_embeddable_edit_action.test.tsx b/...er_actions/open_lens_config/in_app_embeddable_edit/in_app_embeddable_edit_action.test.tsx
@@ -51,7 +51,7 @@ describe('inapp editing of Lens embeddable', () => {
         uiSettings: {
           ...core.uiSettings,
           get: (setting: string) => {
-            return setting === 'discover:enableESQL';
+            return setting === 'enableESQL';
           },
         },
       } as CoreStart;

diff --git a/...actions/open_lens_config/in_app_embeddable_edit/in_app_embeddable_edit_action_helpers.tsx b/...actions/open_lens_config/in_app_embeddable_edit/in_app_embeddable_edit_action_helpers.tsx
@@ -8,6 +8,7 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import type { CoreStart } from '@kbn/core/public';
 import { isOfAggregateQueryType } from '@kbn/es-query';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
 import { toMountPoint } from '@kbn/react-kibana-mount';
 import { IncompatibleActionError } from '@kbn/ui-actions-plugin/public';
 import type { LensPluginStartDependencies } from '../../../plugin';
@@ -21,7 +22,7 @@ export function isEmbeddableEditActionCompatible(
 ) {
   // for ES|QL is compatible only when advanced setting is enabled
   const query = attributes.state.query;
-  return isOfAggregateQueryType(query) ? core.uiSettings.get('discover:enableESQL') : true;
+  return isOfAggregateQueryType(query) ? core.uiSettings.get(ENABLE_ESQL) : true;
 }
 
 export async function executeEditEmbeddableAction({

diff --git a/x-pack/plugins/ml/public/application/datavisualizer/datavisualizer_selector.tsx b/x-pack/plugins/ml/public/application/datavisualizer/datavisualizer_selector.tsx
@@ -23,7 +23,7 @@ import {
 
 import { FormattedMessage } from '@kbn/i18n-react';
 import { useTimefilter } from '@kbn/ml-date-picker';
-import { ENABLE_ESQL } from '@kbn/discover-utils';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
 import { isFullLicense } from '../license';
 import { useMlKibana, useNavigateToPath } from '../contexts/kibana';
 import { HelpMenu } from '../components/help_menu';

diff --git a/x-pack/plugins/ml/public/plugin.ts b/x-pack/plugins/ml/public/plugin.ts
@@ -50,7 +50,7 @@ import type { SavedSearchPublicPluginStart } from '@kbn/saved-search-plugin/publ
 import type { PresentationUtilPluginStart } from '@kbn/presentation-util-plugin/public';
 import type { DataViewEditorStart } from '@kbn/data-view-editor-plugin/public';
 import type { FieldFormatsRegistry } from '@kbn/field-formats-plugin/common';
-import { ENABLE_ESQL } from '@kbn/discover-utils';
+import { ENABLE_ESQL } from '@kbn/esql-utils';
 import type { MlSharedServices } from './application/services/get_shared_ml_services';
 import { getMlSharedServices } from './application/services/get_shared_ml_services';
 import { registerManagementSection } from './application/management';

diff --git a/x-pack/plugins/ml/tsconfig.json b/x-pack/plugins/ml/tsconfig.json
@@ -124,7 +124,7 @@
     "@kbn/presentation-containers",
     "@kbn/presentation-panel-plugin",
     "@kbn/shared-ux-utility",
-    "@kbn/discover-utils",
     "@kbn/react-kibana-context-render",
+    "@kbn/esql-utils",
   ],
 }