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

Plugins should be aware of UiSettings values change #83084

Open
mshustov opened this issue Nov 10, 2020 · 5 comments
Open

Plugins should be aware of UiSettings values change #83084

mshustov opened this issue Nov 10, 2020 · 5 comments
Labels
enhancement New value added to drive a business result Feature:Plugins Feature:uiSettings impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. loe:needs-research This issue requires some research before it can be worked on or estimated old Used to help sort old issues on GH Projects which don't support the Created search term. Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience)

Comments

@mshustov
Copy link
Contributor

In #82860 we had a case when a plugin wanted to perform a custom logic on value change.

User can adjust UiSettings in different ways:

  • in UI
  • calling UiSettings REST API
  • calling SO REST API
  • changing kibana.yml

We want to make sure that we cover all of the causes.

There are several different options:

  • move UiSettings change to the plugin context. Therefore, plugins could perform any custom logic and call UiSettings API to write/read UiSettings
  • still rely on AdavancedSettings UI, but provide a way for plugins to hook in platform API. For example, provide a stream of write operations to a plugin-owner, which can be used to implement any plugin-specific logic on top of it.
@mshustov mshustov added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc enhancement New value added to drive a business result labels Nov 10, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-platform (Team:Platform)

@mshustov mshustov changed the title Plugins should be aware of UiSettings change Plugins should be aware of UiSettings values change Nov 10, 2020
@TinaHeiligers TinaHeiligers added impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. loe:needs-research This issue requires some research before it can be worked on or estimated and removed EnableJiraSync labels Mar 7, 2022
@afharo
Copy link
Member

afharo commented Mar 15, 2022

This is blocking the removal of this deprecated API:

/**
* Metric to track once this property changes
* @deprecated
* Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place
*/
metric?: {
type: UiCounterMetricType;
name: string;
};

@TinaHeiligers
Copy link
Contributor

Plugins should absolutely be aware of any changes to the settings that the plugin consumes. That being said, we could guarantee change awareness if a plugin were only allowed to consume a setting that it, itself, registers.

Unfortunately, this is not the case at the moment but I believe it will become more critical in situations where we cannot know before hand which, if any, plugins are not enabled in a particular offering.

@pgayvallet
Copy link
Contributor

pgayvallet commented Dec 15, 2022

Note that if we do implement such a feature, depending on what we're planning to use it for, we may have to make it work for multi-instance Kibana (e.g instance1 update a setting -> instance2 need to somehow be aware of it)

@majagrubic majagrubic added Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) and removed Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Feb 1, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-sharedux (Team:SharedUX)

@petrklapka petrklapka added the old Used to help sort old issues on GH Projects which don't support the Created search term. label Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Plugins Feature:uiSettings impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. loe:needs-research This issue requires some research before it can be worked on or estimated old Used to help sort old issues on GH Projects which don't support the Created search term. Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience)
Projects
None yet
Development

No branches or pull requests

7 participants