Skip to content

Commit e95a5af

Browse files
Merge branch 'main' into on-week-improve-code-block-examples
2 parents b5a7eda + 1b014d5 commit e95a5af

File tree

121 files changed

+580
-298
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+580
-298
lines changed

deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This table compares Elasticsearch capabilities between {{ech}} deployments and S
8686
| [**AI Assistant**](/solutions/observability/observability-ai-assistant.md) ||| |
8787
| **Behavioral analytics** | ❌ (deprecated in 9.0) || Not available in Serverless |
8888
| [**Clone index API**](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone) || **Planned** | Anticipated in a future release |
89-
| [**Bulk indexing**](/deploy-manage/production-guidance/optimize-performance/indexing-speed.md#_use_bulk_requests) ||| The maximum bulk request response time in {{serverless-short}} is 200ms |
89+
| [**Bulk indexing**](/deploy-manage/production-guidance/optimize-performance/indexing-speed.md#_use_bulk_requests) ||| The baseline write latency in {{serverless-short}} is 200ms [^1^](#footnote-1) |
9090
| [**Cross-cluster replication**](/deploy-manage/tools/cross-cluster-replication.md) || **Planned** | Anticipated in a future release |
9191
| [**Cross-cluster search**](/solutions/search/cross-cluster-search.md) || **Planned** | Anticipated in a future release |
9292
| **Data lifecycle management** | - [ILM](/manage-data/lifecycle/index-lifecycle-management.md) <br>- [Data stream lifecycle](/manage-data/lifecycle/data-stream.md) | [Data stream lifecycle](/manage-data/lifecycle/data-stream.md) only | - No data tiers in Serverless <br>- Optimized for common lifecycle management needs |
@@ -103,6 +103,8 @@ This table compares Elasticsearch capabilities between {{ech}} deployments and S
103103
| [**Watcher**](/explore-analyze/alerts-cases/watcher.md) ||| Use **Kibana Alerts** instead, which provides rich integrations across use cases |
104104
| **Web crawler** | ❌ (Managed Elastic Crawler discontinued with Enterprise Search in 9.0) | Self-managed only | Use [**self-managed crawler**](https://github.com/elastic/crawler) |
105105

106+
^1^ $$$footnote-1$$$ In {{serverless-short}}, Elastic ensures data durability by storing indexed data in an [object store](https://www.elastic.co/blog/elastic-serverless-architecture) rather than local replicas. Writes are batched over a 200ms window to ensure durability while optimizing performance and cost, which means that single-document indexing can appear slower than in {{ech}}. However, this design makes {{serverless-short}} more scalable and resilient to high indexing loads without relying on in-cluster replication for fault tolerance. Because of a higher baseline write latency, {{serverless-short}} indexing can be scaled by increasing concurrent indexing clients.
107+
106108
### Observability
107109

108110
This table compares Observability capabilities between {{ech}} deployments and Observability Complete Serverless projects. For more information on Observability Logs Essentials Serverless projects, refer to [Observability feature tiers](../../../solutions/observability/observability-serverless-feature-tiers.md).

deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com
2323
2. Create or navigate to an empty directory for the project.
2424
3. Download and save the following files in the project directory:
2525

26-
* [`.env`](https://github.com/elastic/elasticsearch/blob/master/docs/reference/setup/install/docker/.env)
27-
* [`docker-compose.yml`](https://github.com/elastic/elasticsearch/blob/master/docs/reference/setup/install/docker/docker-compose.yml)
26+
* [`.env`](https://github.com/elastic/elasticsearch/blob/main/docs/reference/setup/install/docker/.env)
27+
* [`docker-compose.yml`](https://github.com/elastic/elasticsearch/blob/main/docs/reference/setup/install/docker/docker-compose.yml)
2828

2929
4. In the `.env` file, specify a password for the `ELASTIC_PASSWORD` and `KIBANA_PASSWORD` variables.
3030

@@ -104,4 +104,4 @@ docker-compose down -v
104104

105105
## Next steps [_next_steps_6]
106106

107-
You now have a test {{es}} environment set up. Before you start serious development or go into production with {{es}}, review the [requirements and recommendations](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md) to apply when running {{es}} in Docker in production.
107+
You now have a test {{es}} environment set up. Before you start serious development or go into production with {{es}}, review the [requirements and recommendations](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md) to apply when running {{es}} in Docker in production.

deploy-manage/monitor/autoops.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ products:
1919
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.
2020

2121
:::{image} /deploy-manage/images/cloud-autoops-overview-page.png
22-
:alt: The Overview page
22+
:screenshot:
23+
:alt: Screenshot showing the Overview page in AutoOps
2324
:::
2425

2526

deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ $$$next-steps$$$**After running the installation command, I can't move on to the
3838
: 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).
3939

4040
$$$firewall$$$**My organization's firewall may be preventing {{agent}} from collecting and sending metrics.**
41-
: 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.
41+
: 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.
4242

4343
:::{tip}
4444
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.

deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,10 @@ Select one of the following methods to install {{agent}}:
102102
* **Windows**
103103
-->
104104

105+
:::{note}
106+
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).
107+
:::
108+
105109
:::{important}
106110
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.
107111
:::

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

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,43 +16,51 @@ 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 displays a color-coded heat map to help understand when and how often a particular event happened. Click on any mosaic to get details about a particular event, such as the specific node, index, or shard affected, event time and duration, and a detailed description of the actions you can take to mitigate that event.
3132

33+
Refer to [AutoOps events](ec-autoops-events.md) for more details.
3234

33-
## Events History [ec-events-history]
35+
### Open Events [ec-autoops-open-events]
3436

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

39+
### Events History [ec-events-history]
3740

38-
## Resources [ec-deployment-resources]
41+
The **Events History** panel lists events that were triggered in the past but are no longer active because of changed conditions.
42+
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.
44+
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

4249
:::{image} /deploy-manage/images/cloud-autoops-deployment-resources.png
43-
:alt: The AutoOps Resources panel
50+
:screenshot:
51+
:alt: Screenshot showing the Resources panel in the AutoOps Deployment or Cluster view
4452
:::
4553

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

47-
## Performance [ec-deployment-performance]
48-
49-
The **Performance** panel shows key performance metrics, aggregated at both the cluster level and the selected tier levels:
50-
51-
:::{image} /deploy-manage/images/cloud-autoops-deployment-performance.png
52-
:alt: The AutoOps Deployment Performance
53-
:::
56+
The **Performance** panel shows the following key performance metrics aggregated at both the cluster level and the selected tier levels:
5457

5558
* **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.
5659
* **Search latency**: The average latency of search operations across all shards in the deployment or cluster, and within the selected data tiers.
5760
* **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.
5861
* **Indexing latency**: The average latency of indexing operations across all shards in the deployment or cluster, and within the selected data tiers.
62+
63+
:::{image} /deploy-manage/images/cloud-autoops-deployment-performance.png
64+
:screenshot:
65+
:alt: Screenshot showing the Performance panel in the AutoOps Deployment or Cluster view
66+
:::

deploy-manage/monitor/autoops/ec-autoops-event-settings.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ The event settings include:
3131
* Data roles tier to exclude from indications - Add threshold based on the type of data tier.
3232

3333
:::{image} /deploy-manage/images/cloud-autoops-event-settings.png
34-
:alt: Event settings
34+
:screenshot:
35+
:alt: Screenshot showing the Event Settings dialogue in AutoOps
3536
:::
3637

3738

@@ -42,6 +43,7 @@ The **Event Settings** report provides a list of all the events for which the se
4243
From the **Event Settings** report, you can click **Add** to add new settings, or select the edit icon to modify the existing settings.
4344

4445
:::{image} /deploy-manage/images/cloud-autoops-events-settings-report.png
45-
:alt: Event settings report
46+
:screenshot:
47+
:alt: Screenshot showing the Event Settings page with the Add button
4648
:::
4749

deploy-manage/monitor/autoops/ec-autoops-events.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ You can view events on the **Deployment** page (for {{ECH}} deployments) or the
2727
When you select an event, a flyout appears with insights and context for the detected issue.
2828

2929
:::{image} /deploy-manage/images/cloud-autoops-events.png
30-
:alt: AutoOps events
30+
:screenshot:
31+
:alt: Screenshot showing an AutoOps event flyout
3132
:::
3233

3334
The following table describes the sections in this flyout:

deploy-manage/monitor/autoops/ec-autoops-faq.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Whether you are using AutoOps in your [{{ech}} deployment](/deploy-manage/monito
2323
* [What does AutoOps do?](#what-is-autoops)
2424
* [Where is AutoOps available?](#autoops-deployment-types)
2525
* [Why can't I see AutoOps in some deployments and projects?](#cant-see-autoops)
26+
* [Can I use AutoOps if my environment is air-gapped?](#autoops-air-gapped)
2627
* [How is AutoOps licensed?](#autoops-license)
2728
* [Does AutoOps monitor the entire {{stack}}?](#autoops-monitoring)
2829
* [Can AutoOps automatically resolve issues?](#autoops-issue-resolution)
@@ -38,8 +39,7 @@ Whether you are using AutoOps in your [{{ech}} deployment](/deploy-manage/monito
3839

3940
**Setting up AutoOps for self-managed clusters**
4041
* [Can I use Cloud Connect to connect my {{ech}} clusters to AutoOps?](#cc-autoops-ech)
41-
* [Can I use AutoOps for my clusters if my environment is air-gapped?](#autoops-air-gapped)
42-
* [Can I use macOS to install {{agent}} for this feature?](#macos-install)
42+
* [Can I use macOS to set up AutoOps for my self-managed clusters?](#macos-install)
4343
* [Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?](#elastic-ip-address)
4444

4545
**Collected metrics and data in AutoOps for self-managed clusters**
@@ -59,6 +59,9 @@ $$$autoops-deployment-types$$$**Where is AutoOps available?**
5959
$$$cant-see-autoops$$$**Why can't I see AutoOps in some deployments and projects?**
6060
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.
6161

62+
$$$autoops-air-gapped$$$ **Can I use AutoOps if my environment is air-gapped?**
63+
: 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.
64+
6265
$$$autoops-license$$$**How is AutoOps licensed?**
6366
: 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.
6467
:::{include} /deploy-manage/_snippets/autoops-cc-payment-faq.md
@@ -102,11 +105,8 @@ $$$cc-autoops-ech$$$ **Can I use Cloud Connect to connect my {{ech}} clusters to
102105
: :::{include} /deploy-manage/_snippets/autoops-cc-ech-faq.md
103106
:::
104107

105-
$$$autoops-air-gapped$$$ **Can I use AutoOps for my clusters if my environment is air-gapped?**
106-
: 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.
107-
108-
$$$macos-install$$$ **Can I use macOS to install {{agent}} for this feature?**
109-
: macOS is not a supported platform for installing {{agent}} and connecting your clusters to AutoOps.
108+
$$$macos-install$$$ **Can I use macOS to set up AutoOps for my self-managed clusters?**
109+
: 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).
110110

111111
$$$elastic-ip-address$$$ **Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?**
112112
: You may need to define an IP address if your organization’s settings will block the agent from sending out data.

deploy-manage/monitor/autoops/ec-autoops-how-to-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ To access AutoOps from your {{ecloud}} console, follow these steps:
2323

2424
:::{image} /deploy-manage/images/cloud-autoops-how-to-access.png
2525
:screenshot:
26-
:alt: Screenshot showing the Open AutoOps button
26+
:alt: Screenshot showing the Open AutoOps button on the deployment overview page
2727
:::

0 commit comments

Comments
 (0)