From 0c7b0038d5d323d409f57e26003a3376e3f2f242 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Fri, 14 Nov 2025 17:54:20 -0500 Subject: [PATCH 1/5] media descriptions --- deploy-manage/monitor/autoops.md | 3 ++- deploy-manage/monitor/autoops/ec-autoops-deployment-view.md | 6 ++++-- deploy-manage/monitor/autoops/ec-autoops-event-settings.md | 6 ++++-- deploy-manage/monitor/autoops/ec-autoops-events.md | 3 ++- deploy-manage/monitor/autoops/ec-autoops-how-to-access.md | 2 +- deploy-manage/monitor/autoops/ec-autoops-index-view.md | 3 ++- deploy-manage/monitor/autoops/ec-autoops-nodes-view.md | 3 ++- deploy-manage/monitor/autoops/ec-autoops-overview-view.md | 3 ++- deploy-manage/monitor/autoops/ec-autoops-shards-view.md | 3 ++- .../monitor/autoops/ec-autoops-template-optimizer.md | 3 ++- 10 files changed, 23 insertions(+), 12 deletions(-) diff --git a/deploy-manage/monitor/autoops.md b/deploy-manage/monitor/autoops.md index b7d8a7b343..c211e5d620 100644 --- a/deploy-manage/monitor/autoops.md +++ b/deploy-manage/monitor/autoops.md @@ -19,7 +19,8 @@ products: AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing root-cause analysis and accurate resolution paths. With AutoOps, customers can prevent and resolve issues, cut down administration time, and optimize resource utilization. :::{image} /deploy-manage/images/cloud-autoops-overview-page.png -:alt: The Overview page +:screenshot: +:alt: Screenshot showing the Overview page in AutoOps ::: diff --git a/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md b/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md index ea10c43f43..521fca3be5 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md @@ -40,7 +40,8 @@ The **Events History** panel lists events that happened at some point and that h The **Resources** panel provides a quick overview of {{es}} cluster resource usage. The resources are presented based on their respective data tiers and include JVM memory usage, CPU usage, and storage usage over time. You can view essential cluster information such as the {{es}} version, total number of nodes, total number of shards, and total volume of used storage. :::{image} /deploy-manage/images/cloud-autoops-deployment-resources.png -:alt: The AutoOps Resources panel +:screenshot: +:alt: Screenshot showing the Resources panel in the AutoOps Deployment or Cluster view ::: @@ -49,7 +50,8 @@ The **Resources** panel provides a quick overview of {{es}} cluster resource usa The **Performance** panel shows key performance metrics, aggregated at both the cluster level and the selected tier levels: :::{image} /deploy-manage/images/cloud-autoops-deployment-performance.png -:alt: The AutoOps Deployment Performance +:screenshot: +:alt: Screenshot showing the Performance panel in the AutoOps Deployment or Cluster view ::: * **Search rate**: The number of search requests executed per second across all shards in the deployment or cluster, as well as within the selected data tiers. diff --git a/deploy-manage/monitor/autoops/ec-autoops-event-settings.md b/deploy-manage/monitor/autoops/ec-autoops-event-settings.md index de17a71aaa..46b32336fe 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-event-settings.md +++ b/deploy-manage/monitor/autoops/ec-autoops-event-settings.md @@ -31,7 +31,8 @@ The event settings include: * Data roles tier to exclude from indications - Add threshold based on the type of data tier. :::{image} /deploy-manage/images/cloud-autoops-event-settings.png -:alt: Event settings +:screenshot: +:alt: Screenshot showing the Event Settings dialogue in AutoOps ::: @@ -42,6 +43,7 @@ The **Event Settings** report provides a list of all the events for which the se From the **Event Settings** report, you can click **Add** to add new settings, or select the edit icon to modify the existing settings. :::{image} /deploy-manage/images/cloud-autoops-events-settings-report.png -:alt: Event settings report +:screenshot: +:alt: Screenshot showing the Event Settings page with the Add button ::: diff --git a/deploy-manage/monitor/autoops/ec-autoops-events.md b/deploy-manage/monitor/autoops/ec-autoops-events.md index aa89b43d5b..155effbfe6 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-events.md +++ b/deploy-manage/monitor/autoops/ec-autoops-events.md @@ -27,7 +27,8 @@ You can view events on the **Deployment** page (for {{ECH}} deployments) or the When you select an event, a flyout appears with insights and context for the detected issue. :::{image} /deploy-manage/images/cloud-autoops-events.png -:alt: AutoOps events +:screenshot: +:alt: Screenshot showing an AutoOps event flyout ::: The following table describes the sections in this flyout: diff --git a/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md b/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md index 55e4f185f1..a0ffc63d75 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md +++ b/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md @@ -23,5 +23,5 @@ To access AutoOps from your {{ecloud}} console, follow these steps: :::{image} /deploy-manage/images/cloud-autoops-how-to-access.png :screenshot: -:alt: Screenshot showing the Open AutoOps button +:alt: Screenshot showing the Open AutoOps button on the deployment overview page ::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/ec-autoops-index-view.md b/deploy-manage/monitor/autoops/ec-autoops-index-view.md index 124d41de3d..359a5a50eb 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-index-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-index-view.md @@ -19,7 +19,8 @@ products: The **Indices** view provides detailed statistics for each {{es}} index in your deployment. :::{image} /deploy-manage/images/cloud-autoops-index-view.png -:alt: The Indices view +:screenshot: +:alt: Screenshot showing the Indices view in AutoOps ::: The **Indices** view is essential for monitoring {{es}} indices, and offers comprehensive insights at a glance by displaying a clear and informative table about the following metrics: diff --git a/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md b/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md index 9286318ce6..6205221da6 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md @@ -19,7 +19,8 @@ products: The **Nodes** view provides a thorough overview on the essential metrics for all monitored nodes. You can delve into specific nodes to observe metrics over extended periods. This includes data on the indexing rate and latency, search rate and latency, as well as details concerning thread pools, data, circuit breakers, network, disk, and additional elements. :::{image} /deploy-manage/images/cloud-autoops-node-view.png -:alt: The Node view +:screenshot: +:alt: Screenshot showing the Nodes view in AutoOps ::: Similar to the **Deployment** or **Cluster** view, the list of open events is sorted by severity and open time. diff --git a/deploy-manage/monitor/autoops/ec-autoops-overview-view.md b/deploy-manage/monitor/autoops/ec-autoops-overview-view.md index 2aef418dc6..776ee3c015 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-overview-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-overview-view.md @@ -19,7 +19,8 @@ products: The **Overview** page displays the current status of customer deployments and clusters that are linked to the same Elastic organization. :::{image} /deploy-manage/images/cloud-autoops-overview-page.png -:alt: The Overview page +:screenshot: +:alt: Screenshot showing the Overview in AutoOps ::: ::::{note} diff --git a/deploy-manage/monitor/autoops/ec-autoops-shards-view.md b/deploy-manage/monitor/autoops/ec-autoops-shards-view.md index c900e3569a..bb7d5fc969 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-shards-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-shards-view.md @@ -19,7 +19,8 @@ products: The **Shards** view allows you to manage and monitor shards allocated to each node, ensuring optimal performance and reliability of your search and indexing operations. :::{image} /deploy-manage/images/cloud-autoops-shard-view.png -:alt: The Shards view +:screenshot: +:alt: Screenshot showing the Shards view in AutoOps ::: The **Shards** view provides: diff --git a/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md b/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md index 3b1ca78fc5..946895f4a6 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md +++ b/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md @@ -19,7 +19,8 @@ products: The **Template Optimizer** view offers detailed recommendations for optimizing templates. :::{image} /deploy-manage/images/cloud-autoops-template-optimizer.png -:alt: The Template Optimizer view +:screenshot: +:alt: Screenshot showing the Template Optimizer view in AutoOps ::: When AutoOps identifies a recommended change, it logs the template separately, allowing you to track past impactful changes. You can navigate between different deployments/clusters to view all template recommendations. From 0acd1c8238bba2a4081e8911c4b8ee174e4419eb Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Sat, 15 Nov 2025 21:45:04 -0500 Subject: [PATCH 2/5] fine-tune macos install --- .../autoops/cc-connect-self-managed-to-autoops.md | 4 ++++ deploy-manage/monitor/autoops/ec-autoops-faq.md | 14 +++++++------- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 6bef69f320..4c22d15d80 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -102,6 +102,10 @@ Select one of the following methods to install {{agent}}: * **Windows** --> +:::{note} +macOS is not a supported platform for installing {{agent}} to connect to AutoOps in a self-managed production environment. However, you can use macOS to [connect your local development cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md). +::: + :::{important} Using AutoOps for your ECE, ECK, and self-managed clusters requires a new, dedicated {{agent}}. You must install an agent even if you already have an existing one for other purposes. ::: diff --git a/deploy-manage/monitor/autoops/ec-autoops-faq.md b/deploy-manage/monitor/autoops/ec-autoops-faq.md index 16bae9368a..896c25403f 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-faq.md +++ b/deploy-manage/monitor/autoops/ec-autoops-faq.md @@ -23,6 +23,7 @@ Whether you are using AutoOps in your [{{ech}} deployment](/deploy-manage/monito * [What does AutoOps do?](#what-is-autoops) * [Where is AutoOps available?](#autoops-deployment-types) * [Why can't I see AutoOps in some deployments and projects?](#cant-see-autoops) +* [Can I use AutoOps if my environment is air-gapped?](#autoops-air-gapped) * [How is AutoOps licensed?](#autoops-license) * [Does AutoOps monitor the entire {{stack}}?](#autoops-monitoring) * [Can AutoOps automatically resolve issues?](#autoops-issue-resolution) @@ -38,8 +39,7 @@ Whether you are using AutoOps in your [{{ech}} deployment](/deploy-manage/monito **Setting up AutoOps for self-managed clusters** * [Can I use Cloud Connect to connect my {{ech}} clusters to AutoOps?](#cc-autoops-ech) -* [Can I use AutoOps for my clusters if my environment is air-gapped?](#autoops-air-gapped) -* [Can I use macOS to install {{agent}} for this feature?](#macos-install) +* [Can I use macOS to set up AutoOps for my self-managed clusters?](#macos-install) * [Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?](#elastic-ip-address) **Collected metrics and data in AutoOps for self-managed clusters** @@ -59,6 +59,9 @@ $$$autoops-deployment-types$$$**Where is AutoOps available?** $$$cant-see-autoops$$$**Why can't I see AutoOps in some deployments and projects?** AutoOps is rolling out in phases across CSPs and [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md), so you may not see it if your deployment or project is in a region where AutoOps is not available yet. AutoOps is currently not available in Azure and GCP. +$$$autoops-air-gapped$$$ **Can I use AutoOps if my environment is air-gapped?** +: Not at this time. AutoOps is currently only available as a cloud service and you need an internet connection to send metrics to {{ecloud}}. For air-gapped environments, we plan to offer a locally deployable version in the future. + $$$autoops-license$$$**How is AutoOps licensed?** : For {{ech}} deployments and {{serverless-short}} projects, AutoOps is available to {{ecloud}} customers at all subscription levels at no additional cost, and it does not consume ECU. :::{include} /deploy-manage/_snippets/autoops-cc-payment-faq.md @@ -102,11 +105,8 @@ $$$cc-autoops-ech$$$ **Can I use Cloud Connect to connect my {{ech}} clusters to : :::{include} /deploy-manage/_snippets/autoops-cc-ech-faq.md ::: -$$$autoops-air-gapped$$$ **Can I use AutoOps for my clusters if my environment is air-gapped?** -: Not at this time. AutoOps is currently only available as a cloud service and you need an internet connection to send metrics to {{ecloud}}. For air-gapped environments, we plan to offer a locally deployable version in the future. - -$$$macos-install$$$ **Can I use macOS to install {{agent}} for this feature?** -: macOS is not a supported platform for installing {{agent}} and connecting your clusters to AutoOps. +$$$macos-install$$$ **Can I use macOS to set up AutoOps for my self-managed clusters?** +: No, macOS is not a supported platform for setting up and connecting to AutoOps in a self-managed production environment. However, you can use macOS to [connect your local development cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md). $$$elastic-ip-address$$$ **Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?** : You may need to define an IP address if your organization’s settings will block the agent from sending out data. From c5c6187a2db33eed0a67f61f8de8405e10b549dc Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Sun, 16 Nov 2025 21:12:57 -0500 Subject: [PATCH 3/5] restructure and refine individual pages --- .../autoops/ec-autoops-deployment-view.md | 38 +++++++++++-------- .../monitor/autoops/ec-autoops-index-view.md | 27 ++++--------- .../monitor/autoops/ec-autoops-nodes-view.md | 20 ++++++++-- .../autoops/ec-autoops-overview-view.md | 33 ++++++++-------- .../monitor/autoops/ec-autoops-shards-view.md | 22 ++++++----- .../autoops/ec-autoops-template-optimizer.md | 6 +-- 6 files changed, 79 insertions(+), 67 deletions(-) diff --git a/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md b/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md index 521fca3be5..3784ce85f9 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md @@ -16,26 +16,33 @@ products: # Deployment or Cluster view in AutoOps [ec-autoops-deployment-view] -The **Deployment** view (for {{ECH}} deployments) or **Cluster** view (for ECE, ECK, and self-managed clusters), is the event control panel that allows you to see which issues are affecting the {{es}} cluster and get a list of action items to address them. +The **Deployment** view (for {{ECH}} deployments) or **Cluster** view (for ECE, ECK, and self-managed clusters), is the event control panel that gives you an overview of the events, resource usage, and performance of your deployments or clusters. -## Events over time [ec-autoops-events-over-time] +To get to this view, go to AutoOps in your deployment or cluster and select **Deployment** or **Cluster** from the side navigation. -The **Events Over Time** panel lists all the recent events the {{es}} cluster has triggered, ordered by criticality. It also gives a color-coded heat map to help understand when and how often a particular event happened. Click on any mosaic to get details about a particular event, for example the specific node/index/shard affected, event time and duration, and a detailed description of the actions you can take to mitigate that event. +You can use the **Deployment** or **Cluster** dropdown at the top of the screen to select which deployment or cluster you want to monitor. -Refer to [AutoOps events](ec-autoops-events.md) for more details. +## Panels in the Deployment or Cluster view +The **Deployment** or **Cluster** view shows the following panels. -## Open events [ec-autoops-open-events] +### Events over time [ec-autoops-events-over-time] -The **Open Events** panel lists open events sorted by severity and time. When the conditions that triggered the event no longer exist, the event is automatically set to close and appear in the **Events History** panel. Closing an event does not necessarily indicate that the customer resolved the issue, but rather that AutoOps no longer detects it. +The **Events Over Time** panel lists all the recent events the {{es}} cluster has triggered, ordered by criticality. It also gives a color-coded heat map to help understand when and how often a particular event happened. Click on any mosaic to get details about a particular event, such as the specific node, index, or shard affected, event time and duration, and a detailed description of the actions you can take to mitigate that event. + +Refer to [AutoOps events](ec-autoops-events.md) for more details. +### Open Events [ec-autoops-open-events] -## Events History [ec-events-history] +The **Open Events** panel lists open events sorted by severity and time. When the conditions that triggered the event no longer exist, the event is automatically set to close and appear in the **Events History** panel. Closing an event does not necessarily indicate that the customer resolved the issue, but rather that AutoOps no longer detects it. + +### Events History [ec-events-history] -The **Events History** panel lists events that happened at some point and that have been triggered, but some conditions changed and are no longer active. For example, when your cluster experiences a peak in search rate, that might trigger a "Too many tasks on queue" event. Now, your cluster is more relaxed in terms of search rate, so this event is no longer an issue, but it was recorded for historical reasons. Events history is also sorted by severity first and then by time. +The **Events History** panel lists events that were triggered in the past but are no longer active because of changed conditions. +Let's say your cluster experienced a peak in search rate, triggering a "Too many tasks on queue" event. Now, your cluster is more relaxed in terms of search rate, so this event is no longer an issue, but it was recorded for historical reasons. Like Open Events, Events History is also sorted first by severity and then by time. -## Resources [ec-deployment-resources] +### Resources [ec-deployment-resources] The **Resources** panel provides a quick overview of {{es}} cluster resource usage. The resources are presented based on their respective data tiers and include JVM memory usage, CPU usage, and storage usage over time. You can view essential cluster information such as the {{es}} version, total number of nodes, total number of shards, and total volume of used storage. @@ -44,17 +51,16 @@ The **Resources** panel provides a quick overview of {{es}} cluster resource usa :alt: Screenshot showing the Resources panel in the AutoOps Deployment or Cluster view ::: +### Performance [ec-deployment-performance] -## Performance [ec-deployment-performance] +The **Performance** panel shows the following key performance metrics aggregated at both the cluster level and the selected tier levels: -The **Performance** panel shows key performance metrics, aggregated at both the cluster level and the selected tier levels: +* **Search rate**: The number of search requests executed per second across all shards in the deployment or cluster, as well as within the selected data tiers. +* **Search latency**: The average latency of search operations across all shards in the deployment or cluster, and within the selected data tiers. +* **Indexing rate**: The number of documents indexed per second across all shards in the deployment or cluster, as well as within the selected data tiers. +* **Indexing latency**: The average latency of indexing operations across all shards in the deployment or cluster, and within the selected data tiers. :::{image} /deploy-manage/images/cloud-autoops-deployment-performance.png :screenshot: :alt: Screenshot showing the Performance panel in the AutoOps Deployment or Cluster view ::: - -* **Search rate**: The number of search requests executed per second across all shards in the deployment or cluster, as well as within the selected data tiers. -* **Search latency**: The average latency of search operations across all shards in the deployment or cluster, and within the selected data tiers. -* **Indexing rate**: The number of documents indexed per second across all shards in the deployment or cluster, as well as within the selected data tiers. -* **Indexing latency**: The average latency of indexing operations across all shards in the deployment or cluster, and within the selected data tiers. diff --git a/deploy-manage/monitor/autoops/ec-autoops-index-view.md b/deploy-manage/monitor/autoops/ec-autoops-index-view.md index 359a5a50eb..346acea1bd 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-index-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-index-view.md @@ -16,33 +16,22 @@ products: # Indices view in AutoOps [ec-autoops-index-view] -The **Indices** view provides detailed statistics for each {{es}} index in your deployment. +The **Indices** view provides detailed statistics for each {{es}} index in your deployment, allowing you to visualize index performance and trends to detect anomalies and optimize search efficiency. + +Information about each index is organized into a clear table with columns for the index's name, primary and total shards, indexing and search rate per second, and more. You can expand each index entry to dive deeper into real-time metrics. + +To get to the **Indices** view, go to AutoOps in your deployment or cluster and select **Indices** from the side navigation. :::{image} /deploy-manage/images/cloud-autoops-index-view.png :screenshot: :alt: Screenshot showing the Indices view in AutoOps ::: -The **Indices** view is essential for monitoring {{es}} indices, and offers comprehensive insights at a glance by displaying a clear and informative table about the following metrics: - -* Index Name -* Primary Shards and Total Shards -* Shard Size -* Size in Bytes -* Doc Count -* Indexing Rate/Sec -* Search Rate/Sec -* Index Latency -* Search Latency - -You can expand each index entry to dive deeper into real-time metrics. This is an intuitive and dynamic feature that allows you to visualize index activities and trends, in order to detect anomalies and optimize search efficiency. - -The **Indices** view offers you a powerful tool for managing and optimizing your {{es}} indices. By providing a detailed and up-to-date overview of index performance and usage, AutoOps ensures that your search and indexing operations run smoothly and efficiently. - +## Metrics in the Indices view [ec-autoops-index-metrics] -## Index metrics [ec-autoops-index-metrics] +The following table lists all the metrics available in the **Indices** view, along with a description of what each metric means. -| Metrics name | Metrics description | +| Metric name | Description | | --- | --- | | Size | Total size of all primary shards of the index | | Indexing rate | Number of documents being indexed per second on primary shards of the index | diff --git a/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md b/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md index 6205221da6..ecf47b710a 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-nodes-view.md @@ -16,16 +16,30 @@ products: # Nodes view in AutoOps [ec-autoops-nodes-view] -The **Nodes** view provides a thorough overview on the essential metrics for all monitored nodes. You can delve into specific nodes to observe metrics over extended periods. This includes data on the indexing rate and latency, search rate and latency, as well as details concerning thread pools, data, circuit breakers, network, disk, and additional elements. +The **Nodes** view provides a thorough look into essential metrics for all monitored nodes. With this view, you can gain deeper insight into your cluster's health on a per-node basis and observe each metric over extended periods of time. + +To get to the **Nodes** view, go to AutoOps in your deployment or cluster and select **Nodes** from the side navigation. :::{image} /deploy-manage/images/cloud-autoops-node-view.png :screenshot: :alt: Screenshot showing the Nodes view in AutoOps ::: -Similar to the **Deployment** or **Cluster** view, the list of open events is sorted by severity and open time. +## Panels in the Nodes view + +The **Nodes** view shows the following panels. + +### Nodes + +The **Nodes** table lists all the nodes used by the {{es}} cluster, along with their name, role, and status. The elected master node is marked with a star. + +### Open Events + +The **Open Events** panel lists open events sorted by severity and time. When the conditions that triggered the event no longer exist, the event is automatically set to close and appear in the **Events History** panel. Closing an event does not necessarily indicate that the customer resolved the issue, but rather that AutoOps no longer detects it. + +### Panels covering other monitoring areas -The following table lists all the nodes used by the {{es}} cluster, presenting node name, role and status. The elected master node will be marked with a start sign. +The following table lists all the other panels in the **Nodes** view that drill down into specific monitoring areas, along with the names and descriptions of metrics they present. | Area | Metrics name | Metrics description | | --- | --- | --- | diff --git a/deploy-manage/monitor/autoops/ec-autoops-overview-view.md b/deploy-manage/monitor/autoops/ec-autoops-overview-view.md index 776ee3c015..9c6d2b674a 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-overview-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-overview-view.md @@ -16,7 +16,11 @@ products: # Overview in AutoOps [ec-autoops-overview-view] -The **Overview** page displays the current status of customer deployments and clusters that are linked to the same Elastic organization. +The **Overview** page displays the current status of customer deployments and clusters that are linked to the same Elastic organization. + +This view offers an at-a-glance look into high-level metrics such as the most important and currently open events and the number of active deployments and nodes. You can also view the cluster status, the number of open events in each {{es}} deployment or cluster over different periods of time, and navigate to a specific deployment or cluster for more details. + +To get to the **Overview** page, go to AutoOps in your deployment or cluster and select **Overview** from the side navigation. :::{image} /deploy-manage/images/cloud-autoops-overview-page.png :screenshot: @@ -27,30 +31,25 @@ The **Overview** page displays the current status of customer deployments and cl The **Overview** page displays a complete list of deployments and clusters only if AutoOps is available in the specific Cloud Service Provider (CSP) region. :::: +## Panels on the Overview page -High-level metrics are available, including the most important and currently open events in a single pane. You can view the cluster status, the number of open events in each {{es}} deployment or cluster over different periods of time, and navigate to a specific deployment or cluster for more details. - - -## Deployments table [ec-autoops-deployment-table] - -The deployment view table lists all active deployments with {{es}} clusters and also deployments for which AutoOps collected the information but are no longer active. AutoOps provides real-time indications on {{es}} status, number of open critical events, number of {{es}} nodes and total number of shards. Select one of the deployments to get a more detailed view of all open and closed events. - - -## {{es}} Info [ec-autoops-es-info] +The **Overview** page shows the following panels. -This section shows the number of active deployments, the number of nodes, and a summary of used resources, such as total disk size used and total memory connected for all clusters connected. +### Deployments table [ec-autoops-deployment-table] +The **Deployments** table lists all active deployments as well as inactive deployments for which AutoOps collected information in the past. You can also see real-time updates of {{es}} status, the number of open critical events, the number of {{es}} nodes, and the total number of shards in each deployment. Select a deployment to get a more detailed view of all open and closed events. -## Top events [ec-autoops-top-events] +### {{es}} Info [ec-autoops-es-info] -This section provides a quick overview of the top open events in the selected period. You can filter by deployment/cluster, severity, name, and search for a specific event across all of the connected deployments or clusters. +Th **{{es}} Info** panel shows the number of active deployments, the number of nodes, and a summary of used resources, such as total disk size used and total memory connected for all clusters. -The default view lists the top 10 important events, sorted by severity. +### Top Events [ec-autoops-top-events] -The event card indicates when the last event occurred, the number of occurrences across all deployments/clusters, the deployments/clusters impacted by the event, and it includes a direct link to the event to get additional details. +The **Top Events** panel provides a quick overview of the top open events. You can filter by deployment or cluster, severity, name, and search for a specific event across all of the connected deployments or clusters. +The default view lists the top 10 important events, sorted by severity. Each event card indicates when the event occurred last, the number of occurrences across all deployments or clusters, the deployments or clusters impacted by the event, and it includes a direct link to the event to get additional details. -## Events in time period [ec-autoops-events-time-period] +### Events in Time Period [ec-autoops-events-time-period] -This time series chart displays all events identified across the connected deployments/clusters during the selected period. This allows you to detect which deployment/cluster is generating the most events, investigate, and take appropriate actions to resolve any issues. +The **Events in Time Period** panel shows a time series chart displaying all events identified across the connected deployments or clusters during the selected time period. Use this panel to detect which deployment or cluster is generating the most events, so that you can investigate further and take action to resolve the underlying issues. diff --git a/deploy-manage/monitor/autoops/ec-autoops-shards-view.md b/deploy-manage/monitor/autoops/ec-autoops-shards-view.md index bb7d5fc969..5c9ba38dea 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-shards-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-shards-view.md @@ -16,22 +16,26 @@ products: # Shards view in AutoOps [ec-autoops-shards-view] -The **Shards** view allows you to manage and monitor shards allocated to each node, ensuring optimal performance and reliability of your search and indexing operations. +The **Shards** view allows you to monitor the shards allocated to each node in your cluster. With this granular view into your cluster's health, you can get to the root cause of issues and resolve them to ensure optimal performance and reliability of your search and indexing operations. + +To get to the **Shards** view, go to AutoOps in your deployment or cluster and select **Shards** from the side navigation. :::{image} /deploy-manage/images/cloud-autoops-shard-view.png :screenshot: :alt: Screenshot showing the Shards view in AutoOps ::: -The **Shards** view provides: +The **Shards** view provides the following insights: + +* **Detailed Shard Breakdown**: Gain insights into each shard with a granular breakdown. View stats for shards from specific indices on any given node, allowing for in-depth performance and distribution analysis. +* **Size Information**: Quickly assess the storage footprint of each shard with precise size metrics, facilitating efficient resource management. +* **Document Count**: Monitor the number of documents contained within each shard to track and manage the shard load effectively. +* **Indexing Rate and Latency**: Keep an eye on indexing performance with real-time indexing rates and latencies. This ensures efficient and timely data indexing, helping maintain optimal performance. +* **Search Rate and Latency**: Optimize search functionalities by monitoring search rates and latencies. This ensures your search queries are processed quickly and effectively. -* Detailed Shard Breakdown: Gain insights into each shard with a granular breakdown. View stats for shards from specific indices on any given node, allowing for in-depth performance and distribution analysis. -* Size Information: Quickly assess the storage footprint of each shard with precise size metrics, facilitating efficient resource management. -* Document Count: Monitor the number of documents contained within each shard to track and manage the shard load effectively. -* Indexing Rate and Latency: Keep an eye on indexing performance with real-time indexing rates and latencies. This ensures efficient and timely data indexing, helping maintain optimal performance. -* Search Rate and Latency: Optimize search functionalities by monitoring search rates and latencies. This ensures your search queries are processed quickly and effectively. +## Metrics in the Shards view -You can get different views using the sorting fields: +Use the **Sort by** dropdown to view shard information sorted by different metrics. Select from the following metrics: * Indexing Latency * Indexing Rate @@ -41,5 +45,5 @@ You can get different views using the sorting fields: * Search Rate * Size in Bytes -Use the slider on the top right side of the metrics table to move forward and backward in time to view how shards data changes. +You can also use the time slider at the top of the screen to move forward and backward and observe how shards data changes over time. diff --git a/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md b/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md index 946895f4a6..6bf91f6e47 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md +++ b/deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md @@ -16,12 +16,12 @@ products: # Template Optimizer view in AutoOps [ec-autoops-template-optimizer] -The **Template Optimizer** view offers detailed recommendations for optimizing templates. +The **Template Optimizer** view offers detailed recommendations for optimizing templates. When AutoOps identifies a recommended change, it logs the template separately, allowing you to track impactful changes over time. You can navigate between different deployments or clusters to view all template recommendations. + +To get to the **Template Optimizer** view, go to AutoOps in your deployment or cluster and select **Template Optimizer** from the side navigation. :::{image} /deploy-manage/images/cloud-autoops-template-optimizer.png :screenshot: :alt: Screenshot showing the Template Optimizer view in AutoOps ::: -When AutoOps identifies a recommended change, it logs the template separately, allowing you to track past impactful changes. You can navigate between different deployments/clusters to view all template recommendations. - From 854989a8c736cf6c5fc8d7963ddb5fee62ee4b95 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Mon, 17 Nov 2025 17:01:22 -0500 Subject: [PATCH 4/5] one more targeted fix --- .../monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md index 61fd9ebb20..2083f03a27 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -38,7 +38,7 @@ $$$next-steps$$$**After running the installation command, I can't move on to the : If an error appears on the screen, follow the suggestion in the error message and try to run the command again. If the issue is not resolved, explore [additional resources](/troubleshoot/index.md#troubleshoot-additional-resources) or [contact us](/troubleshoot/index.md#contact-us). $$$firewall$$$**My organization's firewall may be preventing {{agent}} from collecting and sending metrics.** -: If you suspect that a corporate firewall is hindering {{agent}}, complete the following steps to test each component of the connection and implement an appropriate solution. +: If you're having issues with connecting your self-managed cluster to AutoOps and you suspect that a firewall may be the reason, complete the following steps to test each component of the connection and implement an appropriate solution. :::{tip} Run the following tests within the context of your execution environment. That is, if your chosen installation method is Kubernetes, run the commands from within the pod; for Docker, run the commands from within the container, and so on. From 92554aacea803049684ea2435f834e2064425386 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Tue, 18 Nov 2025 21:53:29 -0500 Subject: [PATCH 5/5] PR feedback --- deploy-manage/monitor/autoops/ec-autoops-deployment-view.md | 2 +- deploy-manage/monitor/autoops/ec-autoops-overview-view.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md b/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md index 3784ce85f9..212ded0e6b 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-deployment-view.md @@ -28,7 +28,7 @@ The **Deployment** or **Cluster** view shows the following panels. ### Events over time [ec-autoops-events-over-time] -The **Events Over Time** panel lists all the recent events the {{es}} cluster has triggered, ordered by criticality. It also gives a color-coded heat map to help understand when and how often a particular event happened. Click on any mosaic to get details about a particular event, such as the specific node, index, or shard affected, event time and duration, and a detailed description of the actions you can take to mitigate that event. +The **Events Over Time** panel lists all the recent events the {{es}} cluster has triggered, ordered by criticality. It also displays a color-coded heat map to help understand when and how often a particular event happened. Click on any mosaic to get details about a particular event, such as the specific node, index, or shard affected, event time and duration, and a detailed description of the actions you can take to mitigate that event. Refer to [AutoOps events](ec-autoops-events.md) for more details. diff --git a/deploy-manage/monitor/autoops/ec-autoops-overview-view.md b/deploy-manage/monitor/autoops/ec-autoops-overview-view.md index 9c6d2b674a..46f22545b9 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-overview-view.md +++ b/deploy-manage/monitor/autoops/ec-autoops-overview-view.md @@ -41,7 +41,7 @@ The **Deployments** table lists all active deployments as well as inactive deplo ### {{es}} Info [ec-autoops-es-info] -Th **{{es}} Info** panel shows the number of active deployments, the number of nodes, and a summary of used resources, such as total disk size used and total memory connected for all clusters. +The **{{es}} Info** panel shows the number of active deployments, the number of nodes, and a summary of used resources, such as total disk size used and total memory connected for all clusters. ### Top Events [ec-autoops-top-events]