Skip to content

Commit

Permalink
Convert settings back to list
Browse files Browse the repository at this point in the history
Signed-off-by: Fanit Kolchina <[email protected]>
  • Loading branch information
kolchfa-aws committed Dec 16, 2024
1 parent e84acb4 commit 08951cb
Showing 1 changed file with 29 additions and 33 deletions.
62 changes: 29 additions & 33 deletions _dashboards/management/scheduled-query-acceleration.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,39 +48,35 @@ To configure SQA, perform the following steps.

### Step 1: Configure the OpenSearch cluster settings

Configure the following cluster settings.

#### Enable asynchronous query execution

Set `plugins.query.executionengine.async_query.enabled` to `true` (default value):

```json
PUT /_cluster/settings
{
"transient": {
"plugins.query.executionengine.async_query.enabled": "true"
}
}
```
{% include copy-curl.html %}

For more information, see [Settings](https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst#pluginsqueryexecutionengineasync_queryenabled).

#### Configure the external scheduler interval for asynchronous queries

This setting defines how often the external scheduler checks for tasks, allowing customization of refresh frequency. There is no default value for this setting so you must explicitly configure it. Adjusting the interval based on workload can optimize resources and manage costs:

```json
PUT /_cluster/settings
{
"transient": {
"plugins.query.executionengine.async_query.external_scheduler.interval": "10 minutes"
}
}
```
{% include copy-curl.html %}

For more information, see [Settings](https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst#pluginsqueryexecutionengineasync_queryexternal_schedulerinterval).
Configure the following cluster settings:

- **Enable asynchronous query execution**: Set `plugins.query.executionengine.async_query.enabled` to `true` (default value):

```json
PUT /_cluster/settings
{
"transient": {
"plugins.query.executionengine.async_query.enabled": "true"
}
}
```
{% include copy-curl.html %}

For more information, see [Settings](https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst#pluginsqueryexecutionengineasync_queryenabled).

- **Configure the external scheduler interval for asynchronous queries**: This setting defines how often the external scheduler checks for tasks, allowing customization of refresh frequency. There is no default value for this setting so you must explicitly configure it. Adjusting the interval based on workload can optimize resources and manage costs:

```json
PUT /_cluster/settings
{
"transient": {
"plugins.query.executionengine.async_query.external_scheduler.interval": "10 minutes"
}
}
```
{% include copy-curl.html %}

For more information, see [Settings](https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst#pluginsqueryexecutionengineasync_queryexternal_schedulerinterval).

### Step 2: Configure Apache Spark settings

Check failure on line 81 in _dashboards/management/scheduled-query-acceleration.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.HeadingCapitalization] 'Step 2: Configure Apache Spark settings' is a heading and should be in sentence case. Raw Output: {"message": "[OpenSearch.HeadingCapitalization] 'Step 2: Configure Apache Spark settings' is a heading and should be in sentence case.", "location": {"path": "_dashboards/management/scheduled-query-acceleration.md", "range": {"start": {"line": 81, "column": 5}}}, "severity": "ERROR"}

Expand Down

0 comments on commit 08951cb

Please sign in to comment.