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

[PROPOSAL] : Rename query-insights plugin to opensearch-query-insights #242

Open
Panasg opened this issue Feb 6, 2025 · 1 comment
Open

Comments

@Panasg
Copy link

Panasg commented Feb 6, 2025

What/Why

What are you proposing?

I propose to ensure naming consistency across all default plugins bundled with the standard OpenSearch distribution. Currently, most default plugins use the opensearch- prefix, except for the query-insights plugin. To maintain uniformity and improve clarity, I suggest renaming query-insights to opensearch-query-insights or adopting another standardized approach.

What users have asked for this feature?

Developers have noticed the inconsistency in plugin naming conventions, leading to confusion. Standardizing the naming will improve clarity in documentation, plugin management, and integration workflows.

What problems are you trying to solve?

  • When managing OpenSearch plugins, a developer wants to easily identify default plugins by their naming convention, so they avoid confusion and ensure consistency.
  • When troubleshooting OpenSearch installations, a system administrator wants to quickly distinguish between default and other plugins, so they can efficiently debug and maintain deployments.

What is the developer experience going to be?

Developers will probably need to update references to the query-insights plugin if renamed.

Are there any security considerations?


Are there any breaking changes to the API

If the plugin is renamed, it may introduce breaking changes for users who reference it by its existing name in configurations or scripts.

What is the user experience going to be?


Are there breaking changes to the User Experience?

Yes, if the query-insights plugin is renamed, users will need to update their references to the plugin in configurations and deployment scripts.

Why should it be built? Any reason not to?

This change aligns with best practices for naming conventions and improves overall usability. The only drawback is the potential migration effort required by existing users.

What will it take to execute?


Any remaining open questions?


@ansjcy
Copy link
Member

ansjcy commented Feb 7, 2025

@Panasg Thanks for submitting the issue! I think it makes sense to rename the plugin and follow the best format.

@ansjcy ansjcy removed the untriaged label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants