Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[troubleshoot] Replace AsciiDoc API links #434

Merged
merged 2 commits into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion troubleshoot/deployments/cloud-on-k8s/common-problems.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Possible causes include:
elasticsearch.elasticsearch.k8s.elastic.co/elasticsearch-sample yellow 1 7.9.2 Ready 3m50s
```

In this case, you have to [check](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html) and fix your shard allocations. The [cluster health](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html), [cat shards](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html), and [get Elasticsearch](../../../deploy-manage/deploy/cloud-on-k8s/elasticsearch-deployment-quickstart.md#k8s-elasticsearch-monitor-cluster-health) APIs can assist in tracking the shard recover process.
In this case, you have to [check](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) and fix your shard allocations. The [cluster health](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health), [cat shards](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards), and [get Elasticsearch](../../../deploy-manage/deploy/cloud-on-k8s/elasticsearch-deployment-quickstart.md#k8s-elasticsearch-monitor-cluster-health) APIs can assist in tracking the shard recover process.

* Scheduling issues

Expand Down
2 changes: 1 addition & 1 deletion troubleshoot/elasticsearch/add-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ mapped_pages:

# Troubleshoot broken repositories [add-repository]

There are several situations where the [Health API](https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html) might report an issue regarding the integrity of snapshot repositories in the cluster. The following pages explain the recommended actions for diagnosing corrupted, unknown, and invalid repositories:
There are several situations where the [Health API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report) might report an issue regarding the integrity of snapshot repositories in the cluster. The following pages explain the recommended actions for diagnosing corrupted, unknown, and invalid repositories:

* [Diagnosing corrupted repositories](diagnosing-corrupted-repositories.md)
* [Diagnosing unknown repositories](diagnosing-unknown-repositories.md)
Expand Down
4 changes: 2 additions & 2 deletions troubleshoot/elasticsearch/add-tier.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In order to get the shards assigned we need enable a new tier in the deployment.
:class: screenshot
:::

4. Determine which tier an index expects for assignment. [Retrieve](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html) the configured value for the `index.routing.allocation.include._tier_preference` setting:
4. Determine which tier an index expects for assignment. [Retrieve](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) the configured value for the `index.routing.allocation.include._tier_preference` setting:

```console
GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings
Expand Down Expand Up @@ -64,7 +64,7 @@ In order to get the shards assigned we need enable a new tier in the deployment.
::::::{tab-item} Self-managed
In order to get the shards assigned you can add more nodes to your {{es}} cluster and assign the index’s target tier [node role](../../manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles.md#assign-data-tier) to the new nodes.

To determine which tier an index requires for assignment, use the [get index setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting:
To determine which tier an index requires for assignment, use the [get index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) API to retrieve the configured value for the `index.routing.allocation.include._tier_preference` setting:

```console
GET /my-index-000001/_settings/index.routing.allocation.include._tier_preference?flat_settings
Expand Down
12 changes: 6 additions & 6 deletions troubleshoot/elasticsearch/allow-all-cluster-allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In order to (re)allow all data to be allocated follow these steps:
::::::{tab-item} Elasticsearch Service
In order to get the shards assigned we’ll need to change the value of the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html#cluster-routing-allocation-enable) that restricts the assignemnt of the shards to allow all shards to be allocated.

We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html) and changing the configured value to `all`.
We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) and changing the configured value to `all`.

**Use {{kib}}**

Expand All @@ -35,7 +35,7 @@ We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.e
:class: screenshot
:::

4. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html):
4. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings):

```console
GET /_cluster/settings?flat_settings
Expand All @@ -54,7 +54,7 @@ We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.e

1. Represents the current configured value that controls if data is partially or fully allowed to be allocated in the system.

5. [Change](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html#cluster-routing-allocation-enable) value to allow all the data in the system to be fully allocated:
5. [Change](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html#cluster-routing-allocation-enable) value to allow all the data in the system to be fully allocated:

```console
PUT _cluster/settings
Expand All @@ -71,9 +71,9 @@ We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.e
::::::{tab-item} Self-managed
In order to get the shards assigned we’ll need to change the value of the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html#cluster-routing-allocation-enable) that restricts the assignemnt of the shards to allow all shards to be allocated.

We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html) and changing the configured value to `all`.
We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) and changing the configured value to `all`.

1. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html):
1. Inspect the `cluster.routing.allocation.enable` [cluster setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings):

```console
GET /_cluster/settings?flat_settings
Expand All @@ -92,7 +92,7 @@ We’ll achieve this by inspecting the system-wide `cluster.routing.allocation.e

1. Represents the current configured value that controls if data is partially or fully allowed to be allocated in the system.

2. [Change](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html#cluster-routing-allocation-enable) value to allow all the data in the system to be fully allocated:
2. [Change](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html#cluster-routing-allocation-enable) value to allow all the data in the system to be fully allocated:

```console
PUT _cluster/settings
Expand Down
8 changes: 4 additions & 4 deletions troubleshoot/elasticsearch/allow-all-index-allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In order to get the shards assigned we’ll need to change the value of the [con
:class: screenshot
:::

4. Inspect the `index.routing.allocation.enable` [index setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html) for the index with unassigned shards:
4. Inspect the `index.routing.allocation.enable` [index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) for the index with unassigned shards:

```console
GET /my-index-000001/_settings/index.routing.allocation.enable?flat_settings
Expand All @@ -56,7 +56,7 @@ In order to get the shards assigned we’ll need to change the value of the [con

1. Represents the current configured value that controls if the index is allowed to be partially or totally allocated.

5. [Change](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-routing-allocation-enable-setting) value to allow the index to be fully allocated:
5. [Change](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-routing-allocation-enable-setting) value to allow the index to be fully allocated:

```console
PUT /my-index-000001/_settings
Expand All @@ -73,7 +73,7 @@ In order to get the shards assigned we’ll need to change the value of the [con
::::::{tab-item} Self-managed
In order to get the shards assigned we’ll need to change the value of the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-routing-allocation-enable-setting) that restricts the assignemnt of the shards to `all`.

1. Inspect the `index.routing.allocation.enable` [index setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html) for the index with unassigned shards:
1. Inspect the `index.routing.allocation.enable` [index setting](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) for the index with unassigned shards:

```console
GET /my-index-000001/_settings/index.routing.allocation.enable?flat_settings
Expand All @@ -93,7 +93,7 @@ In order to get the shards assigned we’ll need to change the value of the [con

1. Represents the current configured value that controls if the index is allowed to be partially or totally allocated.

2. [Change](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-routing-allocation-enable-setting) value to allow the index to be fully allocated:
2. [Change](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings) the [configuration](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-routing-allocation-enable-setting) value to allow the index to be fully allocated:

```console
PUT /my-index-000001/_settings
Expand Down
6 changes: 3 additions & 3 deletions troubleshoot/elasticsearch/circuit-breaker-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ Caused by: org.elasticsearch.common.breaker.CircuitBreakingException: [parent] D

If you’ve enabled Stack Monitoring, you can view JVM memory usage in {{kib}}. In the main menu, click **Stack Monitoring**. On the Stack Monitoring **Overview*** page, click ***Nodes**. The **JVM Heap** column lists the current memory usage for each node.

You can also use the [cat nodes API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html) to get the current `heap.percent` for each node.
You can also use the [cat nodes API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes) to get the current `heap.percent` for each node.

```console
GET _cat/nodes?v=true&h=name,node*,heap*
```

To get the JVM memory usage for each circuit breaker, use the [node stats API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html).
To get the JVM memory usage for each circuit breaker, use the [node stats API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats).

```console
GET _nodes/stats/breaker
Expand All @@ -72,7 +72,7 @@ For high-cardinality `text` fields, fielddata can use a large amount of JVM memo

**Clear the fielddata cache**

If you’ve triggered the fielddata circuit breaker and can’t disable fielddata, use the [clear cache API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html) to clear the fielddata cache. This may disrupt any in-flight searches that use fielddata.
If you’ve triggered the fielddata circuit breaker and can’t disable fielddata, use the [clear cache API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache) to clear the fielddata cache. This may disrupt any in-flight searches that use fielddata.

```console
POST _cache/clear?fielddata=true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ In order to estimate how many replicas need to be removed, first you need to est
green logs-000001 1 0 7.7gb 7.7gb
```

5. In the list above we see that if we reduce the replicas to 1 of the indices `my_index` and `my_other_index` we will release the required disk space. It is not necessary to reduce the replicas of `search-products` and `logs-000001` does not have any replicas anyway. Reduce the replicas of one or more indices with the [index update settings API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html):
5. In the list above we see that if we reduce the replicas to 1 of the indices `my_index` and `my_other_index` we will release the required disk space. It is not necessary to reduce the replicas of `search-products` and `logs-000001` does not have any replicas anyway. Reduce the replicas of one or more indices with the [index update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings):

::::{warning}
Reducing the replicas of an index can potentially reduce search throughput and data redundancy.
Expand Down
Loading
Loading