Required for #114197

In #114197, we're planning to no longer have the deprecation's level be optional when registering it.

For this reason, we need all deprecation owners to explicitly set the correct level for all of their existing deprecations, both config deprecations registered via the PluginConfigDescriptor, and deprecations registered via the core.deprecations API.

This will also be an occasion for all deprecation owners to check if their deprecations are defining their correct level, as most deprecations are currently using the default, which is critical, and may be wrong.

Note: having a deprecation with an incorrect level is considered a bug. Therefor, fixing your deprecation's level can be flagged as bug and merged after 7.16 FF.

How to choose the correct deprecation level?

Please follow these guidelines to decide if your deprecation should be considered as critical or warning:

• Critical deprecations are ones that must be addressed before the upgrade, otherwise the deployment will be unstable, degraded, fail to start, or otherwise exhibit undesirable and unintended behavior.
• Warning deprecations are everything else. They're optional or they may not apply to the user. The user has discretion to decide whether or not to act on them. If the user ignores them and upgrades the deployment, the deployment will function normally.

How to adapt my deprecation to set the correct level?

For config deprecations (registered with the plugin's config)

factory deprecations

Add the level option to the (optional) last parameter of the deprecation factory.

before

export const config: PluginConfigDescriptor<ConfigType> = {
  schema: configSchema,
  deprecations: ({ deprecate, rename, unused }) => [
    deprecate('enabled', '8.0.0'),
    rename('old', 'new'),
    unused('unused'),
  ],
};

after

export const config: PluginConfigDescriptor<ConfigType> = {
  schema: configSchema,
  deprecations: ({ deprecate, rename, unused }) => [
    deprecate('enabled', '8.0.0', { level: 'critical'}),
    rename('old', 'new', { level: 'warning'}),
    unused('unused', { level: 'warning'}),
  ],
};

non-factory deprecations

Just add the level option to the addDeprecation call:

before

export const config: PluginConfigDescriptor<MyConfigType> = {
  schema: ConfigSchema,
  deprecations: () => [
    (settings, fromPath, addDeprecation) => {
      if (someCondition) {
        addDeprecation({
          configPath: 'plugin.somePath',
          title: 'some title',
          message: `some message`,
          correctiveActions: {
            manualSteps: [`come on, do something`],
          },
        });
      }
    },
  ],
};

after

export const config: PluginConfigDescriptor<MyConfigType> = {
  schema: ConfigSchema,
  deprecations: () => [
    (settings, fromPath, addDeprecation) => {
      if (someCondition) {
        addDeprecation({
          configPath: 'plugin.somePath',
          level: ''warning, // <-- that's the only change
          title: 'some title',
          message: `some message`,
          correctiveActions: {
            manualSteps: [`come on, do something`],
          },
        });
      }
    },
  ],
};

For other deprecations (registered via core.deprecations)

Just specify the level option when returning your deprecations

before

core.deprecations.registerDeprecations({
   getDeprecations: async (context) => {
     return [{
       title: 'some title',
       message: 'some message',
       deprecationType: 'feature',
       correctiveActions: { /* */ }
     }];
   }
}) 

after

core.deprecations.registerDeprecations({
   getDeprecations: async (context) => {
     return [{
       level: 'critical', // <-- this is the only change
       title: 'some title',
       message: 'some message',
       deprecationType: 'feature',
       correctiveActions: { /* */ }
     }];
   }
}) 

Inventory

Note: this is the inventory from the 7.x branch, as a lot of deprecations are only present on this branch and not on master, and I don't think we have a lot of deprecations on master that are not present in 7.x. However, that's each team's responsibility to properly also reverse-backport/apply their changes on master when necessary.

I did not include the deprecate('enabled', '8.0.0') config deprecations in the per-team list to avoid pinging unnecessary teams, as we know those are all critical.

@elastic/kibana-core

done in #115501

• /src/plugins/home/server/index.ts

• /src/plugins/newsfeed/server/index.ts

• /src/plugins/telemetry/server/config/config.ts

• /src/plugins/usage_collection/server/config.ts

• /x-pack/plugins/banners/server/config.ts

• /x-pack/plugins/licensing/server/licensing_config.ts

@elastic/kibana-stack-management

• /src/plugins/console/server/config.ts (183a1c3)

@elastic/kibana-app-services

• /src/plugins/data/server/index.ts

• /x-pack/plugins/reporting/server/config/index.ts ([Reporting] Add log level to config #118319)

@elastic/kibana-vis-editors

• /src/plugins/kibana_legacy/server/index.ts

• /src/plugins/vis_types/metric/server/index.ts

• /src/plugins/vis_types/table/server/index.ts

• /src/plugins/vis_types/tagcloud/server/index.ts

• /src/plugins/vis_types/timelion/server/index.ts

• /src/plugins/vis_types/timeseries/server/index.ts

• /src/plugins/vis_types/vega/server/index.ts

@elastic/kibana-presentation

• /src/plugins/vis_type_markdown/server/index.ts
  Done Adds level to vis_markdown deprecations #118389

@elastic/kibana-alerting-services

Done #115832

• /x-pack/plugins/actions/server/index.ts

• /x-pack/plugins/alerting/server/index.ts

• /x-pack/plugins/event_log/server/index.ts

• /x-pack/plugins/stack_alerts/server/index.ts

• /x-pack/plugins/task_manager/server/index.ts

• /x-pack/plugins/triggers_actions_ui/server/index.ts

@elastic/apm-ui

Done in #116272

• /x-pack/plugins/apm/server/index.ts

It already has a level

• /x-pack/plugins/apm/server/deprecations/index.ts

@elastic/security-threat-hunting (#118268)

• /x-pack/plugins/cases/server/index.ts

@elastic/kibana-security

• /x-pack/plugins/security/server/config_deprecations.ts (done via Update security deprecation messages #115241/[7.x] Update security deprecation messages (#115241) #115395 in 7.x/master)

• /x-pack/plugins/spaces/server/config.ts (done via [7.x] Update security deprecation messages (#115241) #115395 in 7.x only, no deprecations remaining in master)

@elastic/fleet

• /x-pack/plugins/fleet/server/index.ts

@elastic/kibana-gis

• /x-pack/plugins/maps/server/index.ts

@elastic/security-solution (#118268)

• /x-pack/plugins/security_solution/server/index.ts

@elastic/rac

• /x-pack/plugins/rule_registry/server/config.ts

List of deprecate('enabled', '8.0.0') deprecations

Only here for tracking purposes, if we eventually want to specify level: 'critical' on those:

cc @cjcenizal