Monitor Amazon OpenSearch Service configuration adjustments extra simply with new visibility enhancements

Amazon OpenSearch Service affords a number of area configuration settings to fulfill your workload-specific necessities. As a part of customary service operations, it’s possible you’ll be required to replace these configuration settings regularly. Not too long ago, Amazon OpenSearch Service launched visibility enhancements that permit you to observe configuration adjustments extra successfully. We’ve launched granular and extra descriptive configuration statuses that allow you to arrange alarms and use them in automation to reduce guide monitoring.

We advocate that you simply benefit from these visibility enhancements in your functions. These adjustments are backward appropriate, and in case your automations depend on the legacy processing parameter to find out configuration change standing, then they need to nonetheless proceed to work with none disruption. To simplify monitoring of a number of in-flight configuration change requests, Amazon OpenSearch Service permits configuration request solely when Area Processing Standing is Lively. Further particulars are in part ‘Single configuration change at a time’.

Answer overview

Earlier, configuration change standing visibility was accessible by processing parameters within the OpenSearch Service APIs (Utility Programming Interface), and as a Area Standing subject within the OpenSearch Service console. We now have now launched the next adjustments to enhance the configuration replace expertise:

  • Launched two new parameters, DomainProcessingStatus and ConfigChangeStatus, within the API responses. Equally, added Area Processing Standing and Configuration Change Standing fields within the console. These adjustments present higher visibility by a number of, intuitive statuses. Earlier statuses had been restricted to solely two values: Lively and Processing.
  • Capacity to simply examine lively and in-flight configurations for readability. Earlier, it required a number of steps.
  • Amazon OpenSearch Service has now adopted the method of permitting a single configuration change request at a time. There isn’t a restrict on the variety of area configuration adjustments you possibly can bundle in a single request. Nevertheless, you possibly can submit the subsequent configuration request when the earlier request is full and the area processing standing turns into Lively. This enchancment streamlines configuration updates and addresses earlier challenges of monitoring a number of, in-flight configuration change requests.
  • Capacity to cancel a change request in case of a validation failure. Beforehand, when situations had been unavailable, domains remained in processing state. Now, upon encountering any validation failure, you possibly can cancel the change request and retry after a while.
  • Area processing standing turns to Lively solely after all of the background actions, together with shard motion is full. This implies which you can confidently use newly launched statuses in your automation scripts while not having to deduce if all the inner processes, resembling knowledge motion, are full.

How do you get granular particulars to trace the configuration replace standing?

As a part of latest enhancements, Amazon OpenSearch Service launched DomainProcessingStatus and ConfigChangeStatus parameters within the APIs together with the respective Area Processing Standing and Configuration Change Standing fields within the console. You’ll be able to depend on these statuses to get correct and constant info throughout totally different configuration change eventualities, like when configuration adjustments contain blue/inexperienced operations or with out blue/inexperienced operations, and when configuration adjustments are triggered by the operator or by the OpenSearch Service. Allow us to discover these enhanced visibility experiences.

  1. Area processing standing visibility: You’ll be able to observe the staus of domain-level configuration adjustments by the Area Processing Standing subject within the console. Equally, API responses embody the DomainProcessingStatus parameter. The values and a short description are supplied within the following particulars:
    1. Lively: No configuration change is in progress. You’ll be able to submit a brand new configuration change request.
    2. Creating: New area creation is in progress.
    3. Modifying: This standing signifies that a number of configuration adjustments, resembling new knowledge node addition, Amazon Elastic Block Retailer (Amazon EBS) GP3 storage provisioning, or organising KMS keys, are in progress. In different phrases, adjustments made by the UpdateDomainConfig API, set the standing to modifying. The ‘Modifying’ standing additionally covers conditions the place domains require shard motion to finish configuration adjustments. Notice: For backward compatibility, we’ve saved the conduct of the processing parameter unchanged within the API responses, and it’s set to false as quickly because the core configuration adjustments are full, with out ready for shard motion completion.
    4. Upgrading Engine Model: Engine model upgrades are in progress, resembling from Elasticsearch model 7.9 to OpenSearch model 1.0.
    5. Updating Service Software program: This standing refers to configuration adjustments associated to service software program updates.
    6. Deleting: Area deletion is progressing.
    7. Remoted: This represents domains which might be suspended resulting from quite a lot of causes, resembling account-related billing points or domains that aren’t compliant with vital safety patch updates.
  2. Configuration change standing visibility: Configuration adjustments might be initiated by the person (e.g., new knowledge node addition, occasion sort change) or by the Service (e.g., AutoTune and necessary service software program updates). You will discover the newest standing particulars by Configuration Change Standing subject within the console, and thru the ConfigChangeStatus parameter in API responses. Beneath are the values and a short description:
    1. Pending: Signifies {that a} configuration change request has been submitted.
    2. Initializing: Service is initializing a configuration change request.
    3. Validating: Service is validating the requested adjustments and sources required.
    4. Validation Failed: Requested adjustments failed validation. At this level, no configuration adjustments are utilized. Some potential validation failures might be the presence of pink indices within the area, unavailability of a selected occasion sort, and low disk area. Right here is an inventory of potential validation failures. Throughout a validation failure occasion, you possibly can cancel, retry, or edit configuration adjustments.
    5. Awaiting person inputs: Situations the place person could possibly repair validation errors resembling invalid KMS key. At this standing, person can edit the configuration adjustments.
    6. Making use of adjustments: Service is making use of requested configuration adjustments.
    7. Cancelled: Throughout validation failed standing, you possibly can both click on on the Cancel button within the console or name the CancelDomainConfigChange API. All of the utilized adjustments that had been a part of the change request might be rolled again.
    8. Accomplished: Requested configuration adjustments have been efficiently accomplished.

Console enhancements

The Amazon OpenSearch Service console affords enhanced visibility to trace configuration change progress. Beneath are a couple of screenshots to present you an concept of those enhancements.

  • Amazon OpenSearch Service console offers Area Processing Standing, Configuration Change Standing, and Change ID fields. Notice: To know the change particulars related to the Change ID, you should use the DescribeDomainChangeProgress API.

  • Configuration change abstract. To see a aspect by aspect comparability of your lively configurations and requested adjustments, on the area element web page, navigate to the cluster configuration tab, scroll right down to the configuration change abstract part. Pending Modifications subject exhibits the standing of the pending properties at the moment and doesn’t embody adjustments which were utilized. You can even get related particulars from the DescribeDomain and DescribeDomainConfig APIs by theModifyingProperties parameter.

Cancelling throughout validation failure. Within the beneath screenshots, you possibly can see a brand new choice to cancel a change request when a configuration change request fails validations. For instance, once you encounter SubnetNotFound error, you should use the Cancel request button to roll again to the earlier lively configuration, repair the difficulty after which retry the configuration replace.

Single configuration change at a time

Beforehand, it was not easy to trace the success and failure of particular person change requests, when a number of requests had been made. To supply a simplified expertise, OpenSearch Service now limits you to solely a single change request at a time. In a single configuration change request, you possibly can bundle a number of adjustments without delay. As soon as a configuration change request is submitted, it have to be accomplished earlier than you possibly can request the subsequent configuration change by the console, or by the UpdateDomainConfig API. This simplified expertise makes it simpler to maintain observe of adjustments which were requested and their most up-to-date standing. In case your automation is written to name configuration change replace APIs a number of instances, then it ought to be up to date to group a number of configuration adjustments in a single replace name, or anticipate particular person updates to finish earlier than you submit the subsequent configuration change. You’ll be able to replace area configuration when area processing standing turns into lively. For an inventory of adjustments that may want a blue/inexperienced deployment, please see right here.

The beneath screenshot exhibits an instance alert on the ‘Edit area’ web page informing the person that one other change or replace is in progress. OpenSearch Service now not lets you submit new configuration replace requests, and the ‘Apply change’ button is disabled till the change in progress is accomplished.

API adjustments

You should use the DescribeDomain, DescribeDomainChangeProgress, and DescribeDomainConfig APIs to get detailed configuration replace statuses. As well as, you should use CancelDomainConfigChange to cancel the change request within the occasion of a validation failures. You’ll be able to refer Amazon OpenSearch Service API documentation right here.


On this publish, we confirmed you the right way to get granular details about a configuration replace request. These newly launched adjustments will enable you to achieve higher visibility into the progress of configuration change requests, and simply distinguish between utilized adjustments and pending ones. It’s worthwhile to be certain that the DomainProcessingStatus processing standing worth is Lively earlier than submitting configuration change requests. The flexibility to cancel adjustments within the occasion of validation failures offers you higher management in getting your area out of processing state in a self-service method. Go to product documentation to study extra.

In regards to the Authors

Siddhant Gupta is a Sr. Technical Product Supervisor at Amazon Internet Providers primarily based in Hyderabad, India. Siddhant has been with Amazon for over six years and is at present working with the OpenSearch Service group, serving to with new area launches, pricing technique, and bringing EC2 and EBS improvements to OpenSearch Service clients. He’s enthusiastic about analytics and machine studying. In his free time, he loves touring, health actions, spending time along with his household and studying non-fiction books.

Deniz Ercelebi is a Sr. UX Designer at Amazon OpenSearch Service. In her function she contributes to the creation, implementation, and profitable supply of design options for complicated issues. Her private drive is fueled by a ardour for person expertise, a dedication to customer-centric options, and a agency perception in collaborative innovation.

Shashank Gupta is a Sr. Software program Developer at Amazon OpenSearch Service, specializing within the enhancement of the Managed service facet of the platform. His main focus is on optimizing the managed expertise, spanning from the console to APIs and useful resource provisioning in an environment friendly method. With a devoted dedication to innovation, Shashank goals to raise the general buyer expertise by introducing ingenious options throughout the service.

Related Articles


Please enter your comment!
Please enter your name here

Latest Articles