[Dashboard] Deprecate Allow By Value Embeddables Setting #137219
Conversation
ThomThomson
added
Feature:Dashboard
💚 Build Succeeded
Metrics [docs]
To update your PR or re-run it, just comment with: |
| @@ -15,6 +15,9 @@ export const config: PluginConfigDescriptor<ConfigSchema> = { | |||
| allowByValueEmbeddables: true, | |||
| }, | |||
| schema: configSchema, | |||
| deprecations: ({ deprecate }) => { | |||
| return [deprecate('allowByValueEmbeddables', '8.6.0', { level: 'warning' })]; | |||
There was a problem hiding this comment.
Thanks Tina! Just to confirm, this will make this setting show up in stack_stats.kibana.plugins.core.config.deprecatedKeys.unset when it is unset?
There was a problem hiding this comment.
I believe so, yes.
cc @Bamieh please correct me if I'm wrong
There was a problem hiding this comment.
If i'm not mistaken the deprecate helper will only log a warning. I recommend using the unused helper for this config. it will not add telemetry insidestack_stats.kibana.plugins.core.config.deprecatedKeys.unset
This is the code for the deprecate helper:
https://github.com/elastic/kibana/blob/main/packages/kbn-config/src/deprecation/deprecation_factory.ts#L209
There was a problem hiding this comment.
Hey @Bamieh, sorry for the late reply! Will the unused helper add telemetry? If not, is there a way we can do so? One of the main reasons for deprecating this is so we can see if any clusters are using it. It's unlikely that any are.
Will the unused helper throw warnings or errors on startup if a cluster happens to be configured with that key?
|
Closing this for now. Will look into this again in the future. |
Summary
The Allow By Value Embeddables setting was added as part of the Time to Visualize project. It was turned on by default in 7.12. This setting has been unused since, and is adding additional complexity to the dashboard code.
This PR doesn't delete the setting, but it does mark it as deprecated in the hopes that we can then check its usage by counting up occurrences in the telemetry under the key
stack_stats.kibana.plugins.core.config.deprecatedKeys.unset@TinaHeiligers