Skip to content

Conversation

@nielsbauman
Copy link
Contributor

@nielsbauman nielsbauman commented Nov 26, 2024

The enrich cache size setting accidentally got renamed from enrich.cache_size to enrich.cache.size in #111412. This commit updates the enrich plugin to allow both names and deprecates the wrong one.

The enrich cache size setting accidentally got renamed from
`enrich.cache_size` to `enrich.cache.size` in elastic#111412. This commit
reverts that rename.

The fix that gets backported to 8.16, 8.17 and 8.x will allow both
versions, to avoid breaking BWC twice.
@nielsbauman nielsbauman added >bug :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP Team:Data Management Meta label for data/management team v9.0.0 labels Nov 26, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

@elasticsearchmachine
Copy link
Collaborator

Hi @nielsbauman, I've created a changelog YAML for you.

* This setting solely exists because the original setting was accidentally renamed in
* https://github.com/elastic/elasticsearch/pull/111412.
*/
@UpdateForV10(owner = UpdateForV10.Owner.DATA_MANAGEMENT)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are the Settings.Property.Deprecated below and this @Update too soon?

Copy link
Member

Choose a reason for hiding this comment

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

I think the @UpdateForV10 is fine, but the deprecated thing I'm not sure about yet. What I don't like about it here is that we can't redirect users back to the setting they should be using (cache_size). Perhaps it'd be worth adding it into the constructor rather than the setting itself? Both is probably fine (the annotation would let us see it in the migration APIs I think)

@nielsbauman nielsbauman requested a review from dakrone November 27, 2024 11:51
Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

LGTM, I left one more comment, I also think we should put a deprecation log message if the BWC name is used that points the user to the non-deprecated version (otherwise we just say "this is deprecated" without telling the user how to fix it)

@nielsbauman nielsbauman added v8.16.2 v8.17.1 v8.18.0 auto-backport Automatically create backport pull requests when merged labels Dec 6, 2024
@nielsbauman nielsbauman requested a review from dakrone December 9, 2024 15:28
Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

LGTM, I left one more comment (hopefully not hard?)

@nielsbauman nielsbauman enabled auto-merge (squash) December 9, 2024 15:38
@nielsbauman nielsbauman merged commit 4b868b0 into elastic:main Dec 9, 2024
15 checks passed
@nielsbauman nielsbauman deleted the enrich-fix-main branch December 9, 2024 16:57
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.16
8.17
8.x

nielsbauman added a commit to nielsbauman/elasticsearch that referenced this pull request Dec 9, 2024
The enrich cache size setting accidentally got renamed from
`enrich.cache_size` to `enrich.cache.size` in elastic#111412. This commit
updates the enrich plugin to accept both names and deprecates the
wrong name.
nielsbauman added a commit to nielsbauman/elasticsearch that referenced this pull request Dec 9, 2024
The enrich cache size setting accidentally got renamed from
`enrich.cache_size` to `enrich.cache.size` in elastic#111412. This commit
updates the enrich plugin to accept both names and deprecates the
wrong name.
nielsbauman added a commit to nielsbauman/elasticsearch that referenced this pull request Dec 9, 2024
The enrich cache size setting accidentally got renamed from
`enrich.cache_size` to `enrich.cache.size` in elastic#111412. This commit
updates the enrich plugin to accept both names and deprecates the
wrong name.
elasticsearchmachine pushed a commit that referenced this pull request Dec 9, 2024
* Fix enrich cache size setting name (#117575)

The enrich cache size setting accidentally got renamed from
`enrich.cache_size` to `enrich.cache.size` in #111412. This commit
updates the enrich plugin to accept both names and deprecates the
wrong name.

* Remove `UpdateForV10` annotation
elasticsearchmachine pushed a commit that referenced this pull request Dec 9, 2024
* Fix enrich cache size setting name (#117575)

The enrich cache size setting accidentally got renamed from
`enrich.cache_size` to `enrich.cache.size` in #111412. This commit
updates the enrich plugin to accept both names and deprecates the
wrong name.

* Remove `UpdateForV10` annotation
elasticsearchmachine pushed a commit that referenced this pull request Dec 9, 2024
* Fix enrich cache size setting name (#117575)

The enrich cache size setting accidentally got renamed from
`enrich.cache_size` to `enrich.cache.size` in #111412. This commit
updates the enrich plugin to accept both names and deprecates the
wrong name.

* Remove `UpdateForV10` annotation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Automatically create backport pull requests when merged >bug :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP Team:Data Management Meta label for data/management team v8.16.2 v8.17.1 v8.18.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants