Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion deploy-manage/monitor/autoops.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
:::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
Expand Down
42 changes: 25 additions & 17 deletions deploy-manage/monitor/autoops/ec-autoops-deployment-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,43 +16,51 @@ 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.

## Events History [ec-events-history]
### Open Events [ec-autoops-open-events]

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 **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]

## Resources [ec-deployment-resources]
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]

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
:::

### Performance [ec-deployment-performance]

## Performance [ec-deployment-performance]

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
:::
The **Performance** panel shows the following 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
:::
6 changes: 4 additions & 2 deletions deploy-manage/monitor/autoops/ec-autoops-event-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
:::


Expand All @@ -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
:::

3 changes: 2 additions & 1 deletion deploy-manage/monitor/autoops/ec-autoops-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
14 changes: 7 additions & 7 deletions deploy-manage/monitor/autoops/ec-autoops-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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**
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
:::
30 changes: 10 additions & 20 deletions deploy-manage/monitor/autoops/ec-autoops-index-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +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.

:::{image} /deploy-manage/images/cloud-autoops-index-view.png
:alt: The Indices view
:::

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:
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.

* Index Name
* Primary Shards and Total Shards
* Shard Size
* Size in Bytes
* Doc Count
* Indexing Rate/Sec
* Search Rate/Sec
* Index Latency
* Search Latency
To get to the **Indices** view, go to AutoOps in your deployment or cluster and select **Indices** from the side navigation.

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.
:::{image} /deploy-manage/images/cloud-autoops-index-view.png
:screenshot:
:alt: Screenshot showing the Indices view in AutoOps
:::

## 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 |
Expand Down
23 changes: 19 additions & 4 deletions deploy-manage/monitor/autoops/ec-autoops-nodes-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +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
: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.
## 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 |
| --- | --- | --- |
Expand Down
Loading
Loading