[explore] add plugin (#9724)

kavilla · opensearch-changeset-bot[bot] · angle943 · web-flow · commit 0a2a48d51911 · 2025-05-02T04:16:32.000-07:00
This PR introduces the Explore plugin (experimental), a new data exploration experience in OpenSearch Dashboards. The Explore plugin builds upon the foundation of Discover while focusing on a query-driven approach with enhanced multi-dataset support. It exists alongside the current Discover plugin to allow for incremental adoption without disrupting existing workflows.

Signed-off-by: Kawika Avilla &lt;kavilla414@gmail.com&gt;

---------

Signed-off-by: Kawika Avilla &lt;kavilla414@gmail.com&gt;
Co-authored-by: opensearch-changeset-bot[bot] &lt;154024398+opensearch-changeset-bot[bot]@users.noreply.github.com&gt;
Co-authored-by: Justin Kim &lt;jungkm@amazon.com&gt;
diff --git a/changelogs/fragments/9724.yml b/changelogs/fragments/9724.yml
@@ -0,0 +1,2 @@
+feat:
+- Add new Explore plugin ([#9724](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9724))
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -46,6 +46,7 @@
       - [Dev_tools](../src/plugins/dev_tools/README.md)
       - [Discover](../src/plugins/discover/README.md)
       - [Embeddable](../src/plugins/embeddable/README.md)
+      - [Explore](../src/plugins/explore/README.md)
       - [Expressions](../src/plugins/expressions/README.md)
       - [Home](../src/plugins/home/README.md)
       - index_pattern_management
diff --git a/package.json b/package.json
@@ -65,7 +65,8 @@
     "start": "scripts/use_node scripts/opensearch_dashboards --dev",
     "start:docker": "scripts/use_node scripts/opensearch_dashboards --dev --opensearch.hosts=$OPENSEARCH_HOSTS --opensearch.ignoreVersionMismatch=true --server.host=$SERVER_HOST",
     "start:security": "scripts/use_node scripts/opensearch_dashboards --dev --security",
-    "start:enhancements": "scripts/use_node scripts/opensearch_dashboards --dev --uiSettings.overrides['query:enhancements:enabled']=true --uiSettings.overrides['home:useNewHomePage']=true",
+    "start:enhancements": "scripts/use_node scripts/opensearch_dashboards --dev --uiSettings.overrides['query:enhancements:enabled']=true --uiSettings.overrides['home:useNewHomePage']=true ",
+    "start:explore": "scripts/use_node scripts/opensearch_dashboards --dev --explore.enabled=true --uiSettings.overrides['query:enhancements:enabled']=true --uiSettings.overrides['home:useNewHomePage']=true --data_source.enabled=true --opensearchDashboards.branding.useExpandedHeader=false --opensearch.ignoreVersionMismatch=true",
     "debug": "scripts/use_node --nolazy --inspect scripts/opensearch_dashboards --dev",
     "debug-break": "scripts/use_node --nolazy --inspect-brk scripts/opensearch_dashboards --dev",
     "lint": "yarn run lint:es && yarn run lint:style",
diff --git a/src/dev/storybook/aliases.ts b/src/dev/storybook/aliases.ts
@@ -5,4 +5,5 @@
 
 export const storybookAliases = {
   discover: 'src/plugins/discover/.storybook',
+  explore: 'src/plugins/explore/.storybook',
 };
diff --git a/src/plugins/explore/.storybook/main.js b/src/plugins/explore/.storybook/main.js
@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+module.exports = require('@osd/storybook').defaultConfig;
diff --git a/src/plugins/explore/.storybook/preview.ts b/src/plugins/explore/.storybook/preview.ts
@@ -0,0 +1,11 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import '../../../../packages/osd-ui-shared-deps/target/osd-ui-shared-deps.css';
+import '../../../../packages/osd-ui-shared-deps/target/osd-ui-shared-deps.v7.light.css';
+
+export default {
+  parameters: {},
+};
diff --git a/src/plugins/explore/README.md b/src/plugins/explore/README.md
@@ -0,0 +1,37 @@
+# Explore Plugin (experimental)
+
+This plugin is experimental and will change in future releases.
+
+The Explore plugin represents an evolution of the Discover experience in OpenSearch Dashboards, providing enhanced query capabilities and multi-dataset support.
+
+## Overview
+
+This plugin introduces a query-driven data exploration experience while maintaining compatibility with the existing Discover functionality. It serves as a forward-looking replacement for Discover that will eventually become the primary data exploration interface.
+
+## Why a New Plugin?
+
+Creating a separate plugin instead of directly modifying Discover allows us to:
+
+1. Prevent regression on the existing Discover plugin while implementing new features
+2. Build a new architecture for a query-driven experience
+3. Enable incremental adoption as users transition to the new experience
+
+## Relationship to Other Plugins
+
+### Discover Plugin
+Explore builds upon Discover's core functionality while enhancing it with multi-dataset support and flexible query capabilities. Eventually, Explore will replace Discover entirely as a backward-compatible upgrade.
+
+### Data Explorer Plugin
+While Data Explorer provides a consolidated view of all data exploration tools, Explore focuses specifically on the search and analysis experience within that broader ecosystem.
+
+## Running the Plugin
+
+To run the Explore plugin:
+
+```bash
+yarn start:explore
+```
+
+## Future Plans
+
+The long-term goal is for Explore to completely replace the Discover plugin. This transition will happen gradually while maintaining backward compatibility to ensure a smooth transition for users and developers who have built workflows around Discover.
diff --git a/src/plugins/explore/common/index.ts b/src/plugins/explore/common/index.ts
@@ -0,0 +1,7 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const PLUGIN_ID = 'explore';
+export const PLUGIN_NAME = 'Discover (experimental)';
diff --git a/src/plugins/explore/config.ts b/src/plugins/explore/config.ts
@@ -0,0 +1,12 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { schema, TypeOf } from '@osd/config-schema';
+
+export const configSchema = schema.object({
+  enabled: schema.boolean({ defaultValue: false }),
+});
+
+export type ConfigSchema = TypeOf<typeof configSchema>;
diff --git a/src/plugins/explore/opensearch_dashboards.json b/src/plugins/explore/opensearch_dashboards.json
@@ -0,0 +1,22 @@
+{
+  "id": "explore",
+  "version": "1.0.0",
+  "opensearchDashboardsVersion": "opensearchDashboards",
+  "server": true,
+  "ui": true,
+  "requiredPlugins": [
+    "charts",
+    "data",
+    "dataExplorer",
+    "embeddable",
+    "inspector",
+    "opensearchDashboardsLegacy",
+    "urlForwarding",
+    "navigation",
+    "uiActions",
+    "visualizations",
+    "usageCollection"
+  ],
+  "optionalPlugins": ["home", "share"],
+  "configPath": ["explore"]
+}
diff --git a/src/plugins/explore/public/application.tsx b/src/plugins/explore/public/application.tsx
@@ -0,0 +1,28 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { AppMountParameters, CoreStart } from '../../../core/public';
+import { ExploreStartPlugins } from './types';
+import { ExploreApp } from './components/app';
+
+export const renderApp = (
+  { notifications, http }: CoreStart,
+  { navigation }: ExploreStartPlugins,
+  { appBasePath, element }: AppMountParameters
+) => {
+  ReactDOM.render(
+    <ExploreApp
+      basename={appBasePath}
+      notifications={notifications}
+      http={http}
+      navigation={navigation}
+    />,
+    element
+  );
+
+  return () => ReactDOM.unmountComponentAtNode(element);
+};
diff --git a/src/plugins/explore/public/components/app.tsx b/src/plugins/explore/public/components/app.tsx
@@ -0,0 +1,39 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React from 'react';
+import { I18nProvider } from '@osd/i18n/react';
+import { BrowserRouter as Router } from 'react-router-dom';
+
+import { CoreStart } from '../../../../core/public';
+import { NavigationPublicPluginStart, TopNavMenuItemRenderType } from '../../../navigation/public';
+
+import { PLUGIN_ID } from '../../common';
+
+interface ExploreAppDeps {
+  basename: string;
+  notifications: CoreStart['notifications'];
+  http: CoreStart['http'];
+  navigation: NavigationPublicPluginStart;
+}
+
+export const ExploreApp = ({ basename, notifications, http, navigation }: ExploreAppDeps) => {
+  return (
+    <Router basename={basename}>
+      <I18nProvider>
+        <>
+          <navigation.ui.TopNavMenu
+            appName={PLUGIN_ID}
+            useDefaultBehaviors={true}
+            config={[]}
+            showSearchBar={TopNavMenuItemRenderType.IN_PLACE}
+            showDatePicker={TopNavMenuItemRenderType.IN_PORTAL}
+            showSaveQuery={true}
+          />
+        </>
+      </I18nProvider>
+    </Router>
+  );
+};
diff --git a/src/plugins/explore/public/index.scss b/src/plugins/explore/public/index.scss
@@ -0,0 +1,5 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/* stylelint-disable no-empty-source */
diff --git a/src/plugins/explore/public/index.ts b/src/plugins/explore/public/index.ts
@@ -0,0 +1,13 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import './index.scss';
+
+import { ExplorePlugin } from './plugin';
+
+export function plugin() {
+  return new ExplorePlugin();
+}
+export { ExplorePluginSetup, ExplorePluginStart } from './types';
diff --git a/src/plugins/explore/public/plugin.ts b/src/plugins/explore/public/plugin.ts
@@ -0,0 +1,137 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { i18n } from '@osd/i18n';
+import {
+  AppMountParameters,
+  CoreSetup,
+  CoreStart,
+  DEFAULT_NAV_GROUPS,
+  Plugin,
+  WorkspaceAvailability,
+} from '../../../core/public';
+import {
+  ExplorePluginSetup,
+  ExplorePluginStart,
+  ExploreSetupPlugins,
+  ExploreStartPlugins,
+} from './types';
+import { PLUGIN_ID, PLUGIN_NAME } from '../common';
+
+export class ExplorePlugin implements Plugin<ExplorePluginSetup, ExplorePluginStart> {
+  public setup(core: CoreSetup, plugins: ExploreSetupPlugins): ExplorePluginSetup {
+    // Register an application into the side navigation menu
+    core.application.register({
+      id: PLUGIN_ID,
+      title: PLUGIN_NAME,
+      order: 1000,
+      workspaceAvailability: WorkspaceAvailability.insideWorkspace,
+      euiIconType: 'inputOutput',
+      defaultPath: '#/',
+      async mount(params: AppMountParameters) {
+        // Load application bundle
+        const { renderApp } = await import('./application');
+        // Get start services as specified in opensearch_dashboards.json
+        const [coreStart, depsStart] = await core.getStartServices();
+        // Render the application
+        return renderApp(coreStart, depsStart as ExploreStartPlugins, params);
+      },
+    });
+
+    core.chrome.navGroup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.observability, [
+      {
+        id: PLUGIN_ID,
+        category: undefined,
+        order: 300,
+      },
+    ]);
+
+    core.chrome.navGroup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.observability, [
+      {
+        id: PLUGIN_ID,
+        category: undefined,
+        order: 300,
+      },
+    ]);
+
+    core.chrome.navGroup.addNavLinksToGroup(DEFAULT_NAV_GROUPS['security-analytics'], [
+      {
+        id: PLUGIN_ID,
+        category: undefined,
+        order: 300,
+      },
+    ]);
+
+    core.chrome.navGroup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.essentials, [
+      {
+        id: PLUGIN_ID,
+        category: undefined,
+        order: 200,
+      },
+    ]);
+
+    core.chrome.navGroup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.search, [
+      {
+        id: PLUGIN_ID,
+        category: undefined,
+        order: 200,
+      },
+    ]);
+
+    core.chrome.navGroup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.all, [
+      {
+        id: PLUGIN_ID,
+        category: undefined,
+        order: 200,
+      },
+    ]);
+
+    // Register the plugin in the data explorer
+    // plugins.dataExplorer.registerView({
+    //   id: PLUGIN_ID,
+    //   title: PLUGIN_NAME,
+    //   defaultPath: '#/',
+    //   appExtentions: {
+    //     savedObject: {
+    //       docTypes: ['explore'],
+    //       toListItem: (obj) => ({
+    //         id: obj.id,
+    //         label: obj.title,
+    //       }),
+    //     },
+    //   },
+    //   shouldShow: () => true,
+    //   // ViewComponent
+    //   Canvas: lazy(() => import('./application/view_components/canvas')),
+    //   Panel: lazy(() => import('./application/view_components/panel')),
+    //   Context: lazy(() => import('./application/view_components/context')),
+    // });
+
+    // TODO: Register embeddable factory when ready
+    // this.registerEmbeddable(core, plugins);
+
+    return {};
+  }
+
+  public start(core: CoreStart): ExplorePluginStart {
+    return {};
+  }
+
+  public stop() {}
+
+  // TODO: Register embeddable factory when ready
+  // private registerEmbeddable(core: CoreSetup<ExploreStartPlugins>, plugins: ExploreSetupPlugins) {
+  //   const getStartServices = async () => {
+  //     const [coreStart, deps] = await core.getStartServices();
+  //     return {
+  //       executeTriggerActions: deps.uiActions.executeTriggerActions,
+  //       isEditable: () => coreStart.application.capabilities.discover?.save as boolean,
+  //     };
+  //   };
+
+  //   const factory = new ExploreEmbeddableFactory(getStartServices);
+  //   plugins.embeddable.registerEmbeddableFactory(factory.type, factory);
+  // }
+}
diff --git a/src/plugins/explore/public/types.ts b/src/plugins/explore/public/types.ts
diff --git a/src/plugins/explore/server/index.ts b/src/plugins/explore/server/index.ts
diff --git a/src/plugins/explore/server/plugin.ts b/src/plugins/explore/server/plugin.ts
diff --git a/src/plugins/explore/server/routes/index.ts b/src/plugins/explore/server/routes/index.ts
diff --git a/src/plugins/explore/server/types.ts b/src/plugins/explore/server/types.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+feat:`
	`2`	`+- Add new Explore plugin ([#9724](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9724))`