iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

One of those commits you can't wait to revert

This commit is contained in:
aetter 2021-05-11 09:13:04 -07:00
parent e1da59df1b
commit c8c92a5678
15 changed files with 91 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/ad/api.md
View File

@ -533,7 +533,7 @@ POST _opensearch/_anomaly_detection/detectors/results/_search
"max_score": 1, "max_score": 1,
"hits": [ "hits": [
{ {
"_index": ".opensearch-anomaly-results-history-2020.04.30-1", "_index": ".opendistro-anomaly-results-history-2020.04.30-1",
"_type": "_doc", "_type": "_doc",
"_id": "_KBrzXEBbpoKkFM5mStm", "_id": "_KBrzXEBbpoKkFM5mStm",
"_version": 1, "_version": 1,
@ -559,7 +559,7 @@ POST _opensearch/_anomaly_detection/detectors/results/_search
} }
}, },
{ {
"_index": ".opensearch-anomaly-results-history-2020.04.30-1", "_index": ".opendistro-anomaly-results-history-2020.04.30-1",
"_type": "_doc", "_type": "_doc",
"_id": "EqB1zXEBbpoKkFM5qyyE", "_id": "EqB1zXEBbpoKkFM5qyyE",
"_version": 1, "_version": 1,
@ -664,7 +664,7 @@ POST _opensearch/_anomaly_detection/detectors/results/_search
"max_score": null, "max_score": null,
"hits": [ "hits": [
{ {
"_index": ".opensearch-anomaly-results-history-2020.11.07-1", "_index": ".opendistro-anomaly-results-history-2020.11.07-1",
"_type": "_doc", "_type": "_doc",
"_id": "BiItoHUBTpMGN-4KARY5", "_id": "BiItoHUBTpMGN-4KARY5",
"_version": 1, "_version": 1,
@ -700,7 +700,7 @@ POST _opensearch/_anomaly_detection/detectors/results/_search
] ]
}, },
{ {
"_index": ".opensearch-anomaly-results-history-2020.11.07-1", "_index": ".opendistro-anomaly-results-history-2020.11.07-1",
"_type": "_doc", "_type": "_doc",
"_id": "wiImoHUBTpMGN-4KlhXs", "_id": "wiImoHUBTpMGN-4KlhXs",
"_version": 1, "_version": 1,
@ -736,7 +736,7 @@ POST _opensearch/_anomaly_detection/detectors/results/_search
] ]
}, },
{ {
"_index": ".opensearch-anomaly-results-history-2020.11.07-1", "_index": ".opendistro-anomaly-results-history-2020.11.07-1",
"_type": "_doc", "_type": "_doc",
"_id": "ZiIcoHUBTpMGN-4KhhVA", "_id": "ZiIcoHUBTpMGN-4KhhVA",
"_version": 1, "_version": 1,
@ -822,7 +822,7 @@ GET _opensearch/_anomaly_detection/detectors/results/_search
"max_score": 2.1366, "max_score": 2.1366,
"hits": [ "hits": [
{ {
"_index": ".opensearch-anomaly-detection-state", "_index": ".opendistro-anomaly-detection-state",
"_type": "_doc", "_type": "_doc",
"_id": "CoM8WncBtt2qvI-LZO7_", "_id": "CoM8WncBtt2qvI-LZO7_",
"_version": 8, "_version": 8,
@ -948,7 +948,7 @@ DELETE _opensearch/_anomaly_detection/detectors/<detectorId>
```json ```json
{ {
"_index" : ".opensearch-anomaly-detectors", "_index" : ".opendistro-anomaly-detectors",
"_type" : "_doc", "_type" : "_doc",
"_id" : "m4ccEnIBTXsGi3mvMt9p", "_id" : "m4ccEnIBTXsGi3mvMt9p",
"_version" : 2, "_version" : 2,
@ -1525,7 +1525,7 @@ Sample Input:
"max_score": 3.5410638, "max_score": 3.5410638,
"hits": [ "hits": [
{ {
"_index": ".opensearch-anomaly-detectors", "_index": ".opendistro-anomaly-detectors",
"_type": "_doc", "_type": "_doc",
"_id": "m4ccEnIBTXsGi3mvMt9p", "_id": "m4ccEnIBTXsGi3mvMt9p",
"_version": 2, "_version": 2,
@ -1712,7 +1712,7 @@ POST _opensearch/_alerting/monitors
{ {
"search": { "search": {
"indices": [ "indices": [
".opensearch-anomaly-results*" ".opendistro-anomaly-results*"
], ],
"query": { "query": {
"size": 1, "size": 1,
@ -1818,7 +1818,7 @@ POST _opensearch/_alerting/monitors
{ {
"search": { "search": {
"indices": [ "indices": [
".opensearch-anomaly-results*" ".opendistro-anomaly-results*"
], ],
"query": { "query": {
"size": 1, "size": 1,

2
docs/ad/index.md
View File

@ -52,7 +52,7 @@ A feature is the field in your index that you want to check for anomalies. A det
For example, if you choose `min()`, the detector focuses on finding anomalies based on the minimum values of your feature. If you choose `average()`, the detector finds anomalies based on the average values of your feature. For example, if you choose `min()`, the detector focuses on finding anomalies based on the minimum values of your feature. If you choose `average()`, the detector finds anomalies based on the average values of your feature.
A multi-feature model correlates anomalies across all its features. The [curse of dimensionality](https://en.wikipedia.org/wiki/Curse_of_dimensionality) makes it less likely for multi-feature models to identify smaller anomalies as compared to a single-feature model. Adding more features might negatively impact the [precision and recall](https://en.wikipedia.org/wiki/Precision_and_recall) of a model. A higher proportion of noise in your data might further amplify this negative impact. Selecting the optimal feature set is usually an iterative process. We recommend experimenting with a historical detector with different feature sets and checking the precision before moving on to real-time detectors. By default, the maximum number of features for a detector is 5. You can adjust this limit with the `opensearch.anomaly_detection.max_anomaly_features` setting. A multi-feature model correlates anomalies across all its features. The [curse of dimensionality](https://en.wikipedia.org/wiki/Curse_of_dimensionality) makes it less likely for multi-feature models to identify smaller anomalies as compared to a single-feature model. Adding more features might negatively impact the [precision and recall](https://en.wikipedia.org/wiki/Precision_and_recall) of a model. A higher proportion of noise in your data might further amplify this negative impact. Selecting the optimal feature set is usually an iterative process. We recommend experimenting with a historical detector with different feature sets and checking the precision before moving on to real-time detectors. By default, the maximum number of features for a detector is 5. You can adjust this limit with the `opendistro.anomaly_detection.max_anomaly_features` setting.
{: .note } {: .note }
1. On the **Model configuration** page, enter the **Feature name**. 1. On the **Model configuration** page, enter the **Feature name**.

2
docs/ad/security.md
View File

@ -35,7 +35,7 @@ Next, enable the following setting:
PUT _cluster/settings PUT _cluster/settings
{ {
"transient": { "transient": {
"opensearch.anomaly_detection.filter_by_backend_roles": "true" "opendistro.anomaly_detection.filter_by_backend_roles": "true"
} }
} }
``` ```

34
docs/ad/settings.md
View File

@ -17,26 +17,26 @@ For example, to update the retention period of the result index:
PUT _cluster/settings PUT _cluster/settings
{ {
"transient": { "transient": {
"opensearch.anomaly_detection.ad_result_history_retention_period": "5m" "opendistro.anomaly_detection.ad_result_history_retention_period": "5m"
} }
} }
``` ```
Setting | Default | Description Setting | Default | Description
:--- | :--- | :--- :--- | :--- | :---
`opensearch.anomaly_detection.enabled` | True | Whether the anomaly detection plugin is enabled or not. If disabled, all detectors immediately stop running. `opendistro.anomaly_detection.enabled` | True | Whether the anomaly detection plugin is enabled or not. If disabled, all detectors immediately stop running.
`opensearch.anomaly_detection.max_anomaly_detectors` | 1,000 | The maximum number of non-high cardinality detectors (no category field) users can create. `opendistro.anomaly_detection.max_anomaly_detectors` | 1,000 | The maximum number of non-high cardinality detectors (no category field) users can create.
`opensearch.anomaly_detection.max_multi_entity_anomaly_detectors` | 10 | The maximum number of high cardinality detectors (with category field) in a cluster. `opendistro.anomaly_detection.max_multi_entity_anomaly_detectors` | 10 | The maximum number of high cardinality detectors (with category field) in a cluster.
`opensearch.anomaly_detection.max_anomaly_features` | 5 | The maximum number of features for a detector. `opendistro.anomaly_detection.max_anomaly_features` | 5 | The maximum number of features for a detector.
`opensearch.anomaly_detection.ad_result_history_rollover_period` | 12h | How often the rollover condition is checked. If `true`, the plugin rolls over the result index to a new index. `opendistro.anomaly_detection.ad_result_history_rollover_period` | 12h | How often the rollover condition is checked. If `true`, the plugin rolls over the result index to a new index.
`opensearch.anomaly_detection.ad_result_history_max_docs` | 250000000 | The maximum number of documents in one result index. The plugin only counts refreshed documents in the primary shards. `opendistro.anomaly_detection.ad_result_history_max_docs` | 250000000 | The maximum number of documents in one result index. The plugin only counts refreshed documents in the primary shards.
`opensearch.anomaly_detection.ad_result_history_retention_period` | 30d | The maximum age of the result index. If its age exceeds the threshold, the plugin deletes the rolled over result index. If the cluster has only one result index, the plugin keeps the index even if it's older than its configured retention period. `opendistro.anomaly_detection.ad_result_history_retention_period` | 30d | The maximum age of the result index. If its age exceeds the threshold, the plugin deletes the rolled over result index. If the cluster has only one result index, the plugin keeps the index even if it's older than its configured retention period.
`opensearch.anomaly_detection.max_entities_per_query` | 1,000 | The maximum unique values per detection interval for high cardinality detectors. By default, if the category field has more than 1,000 unique values in a detector interval, the plugin selects the top 1,000 values and orders them by `doc_count`. `opendistro.anomaly_detection.max_entities_per_query` | 1,000 | The maximum unique values per detection interval for high cardinality detectors. By default, if the category field has more than 1,000 unique values in a detector interval, the plugin selects the top 1,000 values and orders them by `doc_count`.
`opensearch.anomaly_detection.max_entities_for_preview` | 30 | The maximum unique category field values displayed with the preview operation for high cardinality detectors. If the category field has more than 30 unique values, the plugin selects the top 30 values and orders them by `doc_count`. `opendistro.anomaly_detection.max_entities_for_preview` | 30 | The maximum unique category field values displayed with the preview operation for high cardinality detectors. If the category field has more than 30 unique values, the plugin selects the top 30 values and orders them by `doc_count`.
`opensearch.anomaly_detection.max_primary_shards` | 10 | The maximum number of primary shards an anomaly detection index can have. `opendistro.anomaly_detection.max_primary_shards` | 10 | The maximum number of primary shards an anomaly detection index can have.
`opensearch.anomaly_detection.filter_by_backend_roles` | False | When you enable the security plugin and set this to `true`, the plugin filters results based on the user's backend role(s). `opendistro.anomaly_detection.filter_by_backend_roles` | False | When you enable the security plugin and set this to `true`, the plugin filters results based on the user's backend role(s).
`opensearch.anomaly_detection.max_cache_miss_handling_per_second` | 100 | High cardinality detectors use a cache to store active models. In the event of a cache miss, the cache gets the models from the model checkpoint index. Use this setting to limit the rate of fetching models. Because the thread pool for a GET operation has a queue of 1,000, we recommend setting this value below 1,000. `opendistro.anomaly_detection.max_cache_miss_handling_per_second` | 100 | High cardinality detectors use a cache to store active models. In the event of a cache miss, the cache gets the models from the model checkpoint index. Use this setting to limit the rate of fetching models. Because the thread pool for a GET operation has a queue of 1,000, we recommend setting this value below 1,000.
`opensearch.anomaly_detection.max_batch_task_per_node` | 2 | Starting a historical detector triggers a batch task. This setting is the number of batch tasks that you can run per data node. You can tune this setting from 1 to 1000. If the data nodes can't support all batch tasks and you're not sure if the data nodes are capable of running more historical detectors, add more data nodes instead of changing this setting to a higher value. `opendistro.anomaly_detection.max_batch_task_per_node` | 2 | Starting a historical detector triggers a batch task. This setting is the number of batch tasks that you can run per data node. You can tune this setting from 1 to 1000. If the data nodes can't support all batch tasks and you're not sure if the data nodes are capable of running more historical detectors, add more data nodes instead of changing this setting to a higher value.
`opensearch.anomaly_detection.max_old_ad_task_docs_per_detector` | 10 | You can run the same historical detector many times. For each run, the anomaly detection plugin creates a new task. This setting is the number of previous tasks the plugin keeps. Set this value to at least 1 to track its last run. You can keep a maximum of 1,000 old tasks to avoid overwhelming the cluster. `opendistro.anomaly_detection.max_old_ad_task_docs_per_detector` | 10 | You can run the same historical detector many times. For each run, the anomaly detection plugin creates a new task. This setting is the number of previous tasks the plugin keeps. Set this value to at least 1 to track its last run. You can keep a maximum of 1,000 old tasks to avoid overwhelming the cluster.
`opensearch.anomaly_detection.batch_task_piece_size` | 1000 | The date range for a historical task is split into smaller pieces and the anomaly detection plugin runs the task piece by piece. Each piece contains 1,000 detection intervals by default. For example, if detector interval is 1 minute and one piece is 1000 minutes, the feature data is queried every 1,000 minutes. You can change this setting from 1 to 10,000. `opendistro.anomaly_detection.batch_task_piece_size` | 1000 | The date range for a historical task is split into smaller pieces and the anomaly detection plugin runs the task piece by piece. Each piece contains 1,000 detection intervals by default. For example, if detector interval is 1 minute and one piece is 1000 minutes, the feature data is queried every 1,000 minutes. You can change this setting from 1 to 10,000.
`opensearch.anomaly_detection.batch_task_piece_interval_seconds` | 5 | Add a time interval between historical detector tasks. This interval prevents the task from consuming too much of the available resources and starving other operations like search and bulk index. You can change this setting from 1 to 600 seconds. `opendistro.anomaly_detection.batch_task_piece_interval_seconds` | 5 | Add a time interval between historical detector tasks. This interval prevents the task from consuming too much of the available resources and starving other operations like search and bulk index. You can change this setting from 1 to 600 seconds.

10
docs/alerting/api.md
View File

@ -1071,7 +1071,7 @@ DELETE _opensearch/_alerting/destinations/<destination-id>
```json ```json
{ {
"_index": ".opensearch-alerting-config", "_index": ".opendistro-alerting-config",
"_type": "_doc", "_type": "_doc",
"_id": "Zu-zFmkB8NzS6aXjLeBI", "_id": "Zu-zFmkB8NzS6aXjLeBI",
"_version": 2, "_version": 2,
@ -1192,7 +1192,7 @@ DELETE _opensearch/_alerting/destinations/email_accounts/<email_account_id>
```json ```json
{ {
"_index" : ".opensearch-alerting-config", "_index" : ".opendistro-alerting-config",
"_type" : "_doc", "_type" : "_doc",
"_id" : "email_account_id", "_id" : "email_account_id",
"_version" : 1, "_version" : 1,
@ -1248,7 +1248,7 @@ POST _opensearch/_alerting/destinations/email_accounts/_search
"max_score" : null, "max_score" : null,
"hits" : [ "hits" : [
{ {
"_index" : ".opensearch-alerting-config", "_index" : ".opendistro-alerting-config",
"_type" : "_doc", "_type" : "_doc",
"_id" : "email_account_id", "_id" : "email_account_id",
"_seq_no" : 8, "_seq_no" : 8,
@ -1383,7 +1383,7 @@ DELETE _opensearch/_alerting/destinations/email_groups/<email_group_id>
```json ```json
{ {
"_index" : ".opensearch-alerting-config", "_index" : ".opendistro-alerting-config",
"_type" : "_doc", "_type" : "_doc",
"_id" : "email_group_id", "_id" : "email_group_id",
"_version" : 1, "_version" : 1,
@ -1439,7 +1439,7 @@ POST _opensearch/_alerting/destinations/email_groups/_search
"max_score" : null, "max_score" : null,
"hits" : [ "hits" : [
{ {
"_index" : ".opensearch-alerting-config", "_index" : ".opendistro-alerting-config",
"_type" : "_doc", "_type" : "_doc",
"_id" : "email_group_id", "_id" : "email_group_id",
"_seq_no" : 10, "_seq_no" : 10,

4
docs/alerting/monitors.md
View File

@ -78,8 +78,8 @@ You can enter individual email addresses or an email group in the **Recipients**
If your email provider requires SSL or TLS, you must authenticate each sender account before you can send an email. Enter these credentials in the OpenSearch keystore using the CLI. Run the following commands (in your OpenSearch directory) to enter your username and password. The `<sender_name>` is the name you entered for **Sender** earlier. If your email provider requires SSL or TLS, you must authenticate each sender account before you can send an email. Enter these credentials in the OpenSearch keystore using the CLI. Run the following commands (in your OpenSearch directory) to enter your username and password. The `<sender_name>` is the name you entered for **Sender** earlier.
```bash ```bash
./bin/opensearch-keystore add opensearch.alerting.destination.email.<sender_name>.username ./bin/opensearch-keystore add opendistro.alerting.destination.email.<sender_name>.username
./bin/opensearch-keystore add opensearch.alerting.destination.email.<sender_name>.password ./bin/opensearch-keystore add opendistro.alerting.destination.email.<sender_name>.password
``` ```
**Note**: Keystore settings are node-specific. You must run these commands on each node. **Note**: Keystore settings are node-specific. You must run these commands on each node.

2
docs/alerting/security.md
View File

@ -44,7 +44,7 @@ Next, enable the following setting:
PUT _cluster/settings PUT _cluster/settings
{ {
"transient": { "transient": {
"opensearch.alerting.filter_by_backend_roles": "true" "opendistro.alerting.filter_by_backend_roles": "true"
} }
} }
``` ```

42
docs/alerting/settings.md
View File

@ -14,10 +14,10 @@ The alerting feature creates several indices and one alias. The security plugin
Index | Purpose Index | Purpose
:--- | :--- :--- | :---
`.opensearch-alerting-alerts` | Stores ongoing alerts. `.opendistro-alerting-alerts` | Stores ongoing alerts.
`.opensearch-alerting-alert-history-<date>` | Stores a history of completed alerts. `.opendistro-alerting-alert-history-<date>` | Stores a history of completed alerts.
`.opensearch-alerting-config` | Stores monitors, triggers, and destinations. [Take a snapshot](../../opensearch/snapshot-restore) of this index to back up your alerting configuration. `.opendistro-alerting-config` | Stores monitors, triggers, and destinations. [Take a snapshot](../../opensearch/snapshot-restore) of this index to back up your alerting configuration.
`.opensearch-alerting-alert-history-write` (alias) | Provides a consistent URI for the `.opensearch-alerting-alert-history-<date>` index. `.opendistro-alerting-alert-history-write` (alias) | Provides a consistent URI for the `.opendistro-alerting-alert-history-<date>` index.
All alerting indices are hidden by default. For a summary, make the following request: All alerting indices are hidden by default. For a summary, make the following request:
@ -35,23 +35,23 @@ All settings are available using the OpenSearch `_cluster/settings` API. None re
Setting | Default | Description Setting | Default | Description
:--- | :--- | :--- :--- | :--- | :---
`opensearch.scheduled_jobs.enabled` | true | Whether the alerting plugin is enabled or not. If disabled, all monitors immediately stop running. `opensearch.scheduled_jobs.enabled` | true | Whether the alerting plugin is enabled or not. If disabled, all monitors immediately stop running.
`opensearch.alerting.index_timeout` | 60s | The timeout for creating monitors and destinations using the REST APIs. `opendistro.alerting.index_timeout` | 60s | The timeout for creating monitors and destinations using the REST APIs.
`opensearch.alerting.request_timeout` | 10s | The timeout for miscellaneous requests from the plugin. `opendistro.alerting.request_timeout` | 10s | The timeout for miscellaneous requests from the plugin.
`opensearch.alerting.action_throttle_max_value` | 24h | The maximum amount of time you can set for action throttling. By default, this value displays as 1440 minutes in OpenSearch Dashboards. `opendistro.alerting.action_throttle_max_value` | 24h | The maximum amount of time you can set for action throttling. By default, this value displays as 1440 minutes in OpenSearch Dashboards.
`opensearch.alerting.input_timeout` | 30s | How long the monitor can take to issue the search request. `opendistro.alerting.input_timeout` | 30s | How long the monitor can take to issue the search request.
`opensearch.alerting.bulk_timeout` | 120s | How long the monitor can write alerts to the alert index. `opendistro.alerting.bulk_timeout` | 120s | How long the monitor can write alerts to the alert index.
`opensearch.alerting.alert_backoff_count` | 3 | The number of retries for writing alerts before the operation fails. `opendistro.alerting.alert_backoff_count` | 3 | The number of retries for writing alerts before the operation fails.
`opensearch.alerting.alert_backoff_millis` | 50ms | The amount of time to wait between retries---increases exponentially after each failed retry. `opendistro.alerting.alert_backoff_millis` | 50ms | The amount of time to wait between retries---increases exponentially after each failed retry.
`opensearch.alerting.alert_history_rollover_period` | 12h | How frequently to check whether the `.opensearch-alerting-alert-history-write` alias should roll over to a new history index and whether the Alerting plugin should delete any history indices. `opendistro.alerting.alert_history_rollover_period` | 12h | How frequently to check whether the `.opendistro-alerting-alert-history-write` alias should roll over to a new history index and whether the Alerting plugin should delete any history indices.
`opensearch.alerting.move_alerts_backoff_millis` | 250 | The amount of time to wait between retries---increases exponentially after each failed retry. `opendistro.alerting.move_alerts_backoff_millis` | 250 | The amount of time to wait between retries---increases exponentially after each failed retry.
`opensearch.alerting.move_alerts_backoff_count` | 3 | The number of retries for moving alerts to a deleted state after their monitor or trigger has been deleted. `opendistro.alerting.move_alerts_backoff_count` | 3 | The number of retries for moving alerts to a deleted state after their monitor or trigger has been deleted.
`opensearch.alerting.monitor.max_monitors` | 1000 | The maximum number of monitors users can create. `opendistro.alerting.monitor.max_monitors` | 1000 | The maximum number of monitors users can create.
`opensearch.alerting.alert_history_max_age` | 30d | The oldest document to store in the `.opensearch-alert-history-<date>` index before creating a new index. If the number of alerts in this time period does not exceed `alert_history_max_docs`, alerting creates one history index per period (e.g. one index every 30 days). `opendistro.alerting.alert_history_max_age` | 30d | The oldest document to store in the `.opensearch-alert-history-<date>` index before creating a new index. If the number of alerts in this time period does not exceed `alert_history_max_docs`, alerting creates one history index per period (e.g. one index every 30 days).
`opensearch.alerting.alert_history_max_docs` | 1000 | The maximum number of alerts to store in the `.opensearch-alert-history-<date>` index before creating a new index. `opendistro.alerting.alert_history_max_docs` | 1000 | The maximum number of alerts to store in the `.opensearch-alert-history-<date>` index before creating a new index.
`opensearch.alerting.alert_history_enabled` | true | Whether to create `.opensearch-alerting-alert-history-<date>` indices. `opendistro.alerting.alert_history_enabled` | true | Whether to create `.opendistro-alerting-alert-history-<date>` indices.
`opensearch.alerting.alert_history_retention_period` | 60d | The amount of time to keep history indices before automatically deleting them. `opendistro.alerting.alert_history_retention_period` | 60d | The amount of time to keep history indices before automatically deleting them.
`opensearch.alerting.destination.allow_list` | ["chime", "slack", "custom_webhook", "email", "test_action"] | The list of allowed destinations. If you don't want to allow users to a certain type of destination, you can remove it from this list, but we recommend leaving this setting as-is. `opendistro.alerting.destination.allow_list` | ["chime", "slack", "custom_webhook", "email", "test_action"] | The list of allowed destinations. If you don't want to allow users to a certain type of destination, you can remove it from this list, but we recommend leaving this setting as-is.
`opensearch.alerting.filter_by_backend_roles` | "false" | Restricts access to monitors by backend role. See [Alerting security](../security/). `opendistro.alerting.filter_by_backend_roles` | "false" | Restricts access to monitors by backend role. See [Alerting security](../security/).
`opensearch.scheduled_jobs.sweeper.period` | 5m | The alerting feature uses its "job sweeper" component to periodically check for new or updated jobs. This setting is the rate at which the sweeper checks to see if any jobs (monitors) have changed and need to be rescheduled. `opensearch.scheduled_jobs.sweeper.period` | 5m | The alerting feature uses its "job sweeper" component to periodically check for new or updated jobs. This setting is the rate at which the sweeper checks to see if any jobs (monitors) have changed and need to be rescheduled.
`opensearch.scheduled_jobs.sweeper.page_size` | 100 | The page size for the sweeper. You shouldn't need to change this value. `opensearch.scheduled_jobs.sweeper.page_size` | 100 | The page size for the sweeper. You shouldn't need to change this value.
`opensearch.scheduled_jobs.sweeper.backoff_millis` | 50ms | The amount of time the sweeper waits between retries---increases exponentially after each failed retry. `opensearch.scheduled_jobs.sweeper.backoff_millis` | 50ms | The amount of time the sweeper waits between retries---increases exponentially after each failed retry.

6
docs/im/ism/api.md
View File

@ -452,12 +452,12 @@ GET _opensearch/_ism/explain/index_1
```json ```json
{ {
"index_1": { "index_1": {
"index.opensearch.index_state_management.policy_id": "policy_1" "index.opendistro.index_state_management.policy_id": "policy_1"
} }
} }
``` ```
The `opensearch.index_state_management.policy_id` setting is deprecated starting from version 1.13.0. The `opendistro.index_state_management.policy_id` setting is deprecated starting from version 1.13.0.
We retain this field in the response API for consistency. We retain this field in the response API for consistency.
--- ---
@ -477,7 +477,7 @@ DELETE _opensearch/_ism/policies/policy_1
```json ```json
{ {
"_index": ".opensearch-ism-config", "_index": ".opendistro-ism-config",
"_type": "_doc", "_type": "_doc",
"_id": "policy_1", "_id": "policy_1",
"_version": 3, "_version": 3,

4
docs/im/ism/index.md
View File

@ -67,13 +67,13 @@ PUT _index_template/<template_name>
], ],
"template": { "template": {
"settings": { "settings": {
"opensearch.index_state_management.policy_id": "policy_id" "opendistro.index_state_management.policy_id": "policy_id"
} }
} }
} }
``` ```
The `opensearch.index_state_management.policy_id` setting is deprecated. You can continue to automatically manage newly created indices with the ISM template field. The `opendistro.index_state_management.policy_id` setting is deprecated. You can continue to automatically manage newly created indices with the ISM template field.
{: .note } {: .note }
### Step 2: Attach policies to indices ### Step 2: Attach policies to indices

4
docs/im/ism/policies.md
View File

@ -201,7 +201,7 @@ Deletes a managed index.
Rolls an alias over to a new index when the managed index meets one of the rollover conditions. Rolls an alias over to a new index when the managed index meets one of the rollover conditions.
The index format must match the pattern: `^.*-\d+$`. For example, `(logs-000001)`. The index format must match the pattern: `^.*-\d+$`. For example, `(logs-000001)`.
Set `index.opensearch.index_state_management.rollover_alias` as the alias to rollover. Set `index.opendistro.index_state_management.rollover_alias` as the alias to rollover.
Parameter | Description | Type | Example | Required Parameter | Description | Type | Example | Required
:--- | :--- |:--- |:--- | :--- | :--- |:--- |:--- |
@ -561,7 +561,7 @@ The following sample template policy is for a rollover use case.
{ {
"index_patterns": ["log*"], "index_patterns": ["log*"],
"settings": { "settings": {
"opensearch.index_state_management.rollover_alias": "log" "opendistro.index_state_management.rollover_alias": "log"
} }
} }
``` ```

26
docs/im/ism/settings.md
View File

@ -11,23 +11,23 @@ nav_order: 4
We don't recommend changing these settings; the defaults should work well for most use cases. We don't recommend changing these settings; the defaults should work well for most use cases.
Index State Management (ISM) stores its configuration in the `.opensearch-ism-config` index. Don't modify this index without using the [ISM API operations](../api/). Index State Management (ISM) stores its configuration in the `.opendistro-ism-config` index. Don't modify this index without using the [ISM API operations](../api/).
All settings are available using the OpenSearch `_cluster/settings` operation. None require a restart, and all can be marked `persistent` or `transient`. All settings are available using the OpenSearch `_cluster/settings` operation. None require a restart, and all can be marked `persistent` or `transient`.
Setting | Default | Description Setting | Default | Description
:--- | :--- | :--- :--- | :--- | :---
`opensearch.index_state_management.enabled` | True | Specifies whether ISM is enabled or not. `opendistro.index_state_management.enabled` | True | Specifies whether ISM is enabled or not.
`opensearch.index_state_management.job_interval` | 5 minutes | The interval at which the managed index jobs are run. `opendistro.index_state_management.job_interval` | 5 minutes | The interval at which the managed index jobs are run.
`opensearch.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run. `opendistro.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run.
`opensearch.index_state_management.coordinator.backoff_millis` | 50 milliseconds | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indices). `opendistro.index_state_management.coordinator.backoff_millis` | 50 milliseconds | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indices).
`opensearch.index_state_management.coordinator.backoff_count` | 2 | The count of retries for failures in the `ManagedIndexCoordinator`. `opendistro.index_state_management.coordinator.backoff_count` | 2 | The count of retries for failures in the `ManagedIndexCoordinator`.
`opensearch.index_state_management.history.enabled` | True | Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. `opendistro.index_state_management.history.enabled` | True | Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
`opensearch.index_state_management.history.max_docs` | 2,500,000 | The maximum number of documents before rolling over the audit history index. `opendistro.index_state_management.history.max_docs` | 2,500,000 | The maximum number of documents before rolling over the audit history index.
`opensearch.index_state_management.history.max_age` | 24 hours | The maximum age before rolling over the audit history index. `opendistro.index_state_management.history.max_age` | 24 hours | The maximum age before rolling over the audit history index.
`opensearch.index_state_management.history.rollover_check_period` | 8 hours | The time between rollover checks for the audit history index. `opendistro.index_state_management.history.rollover_check_period` | 8 hours | The time between rollover checks for the audit history index.
`opensearch.index_state_management.history.rollover_retention_period` | 30 days | How long audit history indices are kept. `opendistro.index_state_management.history.rollover_retention_period` | 30 days | How long audit history indices are kept.
`opensearch.index_state_management.allow_list` | All actions | List of actions that you can use. `opendistro.index_state_management.allow_list` | All actions | List of actions that you can use.
## Audit history indices ## Audit history indices
@ -38,7 +38,7 @@ If you don't want to disable ISM audit history or shorten the retention period,
PUT _index_template/ism_history_indices PUT _index_template/ism_history_indices
{ {
"index_patterns": [ "index_patterns": [
".opensearch-ism-managed-index-history-*" ".opendistro-ism-managed-index-history-*"
], ],
"template": { "template": {
"settings": { "settings": {

4
docs/security/configuration/system-indices.md
View File

@ -13,8 +13,8 @@ By default, OpenSearch has a protected system index, `.opensearch_security`, whi
You can add additional system indices in in `opensearch.yml`. In addition to automatically creating `.opensearch_security`, the demo configuration adds several indices for the various OpenSearch plugins that integrate with the security plugin: You can add additional system indices in in `opensearch.yml`. In addition to automatically creating `.opensearch_security`, the demo configuration adds several indices for the various OpenSearch plugins that integrate with the security plugin:
```yml ```yml
opensearch_security.system_indices.enabled: true opendistro_security.system_indices.enabled: true
opensearch_security.system_indices.indices: [".opensearch-alerting-config", ".opensearch-alerting-alert*", ".opensearch-anomaly-results*", ".opensearch-anomaly-detector*", ".opensearch-anomaly-checkpoints", ".opensearch-anomaly-detection-state"] opendistro_security.system_indices.indices: [".opendistro-alerting-config", ".opendistro-alerting-alert*", ".opendistro-anomaly-results*", ".opendistro-anomaly-detector*", ".opendistro-anomaly-checkpoints", ".opendistro-anomaly-detection-state", ".opendistro-reports-*", ".opendistro-notifications-*", ".opendistro-notebooks", ".opendistro-asynchronous-search-response*"]
``` ```
To access these indices, you must authenticate with an [admin certificate](../tls/#configure-admin-certificates): To access these indices, you must authenticate with an [admin certificate](../tls/#configure-admin-certificates):

20
docs/sql/settings.md
View File

@ -15,19 +15,19 @@ You can update these settings like any other cluster setting:
PUT _cluster/settings PUT _cluster/settings
{ {
"transient" : { "transient" : {
"opensearch.sql.enabled" : false "opendistro.sql.enabled" : false
} }
} }
``` ```
Setting | Default | Description Setting | Default | Description
:--- | :--- | :--- :--- | :--- | :---
`opensearch.sql.enabled` | True | Change to `false` to disable the plugin. `opendistro.sql.enabled` | True | Change to `false` to disable the plugin.
`opensearch.sql.query.slowlog` | 2 seconds | Configure the time limit (in seconds) for slow queries. The plugin logs slow queries as `Slow query: elapsed=xxx (ms)` in `opensearch.log`. `opendistro.sql.query.slowlog` | 2 seconds | Configure the time limit (in seconds) for slow queries. The plugin logs slow queries as `Slow query: elapsed=xxx (ms)` in `opensearch.log`.
`opensearch.sql.query.analysis.enabled` | True | Enables or disables the query analyzer. Changing this setting to `false` lets you bypass strict syntactic and semantic analysis. `opendistro.sql.query.analysis.enabled` | True | Enables or disables the query analyzer. Changing this setting to `false` lets you bypass strict syntactic and semantic analysis.
`opensearch.sql.query.analysis.semantic.suggestion` | False | If enabled, the query analyzer suggests correct field names for quick fixes. `opendistro.sql.query.analysis.semantic.suggestion` | False | If enabled, the query analyzer suggests correct field names for quick fixes.
`opensearch.sql.query.analysis.semantic.threshold` | 200 | Because query analysis needs to build semantic context in memory, indices with a large number of fields are be skipped. You can update this setting to apply analysis to smaller or larger indices as needed. `opendistro.sql.query.analysis.semantic.threshold` | 200 | Because query analysis needs to build semantic context in memory, indices with a large number of fields are be skipped. You can update this setting to apply analysis to smaller or larger indices as needed.
`opensearch.sql.query.response.format` | JDBC | Sets the default response format for queries. The supported formats are JDBC, JSON, CSV, raw, and table. `opendistro.sql.query.response.format` | JDBC | Sets the default response format for queries. The supported formats are JDBC, JSON, CSV, raw, and table.
`opensearch.sql.cursor.enabled` | False | You can enable or disable pagination for all queries that are supported. `opendistro.sql.cursor.enabled` | False | You can enable or disable pagination for all queries that are supported.
`opensearch.sql.cursor.fetch_size` | 1,000 | You can set the default `fetch_size` for all queries that are supported by pagination. An explicit `fetch_size` passed in request overrides this value. `opendistro.sql.cursor.fetch_size` | 1,000 | You can set the default `fetch_size` for all queries that are supported by pagination. An explicit `fetch_size` passed in request overrides this value.
`opensearch.sql.cursor.keep_alive` | 1 minute | This value configures how long the cursor context is kept open. Cursor contexts are resource heavy, so we recommend a low value. `opendistro.sql.cursor.keep_alive` | 1 minute | This value configures how long the cursor context is kept open. Cursor contexts are resource heavy, so we recommend a low value.

2
docs/sql/troubleshoot.md
View File

@ -63,7 +63,7 @@ To resolve this error:
PUT _cluster/settings PUT _cluster/settings
{ {
"persistent" : { "persistent" : {
"opensearch.sql.query.analysis.enabled" : false "opendistro.sql.query.analysis.enabled" : false
} }
} }
``` ```