Skip to content

Commit c5c6187

Browse files
committed
restructure and refine individual pages
1 parent 0acd1c8 commit c5c6187

File tree

6 files changed

+79
-67
lines changed

6 files changed

+79
-67
lines changed

deploy-manage/monitor/autoops/ec-autoops-deployment-view.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,33 @@ products:
1616

1717
# Deployment or Cluster view in AutoOps [ec-autoops-deployment-view]
1818

19-
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.
19+
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.
2020

21-
## Events over time [ec-autoops-events-over-time]
21+
To get to this view, go to AutoOps in your deployment or cluster and select **Deployment** or **Cluster** from the side navigation.
2222

23-
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.
23+
You can use the **Deployment** or **Cluster** dropdown at the top of the screen to select which deployment or cluster you want to monitor.
2424

25-
Refer to [AutoOps events](ec-autoops-events.md) for more details.
25+
## Panels in the Deployment or Cluster view
2626

27+
The **Deployment** or **Cluster** view shows the following panels.
2728

28-
## Open events [ec-autoops-open-events]
29+
### Events over time [ec-autoops-events-over-time]
2930

30-
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.
31+
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.
32+
33+
Refer to [AutoOps events](ec-autoops-events.md) for more details.
3134

35+
### Open Events [ec-autoops-open-events]
3236

33-
## Events History [ec-events-history]
37+
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.
38+
39+
### Events History [ec-events-history]
3440

35-
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.
41+
The **Events History** panel lists events that were triggered in the past but are no longer active because of changed conditions.
3642

43+
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.
3744

38-
## Resources [ec-deployment-resources]
45+
### Resources [ec-deployment-resources]
3946

4047
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.
4148

@@ -44,17 +51,16 @@ The **Resources** panel provides a quick overview of {{es}} cluster resource usa
4451
:alt: Screenshot showing the Resources panel in the AutoOps Deployment or Cluster view
4552
:::
4653

54+
### Performance [ec-deployment-performance]
4755

48-
## Performance [ec-deployment-performance]
56+
The **Performance** panel shows the following key performance metrics aggregated at both the cluster level and the selected tier levels:
4957

50-
The **Performance** panel shows key performance metrics, aggregated at both the cluster level and the selected tier levels:
58+
* **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.
59+
* **Search latency**: The average latency of search operations across all shards in the deployment or cluster, and within the selected data tiers.
60+
* **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.
61+
* **Indexing latency**: The average latency of indexing operations across all shards in the deployment or cluster, and within the selected data tiers.
5162

5263
:::{image} /deploy-manage/images/cloud-autoops-deployment-performance.png
5364
:screenshot:
5465
:alt: Screenshot showing the Performance panel in the AutoOps Deployment or Cluster view
5566
:::
56-
57-
* **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.
58-
* **Search latency**: The average latency of search operations across all shards in the deployment or cluster, and within the selected data tiers.
59-
* **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.
60-
* **Indexing latency**: The average latency of indexing operations across all shards in the deployment or cluster, and within the selected data tiers.

deploy-manage/monitor/autoops/ec-autoops-index-view.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,22 @@ products:
1616

1717
# Indices view in AutoOps [ec-autoops-index-view]
1818

19-
The **Indices** view provides detailed statistics for each {{es}} index in your deployment.
19+
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.
20+
21+
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.
22+
23+
To get to the **Indices** view, go to AutoOps in your deployment or cluster and select **Indices** from the side navigation.
2024

2125
:::{image} /deploy-manage/images/cloud-autoops-index-view.png
2226
:screenshot:
2327
:alt: Screenshot showing the Indices view in AutoOps
2428
:::
2529

26-
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:
27-
28-
* Index Name
29-
* Primary Shards and Total Shards
30-
* Shard Size
31-
* Size in Bytes
32-
* Doc Count
33-
* Indexing Rate/Sec
34-
* Search Rate/Sec
35-
* Index Latency
36-
* Search Latency
37-
38-
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.
39-
40-
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.
41-
30+
## Metrics in the Indices view [ec-autoops-index-metrics]
4231

43-
## Index metrics [ec-autoops-index-metrics]
32+
The following table lists all the metrics available in the **Indices** view, along with a description of what each metric means.
4433

45-
| Metrics name | Metrics description |
34+
| Metric name | Description |
4635
| --- | --- |
4736
| Size | Total size of all primary shards of the index |
4837
| Indexing rate | Number of documents being indexed per second on primary shards of the index |

deploy-manage/monitor/autoops/ec-autoops-nodes-view.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,30 @@ products:
1616

1717
# Nodes view in AutoOps [ec-autoops-nodes-view]
1818

19-
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.
19+
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.
20+
21+
To get to the **Nodes** view, go to AutoOps in your deployment or cluster and select **Nodes** from the side navigation.
2022

2123
:::{image} /deploy-manage/images/cloud-autoops-node-view.png
2224
:screenshot:
2325
:alt: Screenshot showing the Nodes view in AutoOps
2426
:::
2527

26-
Similar to the **Deployment** or **Cluster** view, the list of open events is sorted by severity and open time.
28+
## Panels in the Nodes view
29+
30+
The **Nodes** view shows the following panels.
31+
32+
### Nodes
33+
34+
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.
35+
36+
### Open Events
37+
38+
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.
39+
40+
### Panels covering other monitoring areas
2741

28-
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.
42+
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.
2943

3044
| Area | Metrics name | Metrics description |
3145
| --- | --- | --- |

deploy-manage/monitor/autoops/ec-autoops-overview-view.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,11 @@ products:
1616

1717
# Overview in AutoOps [ec-autoops-overview-view]
1818

19-
The **Overview** page displays the current status of customer deployments and clusters that are linked to the same Elastic organization.
19+
The **Overview** page displays the current status of customer deployments and clusters that are linked to the same Elastic organization.
20+
21+
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.
22+
23+
To get to the **Overview** page, go to AutoOps in your deployment or cluster and select **Overview** from the side navigation.
2024

2125
:::{image} /deploy-manage/images/cloud-autoops-overview-page.png
2226
:screenshot:
@@ -27,30 +31,25 @@ The **Overview** page displays the current status of customer deployments and cl
2731
The **Overview** page displays a complete list of deployments and clusters only if AutoOps is available in the specific Cloud Service Provider (CSP) region.
2832
::::
2933

34+
## Panels on the Overview page
3035

31-
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.
32-
33-
34-
## Deployments table [ec-autoops-deployment-table]
35-
36-
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.
37-
38-
39-
## {{es}} Info [ec-autoops-es-info]
36+
The **Overview** page shows the following panels.
4037

41-
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.
38+
### Deployments table [ec-autoops-deployment-table]
4239

40+
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.
4341

44-
## Top events [ec-autoops-top-events]
42+
### {{es}} Info [ec-autoops-es-info]
4543

46-
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.
44+
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.
4745

48-
The default view lists the top 10 important events, sorted by severity.
46+
### Top Events [ec-autoops-top-events]
4947

50-
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.
48+
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.
5149

50+
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.
5251

53-
## Events in time period [ec-autoops-events-time-period]
52+
### Events in Time Period [ec-autoops-events-time-period]
5453

55-
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.
54+
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.
5655

deploy-manage/monitor/autoops/ec-autoops-shards-view.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,26 @@ products:
1616

1717
# Shards view in AutoOps [ec-autoops-shards-view]
1818

19-
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.
19+
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.
20+
21+
To get to the **Shards** view, go to AutoOps in your deployment or cluster and select **Shards** from the side navigation.
2022

2123
:::{image} /deploy-manage/images/cloud-autoops-shard-view.png
2224
:screenshot:
2325
:alt: Screenshot showing the Shards view in AutoOps
2426
:::
2527

26-
The **Shards** view provides:
28+
The **Shards** view provides the following insights:
29+
30+
* **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.
31+
* **Size Information**: Quickly assess the storage footprint of each shard with precise size metrics, facilitating efficient resource management.
32+
* **Document Count**: Monitor the number of documents contained within each shard to track and manage the shard load effectively.
33+
* **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.
34+
* **Search Rate and Latency**: Optimize search functionalities by monitoring search rates and latencies. This ensures your search queries are processed quickly and effectively.
2735

28-
* 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.
29-
* Size Information: Quickly assess the storage footprint of each shard with precise size metrics, facilitating efficient resource management.
30-
* Document Count: Monitor the number of documents contained within each shard to track and manage the shard load effectively.
31-
* 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.
32-
* Search Rate and Latency: Optimize search functionalities by monitoring search rates and latencies. This ensures your search queries are processed quickly and effectively.
36+
## Metrics in the Shards view
3337

34-
You can get different views using the sorting fields:
38+
Use the **Sort by** dropdown to view shard information sorted by different metrics. Select from the following metrics:
3539

3640
* Indexing Latency
3741
* Indexing Rate
@@ -41,5 +45,5 @@ You can get different views using the sorting fields:
4145
* Search Rate
4246
* Size in Bytes
4347

44-
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.
48+
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.
4549

deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ products:
1616

1717
# Template Optimizer view in AutoOps [ec-autoops-template-optimizer]
1818

19-
The **Template Optimizer** view offers detailed recommendations for optimizing templates.
19+
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.
20+
21+
To get to the **Template Optimizer** view, go to AutoOps in your deployment or cluster and select **Template Optimizer** from the side navigation.
2022

2123
:::{image} /deploy-manage/images/cloud-autoops-template-optimizer.png
2224
:screenshot:
2325
:alt: Screenshot showing the Template Optimizer view in AutoOps
2426
:::
2527

26-
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.
27-

0 commit comments

Comments
 (0)