diff --git a/deploy-manage/_snippets/autoops-callout-with-ech.md b/deploy-manage/_snippets/autoops-callout-with-ech.md index 6dc74e961d..b40ad75757 100644 --- a/deploy-manage/_snippets/autoops-callout-with-ech.md +++ b/deploy-manage/_snippets/autoops-callout-with-ech.md @@ -1,5 +1,4 @@ :::{admonition} Simplify monitoring with AutoOps -Use AutoOps 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. For more information, refer to [](/deploy-manage/monitor/autoops.md). -:::: \ No newline at end of file +:applies_to: { ess:, ece:, eck:, self:, "serverless": "ga" } +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). +::: \ No newline at end of file diff --git a/deploy-manage/_snippets/autoops-cc-ech-faq.md b/deploy-manage/_snippets/autoops-cc-ech-faq.md index 9fbb7fa288..199ef08831 100644 --- a/deploy-manage/_snippets/autoops-cc-ech-faq.md +++ b/deploy-manage/_snippets/autoops-cc-ech-faq.md @@ -1,3 +1,3 @@ This path is not supported. Currently, we only support using Cloud Connect to connect ECE, ECK, and self-managed clusters to AutoOps. -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/serverless.md b/deploy-manage/deploy/elastic-cloud/serverless.md index b95f5e673c..a229986c38 100644 --- a/deploy-manage/deploy/elastic-cloud/serverless.md +++ b/deploy-manage/deploy/elastic-cloud/serverless.md @@ -20,7 +20,7 @@ products: 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. :::{note} -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). +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). ::: ## Get started @@ -55,6 +55,9 @@ Afterwards, you can: * **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. * **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. +:::{include} /deploy-manage/_snippets/autoops-callout-with-ech.md +::: + ## Monitor serverless status [general-serverless-status] 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. diff --git a/deploy-manage/monitor.md b/deploy-manage/monitor.md index e33059a02c..e7f7515279 100644 --- a/deploy-manage/monitor.md +++ b/deploy-manage/monitor.md @@ -24,7 +24,7 @@ Depending on your deployment type, you can use a variety of solutions for monito You have several options for monitoring your cluster or deployment. -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. +Use [](/deploy-manage/monitor/autoops.md) to simplify cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths. Alternatively, you can use [Stack Monitoring](/deploy-manage/monitor/stack-monitoring.md) to monitor logs and metrics across the {{stack}}. @@ -47,7 +47,8 @@ deployment: 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. -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). +:::{include} /deploy-manage/monitor/_snippets/autoops-availability.md +::: ### Stack monitoring diff --git a/deploy-manage/monitor/_snippets/autoops-availability.md b/deploy-manage/monitor/_snippets/autoops-availability.md new file mode 100644 index 0000000000..e5fce0660b --- /dev/null +++ b/deploy-manage/monitor/_snippets/autoops-availability.md @@ -0,0 +1 @@ +AutoOps is automatically available in [{{ech}} deployments](/deploy-manage/monitor/autoops/autoops-for-cloud-hosted.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. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops-vs-stack-monitoring.md b/deploy-manage/monitor/autoops-vs-stack-monitoring.md index 66e79d33a9..cfe15d6fdc 100644 --- a/deploy-manage/monitor/autoops-vs-stack-monitoring.md +++ b/deploy-manage/monitor/autoops-vs-stack-monitoring.md @@ -69,7 +69,7 @@ You can store your Stack Monitoring logs and metrics in the following ways: ### Availability #### AutoOps [ao-availability] -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. +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. #### Stack Monitoring [sm-availability] Once setup is complete, you can access the Stack Monitoring UI inside {{kib}}, where you can monitor all your {{stack}} components. diff --git a/deploy-manage/monitor/autoops.md b/deploy-manage/monitor/autoops.md index c211e5d620..a28e91334f 100644 --- a/deploy-manage/monitor/autoops.md +++ b/deploy-manage/monitor/autoops.md @@ -23,8 +23,7 @@ AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing r :alt: Screenshot showing the Overview page in AutoOps ::: - -## AutoOps key features [ec_autoops_key_features] +## Key features in AutoOps [ec_autoops_key_features] * Real-time root-cause analysis for hundreds of issues. * Accurate resolution paths and customized recommendations. @@ -38,38 +37,41 @@ AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing r * Unbalanced loads between nodes. * Indexing latency, rejections, search latency, high index/search queues, and slow queries. * Resource utilization. +* Multi-deployment dashboard to quickly spot issues across all clusters. +* Possibility to customize event triggers and connect to different notification services such as PagerDuty, Slack, MS Teams, and webhooks. +* Coming soon: Long-term reports for sustained evaluation. +## Regions where AutoOps is available +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. -## Additional capabilities [ec_additional_capabilities] +## Deployment types where AutoOps is available -* Multi-deployment dashboard to quickly spot issues across all clusters. -* Possibility to customize event triggers and connect to different notification services such as PagerDuty, Slack, MS Teams, and webhooks. -* Long-term reports for sustained evaluation. This feature is currently not available and will be rolled out shortly. +:::{include} /deploy-manage/monitor/_snippets/autoops-availability.md +::: -## AutoOps availability +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. -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). +## How AutoOps is licensed -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. +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 +::: -## AutoOps retention period [ec_autoops_retention_period] +## How long AutoOps retains data [ec_autoops_retention_period] AutoOps currently has a 10 day retention period. +## What AutoOps monitors [ec_autoops_scope] -## AutoOps scope [ec_autoops_scope] - -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. +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. ## Section overview In this section, you'll find the following information: -* How to [use AutoOps in your {{ech}} deployments](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md). +* How to [use AutoOps in your {{ech}} deployments](/deploy-manage/monitor/autoops/autoops-for-cloud-hosted.md). * How to [use AutoOps in your {{serverless-full}} projects](/deploy-manage/monitor/autoops/autoops-for-serverless.md). * How to [connect your ECE, ECK, or self-managed clusters](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md) to AutoOps. * [Regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md) where AutoOps is available. -* 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). -* Which [views](/deploy-manage/monitor/autoops/views.md) AutoOps offers to gain insight into your deployment. * [Frequently asked questions](/deploy-manage/monitor/autoops/ec-autoops-faq.md) about AutoOps. diff --git a/deploy-manage/monitor/autoops/autoops-for-cloud-hosted.md b/deploy-manage/monitor/autoops/autoops-for-cloud-hosted.md new file mode 100644 index 0000000000..7fd956a1b7 --- /dev/null +++ b/deploy-manage/monitor/autoops/autoops-for-cloud-hosted.md @@ -0,0 +1,26 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/cloud/current/ec-autoops-how-to-access.html +applies_to: + deployment: + ess: all +products: + - id: cloud-hosted +navigation_title: For {{ech}} +--- + +# AutoOps for {{ech}} + +For [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) deployments, AutoOps is set up and enabled automatically in all supported [regions](ec-autoops-regions.md#autoops-for-ech-regions). More regions are coming soon. + +## Section overview + +In this section, you'll find the following information: + +* How to [access AutoOps in your {{ech}} deployment](ec-autoops-how-to-access.md). +* Which [views](/deploy-manage/monitor/autoops/views.md) AutoOps offers to gain insight into your deployment. +* 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). + +:::{tip} +Refer to our [FAQ](/deploy-manage/monitor/autoops/ec-autoops-faq.md) for answers to frequently asked questions about AutoOps. +::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/autoops-for-serverless.md b/deploy-manage/monitor/autoops/autoops-for-serverless.md index a514b3cad7..56d0338b8f 100644 --- a/deploy-manage/monitor/autoops/autoops-for-serverless.md +++ b/deploy-manage/monitor/autoops/autoops-for-serverless.md @@ -69,7 +69,7 @@ Let’s say you ingest 1TB of data into your Observability project. * **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. ::: -## Coming soon +## Coming soon to AutoOps for Serverless The following features are coming soon to AutoOps for {{serverless-short}}: @@ -85,3 +85,6 @@ In this section, you'll find the following information: * 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. * How to use the [Search AI Lake view](search-ai-lake-view-autoops-serverless.md) to drill down into your storage-related usage. +:::{tip} +Refer to our [FAQ](/deploy-manage/monitor/autoops/ec-autoops-faq.md) for answers to frequently asked questions about AutoOps. +::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md b/deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md new file mode 100644 index 0000000000..31a27d38ad --- /dev/null +++ b/deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md @@ -0,0 +1,150 @@ +--- +applies_to: + deployment: + self: + ece: + eck: +navigation_title: Firewalls blocking Elastic Agent +products: + - id: cloud-kubernetes + - id: cloud-enterprise +--- + +# Troubleshoot firewalls blocking {{agent}} + +If you are running into issues connecting your cluster to AutoOps, a corporate firewall might be blocking {{agent}}. + +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: + +:::{include} /deploy-manage/monitor/_snippets/autoops-cc-components.md +::: + +The following subsections describe how to test each of these components to find out where the problem lies, and then 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. +::: + +## 1. Test {{agent}}'s connection with your cluster +If there is an issue with the first component, {{agent}} cannot connect to your cluster. + +To test if your organization is not allowing this connection, run the following command depending on your chosen authentication method: + +:::::{tab-set} +:group: api-key-or-basic + +::::{tab-item} API key +:sync: api-key + +```json +curl -XGET -i $AUTOOPS_ES_URL \ +-H "Authorization: ApiKey $AUTOOPS_ES_API_KEY" +``` +:::: + +::::{tab-item} Basic +:sync: basic + +```json +curl -XGET -i $AUTOOPS_ES_URL \ +-u $AUTOOPS_ES_USERNAME +``` +:::: + +::::: + +The command should return a response similar to: + +```json +{ +"name" : "1c72f00a6195", +"cluster_name" : "my-ccm-cluster", +"cluster_uuid" : "2O_EjO6kTR6AEVYwL5fPEw", +"version" : { +"number" : "9.1.3", +"build_flavor" : "default", +"build_type" : "docker", +"build_hash" : "0c781091a2f57de895a73a1391ff8426c0153c8d", +"build_date" : "2025-08-24T22:05:04.526302670Z", +"build_snapshot" : false, +"lucene_version" : "10.2.2", +"minimum_wire_compatibility_version" : "8.19.0", +"minimum_index_compatibility_version" : "8.0.0" +}, +"tagline" : "You Know, for Search" +} +``` + +If you do not receive a similar response, your system will return an error indicating one or more reasons for failure as outlined in the following table. Use the corresponding proposed solution to fix the issue. + +| Reason for failure | Proposed solution | +| :--- | :--- | +| The {{es}} endpoint URL you specified is incorrect/not reachable | - Make sure you are using `http` or `https` correctly.
- Make sure you are providing the correct port. The default port is **9200**.
- If you have verified that the URL is correct, your network team may need to open the firewall to allow-list this URL. | +| Your API key is incorrect | - Recheck for typos.
- 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:

`echo $AUTOOPS_ES_API_KEY | base64 -d`

If your key has a colon (:), it is not base64 encoded. If your key has an equal sign (=), it is base64 coded.
For versions 9.1.4 and above, both formats will work.| +| Your username and/or password are incorrect | - Recheck for typos.
- 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.| +| You are providing both the API key and username/password | Choose one type of authentication only. | +| A proxy is blocking communication with your {{es}} cluster | You may have to configure `NO_PROXY`. | +| 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.

If you are using API key authentication, run the following command:

`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -H "Authorization: ApiKey $AUTOOPS_ES_API_KEY"`.

If you are using username/password authentication, run the following command:

`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -u $AUTOOPS_ES_USERNAME`

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/).| +| 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).
- 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 \`. | + +## 2. Test your cluster's registration with {{ecloud}} + +If there is an issue with the second component, the agent will stop working and your logs might look like: + +```sh +... failed to register Cloud Connected Mode: ... Post \"https://api.elastic-cloud.com/api/v1/cloud-connected/clusters\": ... +``` + +To test if your organization is not allowing the agent to register your cluster with {{ecloud}}, run the following command: + +```json +curl -XPOST -i \ +https://api.elastic-cloud.com/api/v1/cloud-connected/clusters \ +-H 'Content-Type: application/json' \ +-d '{"self_managed_cluster": {"id": "my-cluster-uuid", "name": "my-cluster-name", "version": "9.1.0"}, "license": {"uid": "my-license-id", "type": "basic"}}' +``` + +The command should return an HTTP 401 response similar to: + +```json + {"UnauthorizedMessages":["Invalid credential headers"],"Cause":null} +``` +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): + +```json + POST https://api.elastic-cloud.com/api/v1/cloud-connected/clusters +``` +:::{note} +If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables. +::: + +## 3. Test if {{agent}} is able to send metrics + +If there is an issue with the third component, the agent will attempt to establish the connection and your logs might look like: + +```sh +... 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\": ... +``` + +To test if your organization is not allowing the agent to send metrics from your cluster to {{ecloud}}, run the following command. We will use AWS eu-west-1 as the CSP region, but you should replace it with your chosen CSP region before running the command. + +```json +curl -XPOST -i \ +https://otel-collector.auto-ops.eu-west-1.aws.cloud.elastic.co:4318/v1/logs \ +-H 'Content-Type: application/json' + +``` +The command should return an HTTP 401 response similar to: + +```json + {"code":16,"message":"no auth provided"} +``` + +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): + +```json + POST https://otel-collector.auto-ops.${REGION}.${CSP}.cloud.elastic.co:4318/v1/logs +``` +:::{note} +If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables. +::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md index 750ea277da..32b7f00cd4 100644 --- a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -29,9 +29,6 @@ To connect your ECE, ECK, or self-managed cluster to AutoOps, you have to use yo For instructions on how to get started, refer to [](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). -After this setup is complete, you can start using AutoOps to monitor your cluster. Learn more about what you can do with AutoOps in [views](/deploy-manage/monitor/autoops/views.md) and [events](/deploy-manage/monitor/autoops/ec-autoops-events.md). - - ## Section overview In this section, you'll find the following information: @@ -39,8 +36,9 @@ In this section, you'll find the following information: * How to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md) * How to [connect your local development cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md) * How to [manage users of your connected clusters](/deploy-manage/monitor/autoops/cc-manage-users.md) +* [What you can do with AutoOps in your cluster](/deploy-manage/monitor/autoops/use-autoops-in-sm-cluster.md) * A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter :::{tip} -Refer to our [FAQ](/deploy-manage/monitor/autoops/ec-autoops-faq.md#questions-about-autoops-for-self-managed-clusters) for answers to commonly asked questions about AutoOps for self-managed clusters. +Refer to our [FAQ](/deploy-manage/monitor/autoops/ec-autoops-faq.md#questions-about-autoops-for-self-managed-clusters) for answers to frequently asked questions about AutoOps for self-managed clusters. ::: \ No newline at end of file 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 2083f03a27..be8ac8d643 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -38,133 +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'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. - ::: - - 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: - - :::{include} /deploy-manage/monitor/_snippets/autoops-cc-components.md - ::: - - If there is an issue with the first component, {{agent}} cannot connect to your cluster. To test if your organization is not allowing this connection, run the following command depending on your chosen authentication method: - - :::::{tab-set} - :group: api-key-or-basic - - ::::{tab-item} API key - :sync: api-key - - ```json - curl -XGET -i $AUTOOPS_ES_URL \ - -H "Authorization: ApiKey $AUTOOPS_ES_API_KEY" - ``` - :::: - - ::::{tab-item} Basic - :sync: basic - - ```json - curl -XGET -i $AUTOOPS_ES_URL \ - -u $AUTOOPS_ES_USERNAME - ``` - :::: - - ::::: - - The command should return a response similar to: - - ```json -{ - "name" : "1c72f00a6195", - "cluster_name" : "my-ccm-cluster", - "cluster_uuid" : "2O_EjO6kTR6AEVYwL5fPEw", - "version" : { - "number" : "9.1.3", - "build_flavor" : "default", - "build_type" : "docker", - "build_hash" : "0c781091a2f57de895a73a1391ff8426c0153c8d", - "build_date" : "2025-08-24T22:05:04.526302670Z", - "build_snapshot" : false, - "lucene_version" : "10.2.2", - "minimum_wire_compatibility_version" : "8.19.0", - "minimum_index_compatibility_version" : "8.0.0" - }, - "tagline" : "You Know, for Search" -} - ``` - - If you do not receive a similar response, your system will return an error indicating one or more reasons for failure as outlined in the following table. Use the corresponding proposed solution to fix the issue. - - | Reason for failure | Proposed solution | - | :--- | :--- | - | The {{es}} endpoint URL you specified is incorrect/not reachable | - Make sure you are using `http` or `https` correctly.
- Make sure you are providing the correct port. The default port is **9200**.
- If you have verified that the URL is correct, your network team may need to open the firewall to allow-list this URL. | - | Your API key is incorrect | - Recheck for typos.
- 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:

`echo $AUTOOPS_ES_API_KEY | base64 -d`

If your key has a colon (:), it is not base64 encoded. If your key has an equal sign (=), it is base64 coded.
For versions 9.1.4 and above, both formats will work.| - | Your username and/or password are incorrect | - Recheck for typos.
- 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.| - | You are providing both the API key and username/password | Choose one type of authentication only. | - | A proxy is blocking communication with your {{es}} cluster | You may have to configure `NO_PROXY`. | - | 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.

If you are using API key authentication, run the following command:

`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -H "Authorization: ApiKey $AUTOOPS_ES_API_KEY"`.

If you are using username/password authentication, run the following command:

`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -u $AUTOOPS_ES_USERNAME`

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/).| - | 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).
- 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 \`. | - - If there is an issue with the second component, the agent will stop working and your logs might look like: - - ```sh - ... failed to register Cloud Connected Mode: ... Post \"https://api.elastic-cloud.com/api/v1/cloud-connected/clusters\": ... - ``` - - To test if your organization is not allowing the agent to register your cluster with {{ecloud}}, run the following command: - - ```json - curl -XPOST -i \ - https://api.elastic-cloud.com/api/v1/cloud-connected/clusters \ - -H 'Content-Type: application/json' \ - -d '{"self_managed_cluster": {"id": "my-cluster-uuid", "name": "my-cluster-name", "version": "9.1.0"}, "license": {"uid": "my-license-id", "type": "basic"}}' - ``` - - The command should return an HTTP 401 response similar to: - - ```json - {"UnauthorizedMessages":["Invalid credential headers"],"Cause":null} - ``` - 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): - - ```json - POST https://api.elastic-cloud.com/api/v1/cloud-connected/clusters - ``` - :::{note} - If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables. - ::: - - If there is an issue with the third component, the agent will attempt to establish the connection and your logs might look like: - - ```sh - ... 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\": ... - ``` - - To test if your organization is not allowing the agent to send metrics from your cluster to {{ecloud}}, run the following command. We will use AWS eu-west-1 as the CSP region, but you should replace it with your chosen CSP region before running the command. - - ```json - curl -XPOST -i \ - https://otel-collector.auto-ops.eu-west-1.aws.cloud.elastic.co:4318/v1/logs \ - -H 'Content-Type: application/json' - - ``` - The command should return an HTTP 401 response similar to: - - ```json - {"code":16,"message":"no auth provided"} - ``` - - 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): - - ```json - POST https://otel-collector.auto-ops.${REGION}.${CSP}.cloud.elastic.co:4318/v1/logs - ``` - :::{note} - If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables. - ::: +: If you're having issues with connecting your cluster to AutoOps and you suspect that a firewall may be the reason, refer to [](/deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md). ## Potential errors 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 4c22d15d80..c2a06b179c 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 @@ -126,9 +126,9 @@ Depending on your selected installation method, you may have to provide the foll With this authentication method, you need to create an API key to grant access to your cluster. Complete the following steps: -1. Open your self-managed cluster's Kibana +1. Go to {{kib}} in your self-managed cluster. 2. Go to the **API keys** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). -3. Select **Create API key**. +3. Select **Create API key**. 4. In the flyout, enter a name for your key and select **User API key**. 5. Enable **Control security privileges** and enter the following script: ```json @@ -171,7 +171,7 @@ With this authentication method, you need to create an API key to grant access t With this authentication method, you need the username and password of a user with the necessary privileges to grant access to your cluster. There are two ways to set up a user with the these privileges: -* (Recommended) Open your self-managed cluster's Kibana and go to **Developer tools**. In **Console**, run the following command: +* (Recommended) Go to {{kib}} in your self-managed cluster and then go to **Developer tools**. In **Console**, run the following command: ```js POST /_security/role/autoops { @@ -282,6 +282,8 @@ After you've completed the setup, you can access AutoOps for your cluster at any 2. In the **Connected clusters** section, locate the cluster you want to work on. 3. In the **Services** column, select **AutoOps**. +Learn more about [what you can do with AutoOps in your cluster](/deploy-manage/monitor/autoops/use-autoops-in-sm-cluster.md). + ## Connect additional clusters To connect more clusters, we recommend repeating the steps to [connect to AutoOps](#connect-to-autoops). diff --git a/deploy-manage/monitor/autoops/ec-autoops-faq.md b/deploy-manage/monitor/autoops/ec-autoops-faq.md index 896c25403f..6b3e26a934 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-faq.md +++ b/deploy-manage/monitor/autoops/ec-autoops-faq.md @@ -17,11 +17,11 @@ navigation_title: FAQ # AutoOps FAQ [ec-autoops-faq] -Whether you are using AutoOps in your [{{ech}} deployment](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md), [{{serverless-short}} project](/deploy-manage/monitor/autoops/autoops-for-serverless.md), or [self-managed cluster](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md), find answers to some common questions about it on this page. +Whether you are using AutoOps in your [{{ech}} deployment](/deploy-manage/monitor/autoops/autoops-for-cloud-hosted.md), [{{serverless-short}} project](/deploy-manage/monitor/autoops/autoops-for-serverless.md), or [self-managed cluster](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md), find answers to some common questions about it on this page. **General AutoOps questions** * [What does AutoOps do?](#what-is-autoops) -* [Where is AutoOps available?](#autoops-deployment-types) +* [Is AutoOps available in all deployment types?](#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) @@ -53,11 +53,12 @@ Whether you are using AutoOps in your [{{ech}} deployment](/deploy-manage/monito $$$what-is-autoops$$$**What does AutoOps do?** : AutoOps for {{es}} simplifies cluster management by providing performance recommendations, resource utilization and cost insights, real-time issue detection, and resolution paths. By analyzing hundreds of {{es}} metrics, your configuration, and usage patterns, AutoOps provides operational and monitoring recommendations that reduce administration time and hardware costs. -$$$autoops-deployment-types$$$**Where is AutoOps available?** -: In the [regions](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 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/cloud-connect.md). +$$$autoops-deployment-types$$$**Is AutoOps available in all deployment types?** +: :::{include} /deploy-manage/monitor/_snippets/autoops-availability.md +::: $$$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 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. @@ -105,8 +106,8 @@ $$$cc-autoops-ech$$$ **Can I use Cloud Connect to connect my {{ech}} clusters to : :::{include} /deploy-manage/_snippets/autoops-cc-ech-faq.md ::: -$$$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). +$$$macos-install$$$ **Can I use macOS to install {{agent}} to connect my self-managed cluster to AutoOps?** +: No, macOS is not a supported platform for installing {{agent}} and connecting a self-managed cluster to AutoOps. Refer to [Install agent](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#install-agent) for a list of supported platforms. 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. 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 a0ffc63d75..68691e1288 100644 --- a/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md +++ b/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md @@ -6,14 +6,10 @@ applies_to: ess: all products: - id: cloud-hosted -navigation_title: For {{ech}} +navigation_title: Access AutoOps in your deployment --- -# AutoOps for {{ech}} - -For [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) deployments, AutoOps is set up and enabled automatically in all supported [regions](ec-autoops-regions.md#autoops-for-ech-regions). More regions are coming soon. - -## How to access AutoOps [ec-autoops-how-to-access] +# How to access AutoOps in your deployment [ec-autoops-how-to-access] To access AutoOps from your {{ecloud}} console, follow these steps: diff --git a/deploy-manage/monitor/autoops/use-autoops-in-sm-cluster.md b/deploy-manage/monitor/autoops/use-autoops-in-sm-cluster.md new file mode 100644 index 0000000000..71777263f4 --- /dev/null +++ b/deploy-manage/monitor/autoops/use-autoops-in-sm-cluster.md @@ -0,0 +1,23 @@ +--- +applies_to: + deployment: + self: + ece: + eck: +navigation_title: Use AutoOps +products: + - id: cloud-kubernetes + - id: cloud-enterprise +--- + +# Use AutoOps in your self-managed cluster + +After successfully connecting your self-managed cluster to {{ecloud}}, you can start using AutoOps. + +## Views in AutoOps + +AutoOps offers insights into your cluster by continuously monitoring hundreds of metrics. These insights are presented in a number of views depending on which aspect of your cluster you want to inspect. Learn more about [](/deploy-manage/monitor/autoops/views.md). + +## Events in AutoOps + +When AutoOps finds an issue while monitoring your cluster, it creates an event to give you a detailed root-cause analysis for the issue as well as recommendations to resolve it. Learn more about [](/deploy-manage/monitor/autoops/ec-autoops-events.md). \ No newline at end of file diff --git a/deploy-manage/monitor/stack-monitoring.md b/deploy-manage/monitor/stack-monitoring.md index db3b3ea957..c68847880f 100644 --- a/deploy-manage/monitor/stack-monitoring.md +++ b/deploy-manage/monitor/stack-monitoring.md @@ -18,9 +18,9 @@ products: ::: :::{admonition} Simplify monitoring with AutoOps -Use [AutoOps](/deploy-manage/monitor/autoops.md) in your {{ech}}, ECE, ECK, or self-managed deployments. +Use [AutoOps](/deploy-manage/monitor/autoops.md) in your {{ech}} deployments, {{serverless-short}} projects, and ECE, ECK, or self-managed clusters. -AutoOps is a monitoring tool that simplifies cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths. 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). +AutoOps is a monitoring tool that simplifies cluster management through performance recommendations, resource utilization visibility, and real-time issue detection with resolution paths. To help you make your decision, refer to [](/deploy-manage/monitor/autoops-vs-stack-monitoring.md). ::: diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 8b4773bbf1..4fe7c702a6 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -664,32 +664,37 @@ toc: children: - file: monitor/autoops.md children: - - file: monitor/autoops/ec-autoops-how-to-access.md + - file: monitor/autoops/autoops-for-cloud-hosted.md + children: + - file: monitor/autoops/ec-autoops-how-to-access.md + - file: monitor/autoops/views.md + children: + - file: monitor/autoops/ec-autoops-overview-view.md + - file: monitor/autoops/ec-autoops-deployment-view.md + - file: monitor/autoops/ec-autoops-nodes-view.md + - file: monitor/autoops/ec-autoops-index-view.md + - file: monitor/autoops/ec-autoops-shards-view.md + - file: monitor/autoops/ec-autoops-template-optimizer.md + - hidden: monitor/autoops/ec-autoops-dismiss-event.md + - file: monitor/autoops/ec-autoops-events.md + children: + - file: monitor/autoops/ec-autoops-event-settings.md + - file: monitor/autoops/ec-autoops-notifications-settings.md - file: monitor/autoops/autoops-for-serverless.md children: - - file: monitor/autoops/access-autoops-for-serverless.md - - file: monitor/autoops/search-tier-view-autoops-serverless.md - - file: monitor/autoops/search-ai-lake-view-autoops-serverless.md + - file: monitor/autoops/access-autoops-for-serverless.md + - file: monitor/autoops/search-tier-view-autoops-serverless.md + - file: monitor/autoops/search-ai-lake-view-autoops-serverless.md - file: monitor/autoops/cc-autoops-as-cloud-connected.md children: - - file: monitor/autoops/cc-connect-self-managed-to-autoops.md - - file: monitor/autoops/cc-connect-local-dev-to-autoops.md - - file: monitor/autoops/cc-manage-users.md - - file: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md + - file: monitor/autoops/cc-connect-self-managed-to-autoops.md + - file: monitor/autoops/cc-connect-local-dev-to-autoops.md + - file: monitor/autoops/cc-manage-users.md + - file: monitor/autoops/use-autoops-in-sm-cluster.md + - file: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md + children: + - file: monitor/autoops/autoops-sm-troubleshoot-firewalls.md - file: monitor/autoops/ec-autoops-regions.md - - file: monitor/autoops/ec-autoops-events.md - children: - - file: monitor/autoops/ec-autoops-event-settings.md - - file: monitor/autoops/ec-autoops-notifications-settings.md - - file: monitor/autoops/views.md - children: - - file: monitor/autoops/ec-autoops-overview-view.md - - file: monitor/autoops/ec-autoops-deployment-view.md - - file: monitor/autoops/ec-autoops-nodes-view.md - - file: monitor/autoops/ec-autoops-index-view.md - - file: monitor/autoops/ec-autoops-shards-view.md - - file: monitor/autoops/ec-autoops-template-optimizer.md - - hidden: monitor/autoops/ec-autoops-dismiss-event.md - file: monitor/autoops/ec-autoops-faq.md - file: monitor/stack-monitoring.md children: