AWS opensearch-service documentation change
Summary
Updated documentation to reflect new ways to access Cluster Insights through Console and OpenSearch UI, added new sections for console access and EventBridge integration, and renumbered screenshots.
Security assessment
The changes are purely documentation updates about feature accessibility and monitoring capabilities. There is no mention of security vulnerabilities, patches, or security-related configurations. The addition of EventBridge for monitoring insights is an operational feature enhancement, not a security feature.
Diff
diff --git a/opensearch-service/latest/developerguide/cluster-insights.md b/opensearch-service/latest/developerguide/cluster-insights.md index 5e0156c61..3ce09e66c 100644 --- a//opensearch-service/latest/developerguide/cluster-insights.md +++ b//opensearch-service/latest/developerguide/cluster-insights.md @@ -5 +5 @@ -BenefitsCreate and configure an OpenSearch application to view Cluster InsightsCreate and configure an application to view Cluster InsightsUnderstanding Cluster Insights +BenefitsAccess Cluster Insights through ConsoleAccess Cluster Insights and detailed metrics through OpenSearch UICreate and configure an application to view Cluster InsightsUnderstanding Cluster Insights @@ -32 +32,9 @@ With Cluster Insights, you can maintain optimal cluster performance, reduce oper -## Create and configure an OpenSearch application to view Cluster Insights +## Access Cluster Insights through Console + +Review performance and resilience recommendations and make necessary configuration changes, all within the same Console. In the Console, under the **Cluster health** tab, you can access Cluster Insights that lists all the active Insights. Click on any Insight to view the recommendations. + +Screen-1: Cluster Insights under the Cluster Health tab + + + +## Access Cluster Insights and detailed metrics through OpenSearch UI @@ -57 +65 @@ Accessing Cluster Insights requires an administrative role in the OpenSearch UI -Screen-1: Access Data Administrator from OpenSearch UI +Screen-2: Access Data Administrator from OpenSearch UI @@ -61 +69 @@ Screen-1: Access Data Administrator from OpenSearch UI -Screen-2: Cluster Insights under the Manage data section +Screen-3: Cluster Insights under the Manage data section @@ -73 +81 @@ The **Cluster Insights Overview** page, as shown in the following screenshot, pr -Screen-3: Cluster Insights landing page in OpenSearch UI application. +Screen-4: Cluster Insights landing page in OpenSearch UI application. @@ -137 +145 @@ A table lists recent insights generated for the cluster, with the same detailed -Screen-4: Cluster Health overview provides key metrics, best practices, and Insights +Screen-5: Cluster Health overview provides key metrics, best practices, and Insights @@ -143 +151 @@ When you click on any insights, you can see details and impacted resources, reco -Screen-5: Insight details. Provides you details, recommendations, and historical timeline. +Screen-6: Insight details. Provides you details, recommendations, and historical timeline. @@ -177 +185 @@ The **Node** , **Index** , and **Shard views** use OpenSearch stats to provide d -Screen-6: Node, Index, and Shard level metrics +Screen-7: Node, Index, and Shard level metrics @@ -236 +244 @@ Double-click any query to see: -Screen-7: In-flight live view. You can also view Top-N queries +Screen-8: In-flight live view. You can also view Top-N queries @@ -239,0 +248,4 @@ Screen-7: In-flight live view. You can also view Top-N queries +### Access Insights through Amazon EventBridge events + +You can monitor insights through Amazon EventBridge events. For additional details check [notifications](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-notifications.html). +