Add deprecation info API entries for deprecated monitoring settings #78799

jbaiera · 2021-10-06T22:01:31Z

Recently we have deprecated a number of settings in monitoring. These settings should be represented in the deprecation info API. This PR will be backported with some minor changes to the 7.x branch so that we can start the deprecation process in that release cycle.

Related issues:
#77659
#78564

…ettings

elasticmachine · 2021-10-06T22:01:35Z

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

jrodewig · 2021-10-07T17:33:17Z

Tagging @debadair as she's working on best practices for the deprecation API messages.

Thanks for ensuring these deprecations get added, @jbaiera. However, I'm confused about why this PR targets master. Shouldn't the deprecations only apply to 7.x branches?

danhermann · 2021-10-07T18:30:04Z

Thanks for ensuring these deprecations get added, @jbaiera. However, I'm confused about why this PR targets master. Shouldn't the deprecations only apply to 7.x branches?

We typically target the master branch for deprecations and then backport to the branch where the deprecation will first take effect. In some cases, the deprecated feature will then be removed from the master branch but we're increasingly using longer deprecation periods in which case the deprecated feature will remain deprecated even in the master branch.

danhermann

Code changes LGTM

jrodewig · 2021-10-07T18:32:26Z

Thanks for the explanation @danhermann.

jrodewig

Thanks again @jbaiera. I'll leave final docs approval to @debadair. I think there's an opportunity to improve the boilerplate text here, but she's in a better position to judge that.

Otherwise, I think we need to remove the new sentence from the breaking changes docs.

docs/reference/migration/migrate_8_0/monitoring.asciidoc

...eprecation/src/test/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecksTests.java

docs/reference/migration/migrate_8_0/monitoring.asciidoc

debadair

I agree with the patterns James suggested for the case where there are multiple settings. Had one question about the breaking changes entry--it contradicts itself. :-)

...eprecation/src/test/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecksTests.java

debadair · 2021-10-11T23:34:15Z

docs/reference/migration/migrate_8_0/monitoring.asciidoc

-The `xpack.monitoring.exporters.*.use_ingest` property was deprecated in 7.16.0 and
-has been removed. This parameter controlled the creation of pipelines for monitoring
-indices that previously had no function.
+The `xpack.monitoring.exporters.*.use_ingest` property was deprecated in 7.16.0. This


Is this setting going to be removed in 8.0, or after 8.0? The entry says it's removed, the Details say it will be removed. If it's only deprecated, I don't think we should include it in the breaking changes.

We have similar ambiguous documentation of "index.template.create_legacy_templates" (a deprecation info message for it was added in this PR, but the documentation has been ambiguous for a while).

I updated the header text. A lot of this is all messed up because we made a recent course correction to not remove these settings in 8.0. So much copy pasta to clean up.

If they are going to remain deprecated, I think we can just doc them as deprecated in 7.16 and omit them from the 8.0 breaking changes. The typical pattern is to only include newly-deprecated things, not repeat everything that's been previously deprecated.

If they are going to remain deprecated, I think we can just doc them as deprecated in 7.16 and omit them from the 8.0 breaking changes.

+1. Let's remove these from 8.0. However, we'll still need to update the 7.16 deprecation docs to remove references to an 8.0 removal.

masseyke

Looks good to me, although I share @debadair's slight confusion about the documentation.

masseyke · 2021-10-14T20:20:38Z

docs/reference/migration/migrate_8_0/monitoring.asciidoc

-The `xpack.monitoring.exporters.*.use_ingest` property was deprecated in 7.16.0 and
-has been removed. This parameter controlled the creation of pipelines for monitoring
-indices that previously had no function.
+The `xpack.monitoring.exporters.*.use_ingest` property was deprecated in 7.16.0. This


We have similar ambiguous documentation of "index.template.create_legacy_templates" (a deprecation info message for it was added in this PR, but the documentation has been ambiguous for a while).

jrodewig

The deprecation info API changes LGTM. However, as @debadair pointed out, we should remove the 8.0 breaking changes docs. Instead, we should update the 7.16 deprecations to update any 8.0 removal references, probably as a separate PR.

jrodewig

LGTM. Thanks for removing the docs.

jbaiera · 2021-10-19T14:56:24Z

@elasticmachine update branch

…ings elastic#78799

* upstream/master: (24 commits) Implement framework for migrating system indices (elastic#78951) Improve transient settings deprecation message (elastic#79504) Remove getValue and getValues from Field (elastic#79516) Store Template's mappings as bytes for disk serialization (elastic#78746) [ML] Add queue_capacity setting to start deployment API (elastic#79433) [ML] muting rest compat test issue elastic#79518 (elastic#79519) Avoid redundant available indices check (elastic#76540) Re-enable BWC tests TEST Ensure password 14 chars length on Kerberos FIPS tests (elastic#79496) [DOCS] Temporarily remove APM links (elastic#79411) Fix CCSDuelIT for skipped shards (elastic#79490) Add other time accounting in HotThreads (elastic#79392) Add deprecation info API entries for deprecated monitoring settings (elastic#78799) Add note in breaking changes for nameid_format (elastic#77785) Use 'migration' instead of 'upgrade' in GET system feature migration status responses (elastic#79302) Upgrade lucene version 8b68bf60c98 (elastic#79461) Use Strings#EMPTY_ARRAY (elastic#79452) Quicker shared cache file preallocation (elastic#79447) [ML] Removing some code that's obsolete for 8.0 (elastic#79444) Ensure indexing_data CCR requests are compressed (elastic#79413) ...

…ings #78799 (#79527)

Add deprecation info API entries for recently deprecated monitoring s…

6ee6c87

…ettings

jbaiera added >deprecation :Data Management/Monitoring labels Oct 6, 2021

jbaiera requested review from masseyke and danhermann October 6, 2021 22:01

elasticmachine added the Team:Data Management Meta label for data/management team label Oct 6, 2021

elasticsearchmachine added the v8.0.0 label Oct 6, 2021

Appease the precommit beast

1ffe262

jbaiera requested a review from jrodewig October 6, 2021 22:22

jrodewig requested a review from debadair October 7, 2021 17:33

danhermann approved these changes Oct 7, 2021

View reviewed changes

jrodewig reviewed Oct 7, 2021

View reviewed changes

Some docs changes on PR feedback

3260661

jrodewig reviewed Oct 7, 2021

View reviewed changes

docs/reference/migration/migrate_8_0/monitoring.asciidoc Outdated Show resolved Hide resolved

debadair reviewed Oct 11, 2021

View reviewed changes

masseyke reviewed Oct 14, 2021

View reviewed changes

jbaiera added 4 commits October 18, 2021 15:42

Fix conflicting header sentences.

a09926f

Update remediation language.

ac9e4ad

Update message detail wording

7391233

Merge branch 'master' into monitoring-deprecation-info-additions

619a4fe

jbaiera requested review from jrodewig, debadair and masseyke October 18, 2021 19:52

jrodewig suggested changes Oct 19, 2021

View reviewed changes

jbaiera mentioned this pull request Oct 19, 2021

Stack monitoring changes for Elasticsearch #50770

Closed

14 tasks

Remove the monitoring migration docs.

62baf3c

jrodewig approved these changes Oct 19, 2021

View reviewed changes

Merge branch 'master' into monitoring-deprecation-info-additions

87855ff

jbaiera merged commit ceaf53c into elastic:master Oct 19, 2021

jbaiera deleted the monitoring-deprecation-info-additions branch October 19, 2021 16:50

jbaiera added a commit to jbaiera/elasticsearch that referenced this pull request Oct 20, 2021

[7.x] Add deprecation info API entries for deprecated monitoring sett…

eac6fa1

…ings elastic#78799

jbaiera mentioned this pull request Oct 20, 2021

[7.x] Add deprecation info API entries for deprecated monitoring settings #78799 #79527

Merged

jbaiera added a commit that referenced this pull request Oct 20, 2021

[7.x] Add deprecation info API entries for deprecated monitoring sett…

0552802

…ings #78799 (#79527)

jakelandis added v8.0.0-beta1 and removed v8.0.0 labels Oct 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add deprecation info API entries for deprecated monitoring settings #78799

Add deprecation info API entries for deprecated monitoring settings #78799

jbaiera commented Oct 6, 2021

elasticmachine commented Oct 6, 2021

jrodewig commented Oct 7, 2021

danhermann commented Oct 7, 2021

danhermann left a comment

jrodewig commented Oct 7, 2021

jrodewig left a comment •

edited

Loading

debadair left a comment

debadair Oct 11, 2021

masseyke Oct 14, 2021

jbaiera Oct 18, 2021

debadair Oct 18, 2021

jrodewig Oct 19, 2021 •

edited

Loading

masseyke left a comment

masseyke Oct 14, 2021

jrodewig left a comment •

edited

Loading

jrodewig left a comment

jbaiera commented Oct 19, 2021

Add deprecation info API entries for deprecated monitoring settings #78799

Add deprecation info API entries for deprecated monitoring settings #78799

Conversation

jbaiera commented Oct 6, 2021

elasticmachine commented Oct 6, 2021

jrodewig commented Oct 7, 2021

danhermann commented Oct 7, 2021

danhermann left a comment

Choose a reason for hiding this comment

jrodewig commented Oct 7, 2021

jrodewig left a comment • edited Loading

Choose a reason for hiding this comment

debadair left a comment

Choose a reason for hiding this comment

debadair Oct 11, 2021

Choose a reason for hiding this comment

masseyke Oct 14, 2021

Choose a reason for hiding this comment

jbaiera Oct 18, 2021

Choose a reason for hiding this comment

debadair Oct 18, 2021

Choose a reason for hiding this comment

jrodewig Oct 19, 2021 • edited Loading

Choose a reason for hiding this comment

masseyke left a comment

Choose a reason for hiding this comment

masseyke Oct 14, 2021

Choose a reason for hiding this comment

jrodewig left a comment • edited Loading

Choose a reason for hiding this comment

jrodewig left a comment

Choose a reason for hiding this comment

jbaiera commented Oct 19, 2021

jrodewig left a comment •

edited

Loading

jrodewig Oct 19, 2021 •

edited

Loading

jrodewig left a comment •

edited

Loading