Skip to content

Commit 0b0cc2a

Browse files
Merge branch 'main' of github.com:elastic/docs-content into kib-esql-818-updates
2 parents a6a3750 + 70151e9 commit 0b0cc2a

File tree

916 files changed

+1783
-6424
lines changed

Some content is hidden

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

916 files changed

+1783
-6424
lines changed

deploy-manage/autoscaling/autoscaling-deciders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ The [autoscaling](../../deploy-manage/autoscaling.md) {{ml}} decider (`ml`) calc
122122
The {{ml}} decider is enabled for policies governing `ml` nodes.
123123

124124
::::{note}
125-
For {{ml}} jobs to open when the cluster is not appropriately scaled, set `xpack.ml.max_lazy_ml_nodes` to the largest number of possible {{ml}} nodes (refer to [Advanced machine learning settings](elasticsearch://reference/elasticsearch/configuration-reference/machine-learning-settings.md#advanced-ml-settings) for more information). In {{ess}}, this is automatically set.
125+
For {{ml}} jobs to open when the cluster is not appropriately scaled, set `xpack.ml.max_lazy_ml_nodes` to the largest number of possible {{ml}} nodes (refer to [Advanced machine learning settings](elasticsearch://reference/elasticsearch/configuration-reference/machine-learning-settings.md#advanced-ml-settings) for more information). In {{ech}}, this is automatically set.
126126
::::
127127

128128

deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,9 +220,8 @@ Note the following requirements when you run this API request:
220220

221221
$$$ece-autoscaling-api-example-requirements-table$$$
222222

223-
| | | | |
224-
| --- | --- | --- | --- |
225223
| | `size` | `autoscaling_min` | `autoscaling_max` |
224+
| --- | --- | --- | --- |
226225
| data tier ||||
227226
| machine learning node ||||
228227
| coordinating and master nodes ||||

deploy-manage/deploy/elastic-cloud.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ applies_to:
44
deployment:
55
ess: ga
66
mapped_pages:
7-
- https://www.elastic.co/guide/en/serverless/current/intro.html#general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud
7+
- https://www.elastic.co/guide/en/serverless/current/intro.html
88
---
99

1010
# Elastic Cloud [intro]
@@ -38,9 +38,8 @@ For more information, refer to [](/deploy-manage/cloud-organization.md).
3838
You can have multiple hosted deployments and serverless projects in the same {{ecloud}} organization, and each deployment type has its own specificities.
3939

4040

41-
| | | |
42-
| --- | --- | --- |
4341
| Option | Serverless | Hosted |
42+
| --- | --- | --- |
4443
| **Cluster management** | Fully managed by Elastic. | You provision and manage your hosted clusters. Shared responsibility with Elastic. |
4544
| **Scaling** | Autoscales out of the box. | Manual scaling or autoscaling available for you to enable. |
4645
| **Upgrades** | Automatically performed by Elastic. | You choose when to upgrade. |

deploy-manage/deploy/elastic-cloud/azure-marketplace-pricing.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@ The pricing plan update enables us to align with market trends and adapt to chan
2323

2424
These pricing changes will apply to customers who are currently paying for Azure Marketplace services in non-USD currencies. If you are paying in USD, your pricing and billing will remain unchanged.
2525

26-
| | | |
27-
| --- | --- | --- |
2826
| Currency | Price | Elastic Billing Units for Azure† |
27+
| --- | --- | --- |
2928
| USD | 1.00 | $0.10 per 1000 units |
3029
| AUD | 1.60 | $0.16 per 1000 units |
3130
| BRL | 5.40 | R$0.54 per 1000 units |

deploy-manage/monitor/cloud-health-perf.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can also search and filter the table based on affected resources, such as in
4545
:alt: {{es}} Health page with details and troubleshooting
4646
:::
4747

48-
For each issue you can either use a troubleshooting link or get a suggestion to contact support, in case you need help. The [troubleshooting documentation](/troubleshoot/elasticsearch/elasticsearch.md) for {{es}} provides more details on specific errors.
48+
For more information about specific errors, refer to [](/troubleshoot/elasticsearch.md). You can also [contact us](/troubleshoot/index.md#contact-us) if you need more help.
4949

5050
### Health warnings [ec-es-health-warnings]
5151

@@ -74,7 +74,7 @@ deployment:
7474
ess:
7575
```
7676

77-
{{ess}} deployments offer an additional **Performance** page to get further information about your cluster performance.
77+
{{ech}} deployments offer an additional **Performance** page to get further information about your cluster performance.
7878

7979
If you observe issues on search and ingest operations in terms of increased latency or throughput for queries, these might not be directly reported on the **Health** page, unless they are related to shard health or master node availability.
8080

@@ -131,23 +131,23 @@ If you need your cluster to be able to sustain a certain level of performance, y
131131

132132
We’ve compiled some guidelines to help you ensure the health of your deployments over time. These can help you to better understand the available performance metrics, and to make decisions involving performance and high availability.
133133

134-
[Why is my node(s) unavailable?](/troubleshoot/monitoring/unavailable-nodes.md)
134+
[](/troubleshoot/monitoring/unavailable-nodes.md)
135135
: Learn about common symptoms and possible actions that you can take to resolve issues when one or more nodes become unhealthy or unavailable.
136136

137-
[Why are my shards unavailable?](/troubleshoot/monitoring/unavailable-shards.md)
137+
[](/troubleshoot/monitoring/unavailable-shards.md)
138138
: Provide instructions on how to troubleshoot issues related to unassigned shards.
139139

140-
[Why is performance degrading over time?](/troubleshoot/monitoring/performance.md)
140+
[](/troubleshoot/monitoring/performance.md)
141141
: Address performance degradation on a smaller size Elasticsearch cluster.
142142

143-
[Is my cluster really highly available?](/troubleshoot/monitoring/high-availability.md)
143+
[](/troubleshoot/monitoring/high-availability.md)
144144
: High availability involves more than setting multiple availability zones (although that’s really important!). Learn how to assess performance and workloads to determine if your deployment has adequate resources to mitigate a potential node failure.
145145

146-
[How does high memory pressure affect performance?](/troubleshoot/monitoring/high-memory-pressure.md)
146+
[](/troubleshoot/monitoring/high-memory-pressure.md)
147147
: Learn about typical memory usage patterns, how to assess when the deployment memory usage levels are problematic, how this impacts performance, and how to resolve memory-related issues.
148148

149-
[Why are my cluster response times suddenly so much worse?](/troubleshoot/monitoring/cluster-response-time.md)
149+
[](/troubleshoot/monitoring/cluster-response-time.md)
150150
: Learn about the common causes of increased query response times and decreased performance in your deployment.
151151

152-
[Why did my node move to a different host?](/troubleshoot/monitoring/node-moves-outages.md)
152+
[](/troubleshoot/monitoring/node-moves-outages.md)
153153
: Learn about why we may, from time to time, relocate your {{ech}} deployments across hosts.

deploy-manage/monitor/orchestrators/ece-proxy-log-fields.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@ These fields *are* subject to change, though the vast majority of them are gener
1313
::::
1414

1515

16-
| | |
17-
| --- | --- |
1816
| Field | Description |
17+
| --- | --- |
1918
| `proxy_ip` | the IP on the connection, i.e. a proxy IP if the request has been proxied |
2019
| `request_end` | the time the request was returned in ms since unix epoch |
2120
| `status_code` | the HTTP status returned to the client |

deploy-manage/production-guidance/optimize-performance/size-shards.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,33 @@ mapped_pages:
55

66
# Size your shards [size-your-shards]
77

8-
Each index in {{es}} is divided into one or more shards, each of which may be replicated across multiple nodes to protect against hardware failures. If you are using [Data streams](../../../manage-data/data-store/data-streams.md) then each data stream is backed by a sequence of indices. There is a limit to the amount of data you can store on a single node so you can increase the capacity of your cluster by adding nodes and increasing the number of indices and shards to match. However, each index and shard has some overhead and if you divide your data across too many shards then the overhead can become overwhelming. A cluster with too many indices or shards is said to suffer from *oversharding*. An oversharded cluster will be less efficient at responding to searches and in extreme cases it may even become unstable.
8+
## What is a shard? [what-is-a-shard]
99

10+
A shard is a basic unit of storage in {{es}}. Every index is divided into one or more shards to help distribute data and workload across nodes in a cluster. This division allows {{es}} to handle large datasets and perform operations like searches and indexing efficiently. For more detailed information on shards, see [this page](/deploy-manage/distributed-architecture/clusters-nodes-shards.md).
11+
12+
## General guidelines [sizing-shard-guidelines]
13+
14+
Balancing the number and size of your shards is important for the performance and stability of an {{es}} cluster:
15+
16+
* Too many shards can degrade search performance and make the cluster unstable. This is referred to as _oversharding_.
17+
* Very large shards can slow down search operations and prolong recovery times after failures.
18+
19+
To avoid either of these states, implement the following guidelines:
20+
21+
### General sizing guidelines
22+
23+
* Aim for shard sizes between 10GB and 50GB
24+
* Keep the number of documents on each shard below 200 million
25+
26+
### Shard distribution guidelines
27+
28+
To ensure that each node is working optimally, distribute shards evenly across nodes. Uneven distribution can cause some nodes to work harder than others, leading to performance degradation and instability.
29+
30+
While {{es}} automatically balances shards, you need to configure indices with an appropriate number of shards and replicas to allow for even distribution across nodes.
31+
32+
If you are using [data streams](/manage-data/data-store/data-streams.md), each data stream is backed by a sequence of indices, each index potentially having multiple shards.
33+
34+
Despite these general guidelines, it is good to develop a tailored [sharding strategy](#create-a-sharding-strategy) that considers your specific infrastructure, use case, and performance expectations.
1035

1136
## Create a sharding strategy [create-a-sharding-strategy]
1237

deploy-manage/reference-architectures.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ These reference architectures are recommendations and should be adapted to fit y
2525

2626
## Architectures [reference-architectures-time-series]
2727

28-
| | |
28+
| Architecture | When to use |
2929
| --- | --- |
30-
| **Architecture** | **When to use** |
3130
| [*Hot/Frozen - High Availability*](/deploy-manage/reference-architectures/hotfrozen-high-availability.md)<br>A high availability architecture that is cost optimized for large time-series datasets. | * Have a requirement for cost effective long term data storage (many months or years).<br>* Provide insights and alerts using logs, metrics, traces, or various event types to ensure optimal performance and quick issue resolution for applications.<br>* Apply Machine Learning and Search AI to assist in dealing with the large amount of data.<br>* Deploy an architecture model that allows for maximum flexibility between storage cost and performance.<br> |
3231
| Additional architectures are on the way.<br>Stay tuned for updates. | |
3332

deploy-manage/reference-architectures/hotfrozen-high-availability.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,8 @@ In the links provided above, Elastic has performance tested hardware for each of
6262

6363
This table shows our specific recommendations for nodes in a Hot/Frozen architecture.
6464

65-
| | | | | |
65+
| Type | AWS | Azure | GCP | Physical |
6666
| --- | --- | --- | --- | --- |
67-
| **Type** | **AWS** | **Azure** | **GCP** | **Physical** |
6867
| ![Hot data node](../../images/reference-architectures-hot.png "") | c6gd | f32sv2 | N2 | 16-32 vCPU<br>64 GB RAM<br>2-6 TB NVMe SSD |
6968
| ![Frozen data node](../../images/reference-architectures-frozen.png "") | i3en | e8dsv4 | N2 | 8 vCPU<br>64 GB RAM<br>6-20+ TB NVMe SSD<br>Depending on days cached |
7069
| ![Machine learning node](../../images/reference-architectures-machine-learning.png "") | m6gd | f16sv2 | N2 | 16 vCPU<br>64 GB RAM<br>256 GB SSD |

deploy-manage/security/elastic-cloud-static-ips.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ Not suitable usage of egress static IPs to introduce network controls:
3939
## Supported Regions [ec-regions]
4040

4141
::::{dropdown} AWS
42-
| | | |
42+
| Region | Ingress Static IPs | Egress Static IPs |
4343
| --- | --- | --- |
44-
| **Region** | **Ingress Static IPs** | **Egress Static IPs** |
4544
| aws-af-south-1 | No | Yes |
4645
| aws-ap-east-1 | No | Yes |
4746
| aws-ap-northeast-1 | No | Yes |
@@ -67,9 +66,8 @@ Not suitable usage of egress static IPs to introduce network controls:
6766

6867

6968
::::{dropdown} Azure
70-
| | | |
69+
| Region | Ingress Static IPs | Egress Static IPs |
7170
| --- | --- | --- |
72-
| **Region** | **Ingress Static IPs** | **Egress Static IPs** |
7371
| azure-australiaeast | Yes | Yes |
7472
| azure-brazilsouth | Yes | Yes |
7573
| azure-canadacentral | Yes | Yes |
@@ -91,9 +89,8 @@ Not suitable usage of egress static IPs to introduce network controls:
9189

9290

9391
::::{dropdown} GCP
94-
| | | |
92+
| Region | Ingress Static IPs | Egress Static IPs |
9593
| --- | --- | --- |
96-
| **Region** | **Ingress Static IPs** | **Egress Static IPs** |
9794
| gcp-asia-east1 | Yes | No |
9895
| gcp-asia-northeast1 | Yes | No |
9996
| gcp-asia-northeast3 | Yes | No |

0 commit comments

Comments
 (0)