轻松追踪 Amazon OpenSearch 服务配置变更的新可见性改进

由 Siddhant Gupta Deniz Ercelebi 和 Shashank Gupta 于 2024 年 2 月 6 日发布于 Amazon OpenSearch Service 和公告永久链接评论分享

关键要点

本文介绍了 Amazon OpenSearch 服务的新可见性改进，使得配置变更的追踪变得更加高效。这些改进包含更详细的配置状态，允许用户设置报警并用于自动化，从而减少人工监控。所有变更与旧版兼容，确保无缝过渡。

Amazon OpenSearch 服务提供多个域配置设置来满足特定工作负载的要求。作为标准服务操作的一部分，您可能需要定期更新这些配置设置。最近，Amazon OpenSearch 服务推出了可见性改进，使您能够更有效地跟踪配置变更。我们引入了更细致且更具描述性的配置状态，使您能够设置警报并进行自动化，以便减少人工监控的需求。

我们建议您在应用程序中充分利用这些可见性改进。这些更改是向后兼容的，如果您的自动化脚本依赖于旧版 processing 参数来确定配置变更状态，则它们仍应继续正常工作。为简化对多个正在进行的配置变更请求的追踪，Amazon OpenSearch 服务允许仅在域处理状态为 Active 时进行配置请求。更多细节请参考“单次配置变更”部分。

解决方案概述

早先，通过 OpenSearch 服务 API应用程序编程接口的 processing 参数以及 OpenSearch 服务控制台中的域状态字段，用户可以了解配置变更的状态。如今，我们已经引入以下变更以改善配置更新体验：

改进内容详细描述新增参数在 API 响应中引入了两个新参数 DomainProcessingStatus 和 ConfigChangeStatus，在控制台中也添加了域处理状态和配置变更状态字段。这些更改通过多个直观的状态提供了更好的可见性。之前的状态仅限于两个值：Active 和 Processing。配置对比轻松比较活动配置与正在进行的配置以获得更清晰的视图。过去需要多个步骤。单次请求限制允许同时进行单个配置变更请求。您可以在一次请求中组合多个域配置更改，但需要在上一个请求完成且域处理状态变为 Active 后才能提交下一个请求。取消请求功能在验证失败的情况下可以取消变更请求。之前，当实例不可用时，域仍处于 processing 状态。现在，如果遇到任何验证失败，您可以取消变更请求并在稍后重试。完成条件细化如果所有背景活动如 shard 移动完成，域处理状态才会变为 Active。这意味着您可以自信地在自动化脚本中使用新引入的状态，而无需推测所有内部处理是否已完成。

如何获得细致的配置更新状态？

作为近期改进的一部分，Amazon OpenSearch 服务在 API 中引入了 DomainProcessingStatus 和 ConfigChangeStatus 参数，以及控制台中相应的域处理状态和配置变更状态字段。您可以依赖这些状态在不同的配置变更场景中获取准确和一致的信息，无论是涉及蓝/绿色操作还是其他情况。让我们详细探索这些增强的可见性体验。

域处理状态可见性：您可以通过控制台中的域处理状态字段跟踪域级配置变更的状态。类似地，API 响应中包含 DomainProcessingStatus 参数。各状态及简要描述如下：Active：没有配置变更正在进行。您可以提交新的配置变更请求。Creating：新域创建正在进行。Modifying：当前正在进行一个或多个配置变更，如新数据节点的增加、亚马逊弹性块存储 (Amazon EBS) GP3 存储分配或 KMS 密钥设置等。通过 UpdateDomainConfig API 所做的更改将状态设置为 modifying。此状态涵盖了需要 shard 移动以完成配置更改的情况。注意：为了向后兼容，API 响应中 processing 参数的行为保持不变，一旦核心配置更改完成，便立即设置为 false，而不等待 shard 移动完成。Upgrading Engine Version 正在进行引擎版本升级，例如从 Elasticsearch 版本 79 升级到 OpenSearch 版本 10。Updating Service Software：此状态与服务软件更新相关的配置变更。Deleting：域删除正在进行。

Isolated：表示由于账户相关的计费问题或域未遵循关键安全补丁更新而被冻结的域。

配置变更状态可见性：配置变更可以由用户发起例如，新增数据节点、变更实例类型或由服务自动触发例如，自动调优和强制性服务软件更新。您可以通过控制台中的配置变更状态字段和 API 响应中的 ConfigChangeStatus 参数找到最新的状态详情。各状态及简要描述如下：

Pending：表示配置变更请求已提交。Initializing：服务正在初始化配置变更请求。Validating：服务正在验证请求的变更和所需资源。Validation Failed：请求的变更未通过验证。目前未应用任何配置更改。可能的验证失败原因包括域内存在红色索引、所选实例类型不可用以及磁盘空间不足。验证失败的潜在清单请查看此处。在验证失败事件中，您可以取消、重试或编辑配置变更。Awaiting user inputs：用户可以修改配置以修正验证错误的情形，例如无效的 KMS 密钥。在此状态下，用户可编辑配置变更。Applying changes：服务正在应用请求的配置变更。Cancelled：在验证失败状态下，您可以在控制台单击 Cancel 按钮或调用 CancelDomainConfigChange API。所有适用于变更请求的已应用更改将被回滚。Completed：请求的配置变更已成功完成。

控制台增强

Amazon OpenSearch 服务的控制台提供了跟踪配置变更进度的增强可见性。以下是一些屏幕截图，以展示这些改进。

每个域处理状态、配置变更状态和变更 ID 字段都在 Amazon OpenSearch 服务控制台中展示。注意：要了解与变更 ID 相关的变更详情，您可以使用 DescribeDomainChangeProgress API。

配置变更摘要。在域详情页面的集群配置标签下，您可以查看活动配置和请求更改的并列比较。待处理更改字段显示当前待处理属性的状态，不包括已应用的更改。您还可以通过 DescribeDomain 和 DescribeDomainConfig API 通过 ModifyingProperties 参数获取相似的信息。

在验证失败期间进行取消。在以下屏幕截图中，您可以看到在配置变更请求未通过验证时取消请求的新选项。例如，当您遇到 SubnetNotFound 错误时，可以使用 Cancel request 按钮回到以前的活动配置，修复问题后再重试配置更新。

轻舟加速器官网入口

单次配置变更

之前，在进行了多个请求时，追踪每个变更请求的成功与失败并不简单。为了提供简化的体验，OpenSearch 服务现在限制每次只能进行一次变更请求。在一次配置变更请求中，您可以同时打包多个更改。一旦提交了配置变更请求，必须在下一个配置变更请求之前完成当前请求。此简化的体验使得跟踪请求更改及其最新状态变得更加容易。如果您的自动化脚本编写为多次调用配置变更更新 API，则应更新为在单次更新调用中组合多个配置更改，或者在提交下一个配置变更请求之前等待单个更新完成。您可以在域处理状态变为 Active 时更新域配置。有关可能需要蓝/绿色部署的变化列表，请查看此处。

以下屏幕截图展示了一个在“编辑域”页面上的警报，提醒用户另一项变更或更新正在进行。OpenSearch 服务不再允许您提交新的配置更新请求，“应用变更”按钮在此变更完成之前会被禁用。

API 更改

您可以使用 DescribeDomain、DescribeDomainChangeProgress 和 DescribeDomainConfig API 获取详细的配置更新状态。此外，您还可以在验证失败的情况下调用 CancelDomainConfigChange 来取消变更请求。有关更多信息，您可以参考 Amazon OpenSearch 服务 API 文档这里。

结论

在本文中，我们向您展示了如何获取有关配置更新请求的细致信息。这些新引入的更改将帮助您更好地了解配置变更请求的进展，并轻松区分已应用的更改与待处理的更改。您需要确保在提交配置变更请求之前，DomainProcessingStatus 的处理状态值为 Active。在发生验证失败时能够取消更改，能让您更好地掌控域处理状态。访问产品文档了解更多信息。

关于作者

Siddhant Gupta 是亚马逊网络服务的高级技术产品经理，驻扎于印度海得拉巴。Siddhant 在亚马逊工作超过六年，目前与 OpenSearch 服务团队共同合作，参与新区域的发布、定价策略以及将 EC2 和 EBS 创新带给 OpenSearch 服务客户。他对分析和机器学习充满热情。在空闲时间，他喜欢旅游、健身、与家人共度时光以及阅读非小说类书籍。

Deniz Ercelebi 是亚马逊 OpenSearch 服务的高级用户体验设计师。在她的角色中，她对创建、实施和成功交付复杂问题的设计解决方案做出了贡献。她个人的动力源自对用户体验的热情、对以客户为中心解决方案的奉献以及对协作创新的坚定信念。

更轻松地跟踪 Amazon OpenSearch 服务配置更改，新增可见性改进大数据博客