Skip to content

Commit 6b5e33f

Browse files
authored
Enhance and restructure AutoOps pages (#3955)
In this PR, I have: - added a child to the **Troubleshooting** page because it had too much info. More child pages will be added in the future. - made various general fixes. - ~- moved the **Views** and **Events** pages under the **AutoOps for ECH** section and linked to them from the **AutoOps for SM clusters** section because they don't apply to **AutoOps for Serverless**. I'm open to feedback if anyone has a better idea for organizing this info.~ Closes #3220
1 parent 36eb02e commit 6b5e33f

16 files changed

+221
-180
lines changed
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
:::{admonition} Simplify monitoring with AutoOps
2-
Use AutoOps in your {{ech}}, ECE, ECK, or self-managed deployments.
3-
4-
AutoOps is a monitoring tool that simplifies cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths. For more information, refer to [](/deploy-manage/monitor/autoops.md).
5-
::::
2+
:applies_to: { ess:, ece:, eck:, self:, "serverless": "ga" }
3+
AutoOps is a monitoring tool that simplifies cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths. Learn more about [](/deploy-manage/monitor/autoops.md).
4+
:::
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
This path is not supported. Currently, we only support using Cloud Connect to connect ECE, ECK, and self-managed clusters to AutoOps.
22

3-
For {{ech}} clusters, AutoOps is set up and enabled automatically in all supported [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md), and can be [accessed](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md#ec-autoops-how-to-access) from the deployment overview page.
3+
For {{ech}} deployments, AutoOps is set up and enabled automatically in all supported [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md), and can be [accessed](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) from the deployment overview page.

deploy-manage/deploy/elastic-cloud/serverless.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ products:
2020
Serverless projects use the core components of the {{stack}}, such as {{es}} and {{kib}}, and are based on an architecture that decouples compute and storage. Search and indexing operations are separated, which offers high flexibility for scaling your workloads while ensuring a high level of performance.
2121

2222
:::{note}
23-
There are differences between {{es-serverless}} and {{ech}}, for a list of differences between them, see [differences between {{ech}} and {{es-serverless}}](../elastic-cloud.md#general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud).
23+
There are differences between {{es-serverless}} and {{ech}}. Learn more in [Compare {{ech}} and {{es-serverless}}](../elastic-cloud.md#general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud).
2424
:::
2525

2626
## Get started
@@ -55,6 +55,9 @@ Afterwards, you can:
5555
* **Data:** Choose the data you want to ingest and the method to ingest it. By default, data is stored indefinitely in your project, and you define the retention settings for your data streams.
5656
* **Performance:** For granular control over costs and query performance against your project data, serverless projects come with a set of predefined settings you can edit.
5757

58+
:::{include} /deploy-manage/_snippets/autoops-callout-with-ech.md
59+
:::
60+
5861
## Monitor serverless status [general-serverless-status]
5962

6063
Serverless projects run on cloud platforms, which may undergo changes in availability. When availability changes, Elastic makes sure to provide you with a current service status.

deploy-manage/monitor.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Depending on your deployment type, you can use a variety of solutions for monito
2424

2525
You have several options for monitoring your cluster or deployment.
2626

27-
Use [AutoOps](/deploy-manage/monitor/autoops.md) in your {{ech}}, ECE, ECK, or self-managed deployments. AutoOps is a monitoring tool that simplifies cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths.
27+
Use [](/deploy-manage/monitor/autoops.md) to simplify cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths.
2828

2929
Alternatively, you can use [Stack Monitoring](/deploy-manage/monitor/stack-monitoring.md) to monitor logs and metrics across the {{stack}}.
3030

@@ -47,7 +47,8 @@ deployment:
4747

4848
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.
4949

50-
In the [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md) where it has been rolled out, AutoOps is automatically available in [{{ech}} deployments](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) and [{{serverless-full}} projects](/deploy-manage/monitor/autoops/autoops-for-serverless.md), and can be set up for [ECE, ECK, and self-managed clusters](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md).
50+
:::{include} /deploy-manage/monitor/_snippets/autoops-availability.md
51+
:::
5152

5253
### Stack monitoring
5354

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AutoOps is automatically available in [{{ech}} deployments](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) and [{{serverless-full}} projects](/deploy-manage/monitor/autoops/autoops-for-serverless.md), and can be set up for [ECE, ECK, and self-managed clusters](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md) through Cloud Connect.

deploy-manage/monitor/autoops-vs-stack-monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ You can store your Stack Monitoring logs and metrics in the following ways:
6969
### Availability
7070

7171
#### AutoOps [ao-availability]
72-
AutoOps lives in {{ecloud}}, so you need to have an {{ecloud}} account to access it. Once logged in, you can [access](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) AutoOps from your hosted deployments.
72+
AutoOps lives in {{ecloud}}, so you need to have an {{ecloud}} account to access it. Once logged in, you can access AutoOps from your [{{ech}} deployments](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md), [{{serverless-short}} projects](/deploy-manage/monitor/autoops/access-autoops-for-serverless.md), or [connect your self-managed clusters](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md) to it.
7373

7474
#### Stack Monitoring [sm-availability]
7575
Once setup is complete, you can access the Stack Monitoring UI inside {{kib}}, where you can monitor all your {{stack}} components.

deploy-manage/monitor/autoops.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing r
2323
:alt: Screenshot showing the Overview page in AutoOps
2424
:::
2525

26-
27-
## AutoOps key features [ec_autoops_key_features]
26+
## Key features in AutoOps [ec_autoops_key_features]
2827

2928
* Real-time root-cause analysis for hundreds of issues.
3029
* Accurate resolution paths and customized recommendations.
@@ -38,38 +37,43 @@ AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing r
3837
* Unbalanced loads between nodes.
3938
* Indexing latency, rejections, search latency, high index/search queues, and slow queries.
4039
* Resource utilization.
40+
* Multi-deployment dashboard to quickly spot issues across all clusters.
41+
* Possibility to customize event triggers and connect to different notification services such as PagerDuty, Slack, MS Teams, and webhooks.
42+
* Coming soon: Long-term reports for sustained evaluation.
4143

44+
## Regions where AutoOps is available
4245

46+
Depending on your deployment type, AutoOps has been rolled out across various [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md). More regions and CSPs are coming soon.
4347

44-
## Additional capabilities [ec_additional_capabilities]
48+
## Deployment types where AutoOps is available
4549

46-
* Multi-deployment dashboard to quickly spot issues across all clusters.
47-
* Possibility to customize event triggers and connect to different notification services such as PagerDuty, Slack, MS Teams, and webhooks.
48-
* Long-term reports for sustained evaluation. This feature is currently not available and will be rolled out shortly.
50+
:::{include} /deploy-manage/monitor/_snippets/autoops-availability.md
51+
:::
4952

50-
## AutoOps availability
53+
AutoOps is currently not available for air-gapped environments because it's a cloud service and you need an internet connection to send metrics to {{ecloud}}. However, we plan to offer a locally deployable version in the future.
5154

52-
In the [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md) where it has been rolled out, AutoOps is automatically available in [{{ech}} deployments](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) and [{{serverless-full}} projects](/deploy-manage/monitor/autoops/autoops-for-serverless.md), and can be set up for [ECE, ECK, and self-managed clusters](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md).
55+
## How AutoOps is licensed
5356

54-
AutoOps is currently not available for air-gapped environments since it is a cloud service and you need an internet connection to send metrics to {{ecloud}}. However, we plan to offer a locally deployable version in the future.
57+
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.
58+
:::{include} /deploy-manage/_snippets/autoops-cc-payment-faq.md
59+
:::
5560

56-
## AutoOps retention period [ec_autoops_retention_period]
61+
## How long AutoOps retains data [ec_autoops_retention_period]
5762

5863
AutoOps currently has a 10 day retention period.
5964

65+
## What AutoOps monitors [ec_autoops_scope]
6066

61-
## AutoOps scope [ec_autoops_scope]
62-
63-
AutoOps currently monitors only {{es}}, not the entire {{stack}}. Any deployment information pertains solely to {{es}}. AutoOps is compatible with [supported {{es}} versions](https://www.elastic.co/support/eol)(7.17.x and above). We plan to expand AutoOps monitoring to the entire stack in the future.
67+
AutoOps currently only monitors {{es}}, not the entire {{stack}}. AutoOps is compatible with [supported {{es}} versions](https://www.elastic.co/support/eol)(7.17.x and above). We plan to expand AutoOps monitoring to the entire stack in the future.
6468

6569
## Section overview
6670

6771
In this section, you'll find the following information:
6872

69-
* How to [use AutoOps in your {{ech}} deployments](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md).
73+
* How to [access AutoOps in your {{ech}} deployments](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md).
7074
* How to [use AutoOps in your {{serverless-full}} projects](/deploy-manage/monitor/autoops/autoops-for-serverless.md).
7175
* How to [connect your ECE, ECK, or self-managed clusters](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md) to AutoOps.
7276
* [Regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md) where AutoOps is available.
73-
* What [events](/deploy-manage/monitor/autoops/ec-autoops-events.md) are and how you can configure [event settings](/deploy-manage/monitor/autoops/ec-autoops-event-settings.md) and [notifications](/deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md).
7477
* Which [views](/deploy-manage/monitor/autoops/views.md) AutoOps offers to gain insight into your deployment.
78+
* What AutoOps [events](/deploy-manage/monitor/autoops/ec-autoops-events.md) are and how you can configure [event settings](/deploy-manage/monitor/autoops/ec-autoops-event-settings.md) and [notifications](/deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md).
7579
* [Frequently asked questions](/deploy-manage/monitor/autoops/ec-autoops-faq.md) about AutoOps.

deploy-manage/monitor/autoops/autoops-for-serverless.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Let’s say you ingest 1TB of data into your Observability project.
6969
* **Retention**: Given that 1GB retained per hour = [$0.018](https://www.elastic.co/pricing/serverless-observability) and assuming it took one hour to ingest 1TB of data, that 1TB will be billed 1.42GB for that slice of one hour (1TB/720 hours per month), which translates to $0.025. Each subsequent hour in that month will cost the same.
7070
:::
7171

72-
## Coming soon
72+
## Coming soon to AutoOps for Serverless
7373

7474
The following features are coming soon to AutoOps for {{serverless-short}}:
7575

@@ -85,3 +85,6 @@ In this section, you'll find the following information:
8585
* How to use the [Search tier view](search-tier-view-autoops-serverless.md) to see the impact of search performance on your use of search VCUs.
8686
* How to use the [Search AI Lake view](search-ai-lake-view-autoops-serverless.md) to drill down into your storage-related usage.
8787

88+
:::{tip}
89+
Refer to our [FAQ](/deploy-manage/monitor/autoops/ec-autoops-faq.md) for answers to frequently asked questions about AutoOps.
90+
:::
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
applies_to:
3+
deployment:
4+
self:
5+
ece:
6+
eck:
7+
navigation_title: Firewalls blocking {{agent}}
8+
products:
9+
- id: cloud-kubernetes
10+
- id: cloud-enterprise
11+
---
12+
13+
# Troubleshoot firewalls blocking {{agent}}
14+
15+
If you are running into issues connecting your cluster to AutoOps, a corporate firewall might be blocking {{agent}}.
16+
17+
There are [three main components](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md#how-your-self-managed-cluster-connects-to-autoops) of {{agent}}'s connection with your system:
18+
19+
:::{include} /deploy-manage/monitor/_snippets/autoops-cc-components.md
20+
:::
21+
22+
The following subsections describe how to test each of these components to find out where the problem lies, and then implement an appropriate solution.
23+
24+
:::{tip}
25+
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.
26+
:::
27+
28+
## 1. Test {{agent}}'s connection with your cluster
29+
If there is an issue with the first component, {{agent}} cannot connect to your cluster.
30+
31+
To test if your organization is not allowing this connection, run the following command depending on your chosen authentication method:
32+
33+
:::::{tab-set}
34+
:group: api-key-or-basic
35+
36+
::::{tab-item} API key
37+
:sync: api-key
38+
39+
```json
40+
curl -XGET -i $AUTOOPS_ES_URL \
41+
-H "Authorization: ApiKey $AUTOOPS_ES_API_KEY"
42+
```
43+
::::
44+
45+
::::{tab-item} Basic
46+
:sync: basic
47+
48+
```json
49+
curl -XGET -i $AUTOOPS_ES_URL \
50+
-u $AUTOOPS_ES_USERNAME
51+
```
52+
::::
53+
54+
:::::
55+
56+
The command returns a response similar to the following:
57+
58+
```json
59+
{
60+
"name" : "1c72f00a6195",
61+
"cluster_name" : "my-ccm-cluster",
62+
"cluster_uuid" : "2O_EjO6kTR6AEVYwL5fPEw",
63+
"version" : {
64+
"number" : "9.1.3",
65+
"build_flavor" : "default",
66+
"build_type" : "docker",
67+
"build_hash" : "0c781091a2f57de895a73a1391ff8426c0153c8d",
68+
"build_date" : "2025-08-24T22:05:04.526302670Z",
69+
"build_snapshot" : false,
70+
"lucene_version" : "10.2.2",
71+
"minimum_wire_compatibility_version" : "8.19.0",
72+
"minimum_index_compatibility_version" : "8.0.0"
73+
},
74+
"tagline" : "You Know, for Search"
75+
}
76+
```
77+
78+
If you do not receive a similar response, your system returns an error indicating one or more reasons for the failure as outlined in the following table. Use the corresponding proposed solution to fix the issue.
79+
80+
| Reason for failure | Proposed solution |
81+
| :--- | :--- |
82+
| The {{es}} endpoint URL you specified is incorrect/not reachable | - Make sure you are using the correct protocol in the cluster URL:`http` or `https`. <br> - Make sure you are providing the correct port. The default port is **9200**. <br> - If you have verified that the URL is correct, your network team might need to open the firewall to allow-list this URL. |
83+
| Your API key is incorrect | - Recheck for typos. <br> - If your cluster is on versions 9.1.0 through 9.1.3, ensure that you have the base64-decoded version of the key by running the following command: <br><br> `echo $AUTOOPS_ES_API_KEY | base64 -d` <br><br> If your key has a colon (:), it is not base64 encoded. If your key has an equal sign (=), it is base64 coded. <br> For versions 9.1.4 and above, both formats work.|
84+
| Your username or password is incorrect | - Recheck for typos. <br> - Ensure that your provided user has the [necessary privileges](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#configure-agent). We do not recommend providing a privileged superuser like `elastic` for this purpose.|
85+
| You are providing both the API key and username/password | Choose one type of authentication only. |
86+
| A proxy is blocking communication with your {{es}} cluster | You might have to [configure `NO_PROXY`](/reference/fleet/host-proxy-env-vars.md). |
87+
| You are using a custom SSL/TLS configuration with {{es}} | Disable SSL/TLS verification so that your system trusts all certificates. We do not recommend disabling verification in production environments. <br><br> If you are using API key authentication, run the following command: <br><br>`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -H "Authorization: ApiKey $AUTOOPS_ES_API_KEY"`. <br><br> If you are using username/password authentication, run the following command: <br><br> `curl -XGET --insecure -i $AUTOOPS_ES_URL \ -u $AUTOOPS_ES_USERNAME` <br><br> If the issue is resolved, you need to configure your custom SSL/TLS settings with {{agent}}. If the issue persists, contact [Elastic support](https://support.elastic.co/).|
88+
| You are connecting a local development cluster using Docker without specifying `--network host` | - Make sure you are following all the steps to [connect your local development cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md#connect-your-local-development-cluster-to-autoops). <br> - In the [Install agent](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#install-agent) step, make sure you are replacing `docker run -d \` with `docker run -d --network host \`. |
89+
90+
## 2. Test your cluster's registration with {{ecloud}}
91+
92+
If there is an issue with the second component, the agent stops working and your logs might show the following error:
93+
94+
```sh
95+
... failed to register Cloud Connected Mode: ... Post \"https://api.elastic-cloud.com/api/v1/cloud-connected/clusters\": ...
96+
```
97+
98+
To test if your organization is not allowing the agent to register your cluster with {{ecloud}}, run the following command:
99+
100+
```json
101+
curl -XPOST -i \
102+
https://api.elastic-cloud.com/api/v1/cloud-connected/clusters \
103+
-H 'Content-Type: application/json' \
104+
-d '{"self_managed_cluster": {"id": "my-cluster-uuid", "name": "my-cluster-name", "version": "9.1.0"}, "license": {"uid": "my-license-id", "type": "basic"}}'
105+
```
106+
107+
The command should return an HTTP 401 response:
108+
109+
```json
110+
{"UnauthorizedMessages":["Invalid credential headers"],"Cause":null}
111+
```
112+
If you do not receive a similar response, configure your HTTP proxy to allow it to reach the URL (with headers and a JSON body):
113+
114+
```json
115+
POST https://api.elastic-cloud.com/api/v1/cloud-connected/clusters
116+
```
117+
:::{note}
118+
If you are using Docker, you might need to complete this configuration directly using the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables.
119+
:::
120+
121+
## 3. Test if {{agent}} is able to send metrics
122+
123+
If there is an issue with the third component, the agent attempts to establish the connection and your logs might show the following error:
124+
125+
```sh
126+
... Exporting failed. Dropping data. ... no more retries left: failed to make an HTTP request: Post \"https://otel-collector.auto-ops.eu-west-1.aws.cloud.elastic.co:4318/v1/logs\": ...
127+
```
128+
129+
To test if your organization is not allowing the agent to send metrics from your cluster to {{ecloud}}, run the following command. The command uses AWS eu-west-1 as the CSP (cloud service provider) region, but you should replace it with your chosen CSP region before running the command.
130+
131+
```json
132+
curl -XPOST -i \
133+
https://otel-collector.auto-ops.eu-west-1.aws.cloud.elastic.co:4318/v1/logs \
134+
-H 'Content-Type: application/json'
135+
136+
```
137+
The command should return an HTTP 401 response:
138+
139+
```json
140+
{"code":16,"message":"no auth provided"}
141+
```
142+
143+
If you do not receive a similar response, configure your HTTP proxy to allow it to reach the URL (with headers and an arbitrary body):
144+
145+
```json
146+
POST https://otel-collector.auto-ops.${REGION}.${CSP}.cloud.elastic.co:4318/v1/logs
147+
```
148+
:::{note}
149+
If you are using Docker, you might need to complete this configuration directly using the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables.
150+
:::

0 commit comments

Comments
 (0)