Skip to content

Improve deprecation message for settings #79666

@jakelandis

Description

@jakelandis

Currently all settings if deprecated logs the following message

         String message = "[{}] setting was deprecated in Elasticsearch and will be removed in a future release! "
                    + "See the breaking changes documentation for the next major version.";

With #79665 some settings will be reduced to warning severity and as such message may not make as much sense (why looking at breaking changes if nothing is breaking). Additionally, it would be nice we we could steer people directly to the documentation. Especially since as of #79035 the deprecation logs will be indexed by default and exposed via the Upgrade Assistant. (@cjcenizal - do you know if http:// text in the deprecated logs will be rendered as clickable links ?)

This issue is to discuss changing the deprecation message to better allow for better wording for non-breaking changes (warnings) as well as any improvements we can make to the existing message for breaking changes. There are literally hundreds of deprecated settings in 7.16, so anything we can do to help the user make sense with what to do with these is helpful. (Note - many/most of these deprecated settings also have an entry in the deprecation info API too with a dedicated URL link).

cc: @debadair @lockewritesdocs @jrodewig @rjernst @masseyke @colings86

Metadata

Metadata

Assignees

No one assigned

    Labels

    :Core/Infra/SettingsSettings infrastructure and APIs>docsGeneral docs changesTeam:Core/InfraMeta label for core/infra teamTeam:DocsMeta label for docs team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions