Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release 3.0] Planned Breaking Changes for 3.0 in Plugin #2311

Open
peterzhuamazon opened this issue Jan 16, 2025 · 1 comment
Open

[Release 3.0] Planned Breaking Changes for 3.0 in Plugin #2311

peterzhuamazon opened this issue Jan 16, 2025 · 1 comment
Labels

Comments

@peterzhuamazon
Copy link
Member

[Release 3.0] Planned Breaking Changes for 3.0 in Plugin

As mentioned in this META Issue, we want to track and increase transparency around the breaking changes planned for the 3.0 release across participating plugins.

Please kindly document all planned breaking changes related to your plugin for 3.0 here, by sharing detailed information about the changes, expected impact, and any guidance for users or other teams to adapt to the changes.

If needed, please also prepare PRs on documentation-website changes as part of the 3.0 release process.

Overall, this would help us deliver a smooth and seamless upgrade experience.

Thanks.

@ps48
Copy link
Member

ps48 commented Jan 28, 2025

Decision Made

We aren't removing 1) Log Explorer, 2) Observability Dashboards, and 3) App Analytics in the 3.0 release. The main reason being Discover 2.0 doesn't support the creation of PPL visualizations. While this feature gap is being worked on, we plan a phase-wise deprecation starting with the Observability backend plugin and later extending to each of these plugin sub-components. We plan to remove the above-mentioned plugin components in OpenSearch Dashboards version 4.0, where we expect to have 1:1 feature parity with the alternatives we expect users to use.

Meanwhile we still are planning to remove the legacy notebooks support for 3.0 version as outlined below. Also, Legacy client deprecation from core is moved out of 3.0 plan. So no changes required here for now.

Features to be removed in 3.0

  1. Notebooks - Remove support for legacy notebooks from observability index. Users post 2.17 have a way to migrate the legacy notebooks to saved objects in .kibana index. The plugin supports legacy for read-only operation on notebooks. The plugin supports legacy for read-only operation on notebooks in 2.17 >= and < 3.0 versions.

## Deprecation and removal post cohesion in 3.0

Today dashboards-observability plugin several components, some of these components have been merged in new experiences as part of the cohesion project. Since, the long term vision for cohesion project is to replace the dupe experiences. We as maintainers of dashboards-observability propose that these dupe experiences should be deprecated. Components to be proposed for deprecation and removal are:

1) Log Explorer - Replacement is new discover experience

2) Observability Dashboards - Replacement is new discover and the existing dashboarding experience

3) App Analytics - Replacement is workspaces

## Support breaking changes from core 3.0 changes

1) Legacy client - Dashboards observability uses legacy client to extend its APIs for connecting to SQL and Observability backend plugin. [This change] (opensearch-project/OpenSearch-Dashboards#2220) from core will break the plugin and hence needs changes to be done to plugin's server code.

These are proposed changes based on discussion with @mengweieric @joshuali925 @vamsimanohar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants