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

Merge pull request #21 from aditjind/renaming 

Adding Settings for Alerting from Open-search to Plugins
This commit is contained in:
Andrew Etter 2021-05-25 09:14:31 -07:00 committed by GitHub
parent fcba22c91c 6e2b437e74
commit aea3a6637f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/alerting/api.md
View File

@ -24,7 +24,7 @@ Use the alerting API to programmatically manage monitors and alerts.
#### Request #### Request
```json ```json
POST _opensearch/_alerting/monitors POST _plugins/_alerting/monitors
{ {
"type": "monitor", "type": "monitor",
"name": "test-monitor", "name": "test-monitor",
@ -252,7 +252,7 @@ When you update a monitor, include the current version number as a parameter. Op
#### Request #### Request
```json ```json
PUT _opensearch/_alerting/monitors/<monitor_id> PUT _plugins/_alerting/monitors/<monitor_id>
{ {
"type": "monitor", "type": "monitor",
"name": "test-monitor", "name": "test-monitor",
@ -372,7 +372,7 @@ PUT _opensearch/_alerting/monitors/<monitor_id>
#### Request #### Request
``` ```
GET _opensearch/_alerting/monitors/<monitor_id> GET _plugins/_alerting/monitors/<monitor_id>
``` ```
#### Sample response #### Sample response
@ -439,15 +439,15 @@ GET _opensearch/_alerting/monitors/<monitor_id>
## Monitor stats ## Monitor stats
Returns statistics about the alerting feature. Use `_opensearch/_alerting/stats` to find node IDs and metrics. Then you can drill down using those values. Returns statistics about the alerting feature. Use `_plugins/_alerting/stats` to find node IDs and metrics. Then you can drill down using those values.
#### Request #### Request
```json ```json
GET _opensearch/_alerting/stats GET _plugins/_alerting/stats
GET _opensearch/_alerting/stats/<metric> GET _plugins/_alerting/stats/<metric>
GET _opensearch/_alerting/<node-id>/stats GET _plugins/_alerting/<node-id>/stats
GET _opensearch/_alerting/<node-id>/stats/<metric> GET _plugins/_alerting/<node-id>/stats/<metric>
``` ```
#### Sample response #### Sample response
@ -631,7 +631,7 @@ GET _opensearch/_alerting/<node-id>/stats/<metric>
#### Request #### Request
``` ```
DELETE _opensearch/_alerting/monitors/<monitor_id> DELETE _plugins/_alerting/monitors/<monitor_id>
``` ```
#### Sample response #### Sample response
@ -662,7 +662,7 @@ DELETE _opensearch/_alerting/monitors/<monitor_id>
#### Request #### Request
```json ```json
GET _opensearch/_alerting/monitors/_search GET _plugins/_alerting/monitors/_search
{ {
"query": { "query": {
"match" : { "match" : {
@ -762,7 +762,7 @@ You can add the optional `?dryrun=true` parameter to the URL to show the results
#### Request #### Request
```json ```json
POST _opensearch/_alerting/monitors/<monitor_id>/_execute POST _plugins/_alerting/monitors/<monitor_id>/_execute
``` ```
#### Sample response #### Sample response
@ -793,7 +793,7 @@ Returns an array of all alerts.
#### Request #### Request
```json ```json
GET _opensearch/_alerting/monitors/alerts GET _plugins/_alerting/monitors/alerts
``` ```
#### Response #### Response
@ -862,7 +862,7 @@ GET _opensearch/_alerting/monitors/alerts
#### Request #### Request
```json ```json
POST _opensearch/_alerting/monitors/<monitor-id>/_acknowledge/alerts POST _plugins/_alerting/monitors/<monitor-id>/_acknowledge/alerts
{ {
"alerts": ["eQURa3gBKo1jAh6qUo49"] "alerts": ["eQURa3gBKo1jAh6qUo49"]
} }
@ -886,7 +886,7 @@ POST _opensearch/_alerting/monitors/<monitor-id>/_acknowledge/alerts
#### Requests #### Requests
```json ```json
POST _opensearch/_alerting/destinations POST _plugins/_alerting/destinations
{ {
"name": "my-destination", "name": "my-destination",
"type": "slack", "type": "slack",
@ -895,7 +895,7 @@ POST _opensearch/_alerting/destinations
} }
} }
POST _opensearch/_alerting/destinations POST _plugins/_alerting/destinations
{ {
"type": "custom_webhook", "type": "custom_webhook",
"name": "my-custom-destination", "name": "my-custom-destination",
@ -939,7 +939,7 @@ POST _opensearch/_alerting/destinations
#### Request #### Request
```json ```json
PUT _opensearch/_alerting/destinations/<destination-id> PUT _plugins/_alerting/destinations/<destination-id>
{ {
"name": "my-updated-destination", "name": "my-updated-destination",
"type": "slack", "type": "slack",
@ -976,7 +976,7 @@ Retrieve one destination.
#### Requests #### Requests
```json ```json
GET _opensearch/_alerting/destinations/<destination-id> GET _plugins/_alerting/destinations/<destination-id>
``` ```
#### Sample response #### Sample response
@ -1021,7 +1021,7 @@ Retrieve all destinations.
#### Requests #### Requests
```json ```json
GET _opensearch/_alerting/destinations GET _plugins/_alerting/destinations
``` ```
#### Sample response #### Sample response
@ -1064,7 +1064,7 @@ GET _opensearch/_alerting/destinations
#### Request #### Request
``` ```
DELETE _opensearch/_alerting/destinations/<destination-id> DELETE _plugins/_alerting/destinations/<destination-id>
``` ```
#### Sample response #### Sample response
@ -1092,7 +1092,7 @@ DELETE _opensearch/_alerting/destinations/<destination-id>
#### Request #### Request
```json ```json
POST _opensearch/_alerting/destinations/email_accounts POST _plugins/_alerting/destinations/email_accounts
{ {
"name": "example_account", "name": "example_account",
"email": "example@email.com", "email": "example@email.com",
@ -1124,7 +1124,7 @@ POST _opensearch/_alerting/destinations/email_accounts
#### Request #### Request
```json ```json
PUT _opensearch/_alerting/destinations/email_accounts/<email_account_id> PUT _plugins/_alerting/destinations/email_accounts/<email_account_id>
{ {
"name": "example_account", "name": "example_account",
"email": "example@email.com", "email": "example@email.com",
@ -1155,7 +1155,7 @@ PUT _opensearch/_alerting/destinations/email_accounts/<email_account_id>
#### Request #### Request
```json ```json
GET _opensearch/_alerting/destinations/email_accounts/<email_account_id> GET _plugins/_alerting/destinations/email_accounts/<email_account_id>
{ {
"name": "example_account", "name": "example_account",
"email": "example@email.com", "email": "example@email.com",
@ -1186,7 +1186,7 @@ GET _opensearch/_alerting/destinations/email_accounts/<email_account_id>
#### Request #### Request
``` ```
DELETE _opensearch/_alerting/destinations/email_accounts/<email_account_id> DELETE _plugins/_alerting/destinations/email_accounts/<email_account_id>
``` ```
#### Sample response #### Sample response
@ -1213,7 +1213,7 @@ DELETE _opensearch/_alerting/destinations/email_accounts/<email_account_id>
#### Request #### Request
```json ```json
POST _opensearch/_alerting/destinations/email_accounts/_search POST _plugins/_alerting/destinations/email_accounts/_search
{ {
"from": 0, "from": 0,
"size": 20, "size": 20,
@ -1279,7 +1279,7 @@ POST _opensearch/_alerting/destinations/email_accounts/_search
#### Request #### Request
```json ```json
POST _opensearch/_alerting/destinations/email_groups POST _plugins/_alerting/destinations/email_groups
{ {
"name": "example_email_group", "name": "example_email_group",
"emails": [{ "emails": [{
@ -1313,7 +1313,7 @@ POST _opensearch/_alerting/destinations/email_groups
#### Request #### Request
```json ```json
PUT _opensearch/_alerting/destinations/email_groups/<email_group_id> PUT _plugins/_alerting/destinations/email_groups/<email_group_id>
{ {
"name": "example_email_group", "name": "example_email_group",
"emails": [{ "emails": [{
@ -1345,7 +1345,7 @@ PUT _opensearch/_alerting/destinations/email_groups/<email_group_id>
#### Request #### Request
```json ```json
GET _opensearch/_alerting/destinations/email_groups/<email_group_id> GET _plugins/_alerting/destinations/email_groups/<email_group_id>
{ {
"name": "example_email_group", "name": "example_email_group",
"emails": [{ "emails": [{
@ -1377,7 +1377,7 @@ GET _opensearch/_alerting/destinations/email_groups/<email_group_id>
#### Request #### Request
``` ```
DELETE _opensearch/_alerting/destinations/email_groups/<email_group_id> DELETE _plugins/_alerting/destinations/email_groups/<email_group_id>
``` ```
#### Sample response #### Sample response
@ -1404,7 +1404,7 @@ DELETE _opensearch/_alerting/destinations/email_groups/<email_group_id>
#### Request #### Request
```json ```json
POST _opensearch/_alerting/destinations/email_groups/_search POST _plugins/_alerting/destinations/email_groups/_search
{ {
"from": 0, "from": 0,
"size": 20, "size": 20,

46
docs/alerting/settings.md
View File

@ -34,26 +34,26 @@ 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. `plugins.scheduled_jobs.enabled` | true | Whether the alerting plugin is enabled or not. If disabled, all monitors immediately stop running.
`opendistro.alerting.index_timeout` | 60s | The timeout for creating monitors and destinations using the REST APIs. `plugins.alerting.index_timeout` | 60s | The timeout for creating monitors and destinations using the REST APIs.
`opendistro.alerting.request_timeout` | 10s | The timeout for miscellaneous requests from the plugin. `plugins.alerting.request_timeout` | 10s | The timeout for miscellaneous requests from the plugin.
`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. `plugins.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.input_timeout` | 30s | How long the monitor can take to issue the search request. `plugins.alerting.input_timeout` | 30s | How long the monitor can take to issue the search request.
`opendistro.alerting.bulk_timeout` | 120s | How long the monitor can write alerts to the alert index. `plugins.alerting.bulk_timeout` | 120s | How long the monitor can write alerts to the alert index.
`opendistro.alerting.alert_backoff_count` | 3 | The number of retries for writing alerts before the operation fails. `plugins.alerting.alert_backoff_count` | 3 | The number of retries for writing alerts before the operation fails.
`opendistro.alerting.alert_backoff_millis` | 50ms | The amount of time to wait between retries---increases exponentially after each failed retry. `plugins.alerting.alert_backoff_millis` | 50ms | The amount of time to wait between retries---increases exponentially after each failed retry.
`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. `plugins.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.
`opendistro.alerting.move_alerts_backoff_millis` | 250 | The amount of time to wait between retries---increases exponentially after each failed retry. `plugins.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_count` | 3 | The number of retries for moving alerts to a deleted state after their monitor or trigger has been deleted. `plugins.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.monitor.max_monitors` | 1000 | The maximum number of monitors users can create. `plugins.alerting.monitor.max_monitors` | 1000 | The maximum number of monitors users can create.
`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). `plugins.alerting.alert_history_max_age` | 30d | The oldest document to store in the `.opendistro-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_docs` | 1000 | The maximum number of alerts to store in the `.opensearch-alert-history-<date>` index before creating a new index. `plugins.alerting.alert_history_max_docs` | 1000 | The maximum number of alerts to store in the `.opendistro-alert-history-<date>` index before creating a new index.
`opendistro.alerting.alert_history_enabled` | true | Whether to create `.opendistro-alerting-alert-history-<date>` indices. `plugins.alerting.alert_history_enabled` | true | Whether to create `.opendistro-alerting-alert-history-<date>` indices.
`opendistro.alerting.alert_history_retention_period` | 60d | The amount of time to keep history indices before automatically deleting them. `plugins.alerting.alert_history_retention_period` | 60d | The amount of time to keep history indices before automatically deleting them.
`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. `plugins.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.filter_by_backend_roles` | "false" | Restricts access to monitors by backend role. See [Alerting security](../security/). `plugins.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. `plugins.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. `plugins.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. `plugins.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.retry_count` | 3 | The total number of times the sweeper should retry before throwing an error. `plugins.scheduled_jobs.sweeper.retry_count` | 3 | The total number of times the sweeper should retry before throwing an error.
`opensearch.scheduled_jobs.request_timeout` | 10s | The timeout for the request that sweeps shards for jobs. `plugins.scheduled_jobs.request_timeout` | 10s | The timeout for the request that sweeps shards for jobs.