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.

Sign up for GitHub

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

Jump to bottom

[Dashboard] Deprecate Allow By Value Embeddables Setting #137219

Closed
wants to merge 1 commit into from
Closed

[Dashboard] Deprecate Allow By Value Embeddables Setting #137219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/plugins/dashboard/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ export const config: PluginConfigDescriptor<ConfigSchema> = {
allowByValueEmbeddables: true,
},
schema: configSchema,
deprecations: ({ deprecate }) => {
return [deprecate('allowByValueEmbeddables', '8.6.0', { level: 'warning' })];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe so, yes.
cc @Bamieh please correct me if I'm wrong

Copy link
Member

@Bamieh Bamieh Aug 30, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

},
};

// This exports static code and TypeScript types,
Expand Down