Skip to content

Commit

Permalink
More redirects and spelling fixes (#4093)
Browse files Browse the repository at this point in the history
* redirects and spelling

Signed-off-by: Heather Halter <[email protected]>

* Update _observing-your-data/ad/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _observing-your-data/ad/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/knn/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
  • Loading branch information
hdhalter and Naarcha-AWS authored May 17, 2023
1 parent 2b627de commit ee7d1ef
Show file tree
Hide file tree
Showing 43 changed files with 132 additions and 89 deletions.
2 changes: 2 additions & 0 deletions _api-reference/scroll.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Scroll
nav_order: 71
redirect_from:
- /opensearch/rest-api/scroll/
---

# Scroll
Expand Down
2 changes: 1 addition & 1 deletion _clients/java-rest-high-level.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 20
The OpenSearch Java high-level REST client will be deprecated starting with OpenSearch version 3.0.0 and will be removed in a future release. We recommend switching to the [Java client]({{site.url}}{{site.baseurl}}/clients/java/) instead.
{: .warning}

The OpenSearch Java high-level REST client lets you interact with your OpenSearch clusters and indices through Java methods and data structures rather than HTTP methods and JSON.
The OpenSearch Java high-level REST client lets you interact with your OpenSearch clusters and indexes through Java methods and data structures rather than HTTP methods and JSON.

## Setup

Expand Down
8 changes: 4 additions & 4 deletions _observing-your-data/ad/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ A detector is an individual anomaly detection task. You can define multiple dete
1. Add in the detector details.
- Enter a name and brief description. Make sure the name is unique and descriptive enough to help you to identify the purpose of the detector.
1. Specify the data source.
- For **Data source**, choose the index you want to use as the data source. You can optionally use index patterns to choose multiple indices.
- For **Data source**, choose the index you want to use as the data source. You can optionally use index patterns to choose multiple indexes.
- (Optional) For **Data filter**, filter the index you chose as the data source. From the **Data filter** menu, choose **Add data filter**, and then design your filter query by selecting **Field**, **Operator**, and **Value**, or choose **Use query DSL** and add your own JSON filter query.
1. Specify a timestamp.
- Select the **Timestamp field** in your index.
Expand All @@ -55,12 +55,12 @@ A detector is an individual anomaly detection task. You can define multiple dete
- To use the custom result index option, you need the following permissions:
- `indices:admin/create` - If the custom index already exists, you don't need this.
- `indices:data/write/index` - You need the `write` permission for the anomaly detection plugin to write results into the custom index for a single-entity detector.
- `indices:data/read/search` - You need the `search` permission because the anomaly detection plugin needs to search custom result indices to show results on the anomaly detection UI.
- `indices:data/read/search` - You need the `search` permission because the Anomaly Detection plugin needs to search custom result indexes to show results on the anomaly detection UI.
- `indices:data/write/delete` - Because the detector might generate a large number of anomaly results, you need the `delete` permission to delete old data and save disk space.
- `indices:data/write/bulk*` - You need the `bulk*` permission because the anomaly detection plugin uses the bulk API to write results into the custom index.
- Managing the custom result index:
- The anomaly detection dashboard queries all detectors’ results from all custom result indices. Having too many custom result indices might impact the performance of the anomaly detection plugin.
- You can use [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/ism/index/) to rollover old result indices. You can also manually delete or archive any old result indices. We recommend reusing a custom result index for multiple detectors.
- The anomaly detection dashboard queries all detectors’ results from all custom result indexes. Having too many custom result indexes might impact the performance of the Anomaly Detection plugin.
- You can use [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/ism/index/) to rollover old result indexes. You can also manually delete or archive any old result indexes. We recommend reusing a custom result index for multiple detectors.
1. Choose **Next**.

After you define the detector, the next step is to configure the model.
Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/ad/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ redirect_from:

You can use the Security plugin with anomaly detection in OpenSearch to limit non-admin users to specific actions. For example, you might want some users to only be able to create, update, or delete detectors, while others to only view detectors.

All anomaly detection indices are protected as system indices. Only a super admin user or an admin user with a TLS certificate can access system indices. For more information, see [System indices]({{site.url}}{{site.baseurl}}/security/configuration/system-indices/).
All anomaly detection indexes are protected as system indexes. Only a super admin user or an admin user with a TLS certificate can access system indexes. For more information, see [System indexes]({{site.url}}{{site.baseurl}}/security/configuration/system-indices/).


Security for anomaly detection works the same as [security for alerting]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/security/).
Expand Down
6 changes: 3 additions & 3 deletions _observing-your-data/alerting/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ If these roles don't meet your needs, mix and match individual alerting [permiss

## How monitors access data

Monitors run with the permissions of the user who created or last modified them. For example, consider the user `jdoe`, who works at a chain of retail stores. `jdoe` has two roles. Together, these two roles allow read access to three indices: `store1-returns`, `store2-returns`, and `store3-returns`.
Monitors run with the permissions of the user who created or last modified them. For example, consider the user `jdoe`, who works at a chain of retail stores. `jdoe` has two roles. Together, these two roles allow read access to three indexes: `store1-returns`, `store2-returns`, and `store3-returns`.

`jdoe` creates a monitor that sends an email to management whenever the number of returns across all three indices exceeds 40 per hour.
`jdoe` creates a monitor that sends an email to management whenever the number of returns across all three indexes exceeds 40 per hour.

Later, the user `psantos` wants to edit the monitor to run every two hours, but `psantos` only has access to `store1-returns`. To make the change, `psantos` has two options:

- Update the monitor so that it only checks `store1-returns`.
- Ask an administrator for read access to the other two indices.
- Ask an administrator for read access to the other two indexes.

After making the change, the monitor now runs with the same permissions as `psantos`, including any [document-level security]({{site.url}}{{site.baseurl}}/security/access-control/document-level-security/) queries, [excluded fields]({{site.url}}{{site.baseurl}}/security/access-control/field-level-security/), and [masked fields]({{site.url}}{{site.baseurl}}/security/access-control/field-masking/). If you use an extraction query to define your monitor, use the **Run** button to ensure that the response includes the fields you need.

Expand Down
12 changes: 6 additions & 6 deletions _observing-your-data/alerting/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ redirect_from:
# Management


## Alerting indices
## Alerting indexes

The alerting feature creates several indices and one alias. The Security plugin demo script configures them as [system indices]({{site.url}}{{site.baseurl}}/security/configuration/system-indices/) for an extra layer of protection. Don't delete these indices or modify their contents without using the alerting APIs.
The alerting feature creates several indexes and one alias. The Security plugin demo script configures them as [system indexes]({{site.url}}{{site.baseurl}}/security/configuration/system-indices/) for an extra layer of protection. Don't delete these indexes or modify their contents without using the alerting APIs.

Index | Purpose
:--- | :---
Expand All @@ -21,7 +21,7 @@ Index | Purpose
`.opendistro-alerting-config` | Stores monitors, triggers, and destinations. [Take a snapshot]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore) of this index to back up your alerting configuration.
`.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 indexes are hidden by default. For a summary, make the following request:

```
GET _cat/indices?expand_wildcards=open,hidden
Expand All @@ -44,14 +44,14 @@ Setting | Default | Description
`plugins.alerting.bulk_timeout` | 120s | How long the monitor can write alerts to the alert index.
`plugins.alerting.alert_backoff_count` | 3 | The number of retries for writing alerts before the operation fails.
`plugins.alerting.alert_backoff_millis` | 50ms | The amount of time to wait between retries---increases exponentially after each failed retry.
`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.
`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 indexes.
`plugins.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_count` | 3 | The number of retries for moving alerts to a deleted state after their monitor or trigger has been deleted.
`plugins.alerting.monitor.max_monitors` | 1000 | The maximum number of monitors users can create.
`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).
`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.
`plugins.alerting.alert_history_enabled` | true | Whether to create `.opendistro-alerting-alert-history-<date>` indices.
`plugins.alerting.alert_history_retention_period` | 60d | The amount of time to keep history indices before automatically deleting them.
`plugins.alerting.alert_history_enabled` | true | Whether to create `.opendistro-alerting-alert-history-<date>` indexes.
`plugins.alerting.alert_history_retention_period` | 60d | The amount of time to keep history indexes before automatically deleting them.
`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.
`plugins.alerting.filter_by_backend_roles` | "false" | Restricts access to monitors by backend role. See [Alerting security]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/security/).
`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.
Expand Down
6 changes: 3 additions & 3 deletions _query-dsl/aggregations/metric-agg.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ GET opensearch_dashboards_sample_data_ecommerce/_search
}
```

#### Sample Response
#### Example response

```json
...
Expand Down Expand Up @@ -194,7 +194,7 @@ GET opensearch_dashboards_sample_data_ecommerce/_search
}
```

#### Sample Response
#### Example response

```json
...
Expand Down Expand Up @@ -621,7 +621,7 @@ GET opensearch_dashboards_sample_data_logs/_search
}
```

#### Sample Response
#### Example response

```json
...
Expand Down
6 changes: 3 additions & 3 deletions _query-dsl/aggregations/pipeline-agg.md
Original file line number Diff line number Diff line change
Expand Up @@ -651,11 +651,11 @@ GET opensearch_dashboards_sample_data_logs/_search

## derivative

The `derivative` aggregation is a parent aggregation that calculates 1st order and 2nd order derivates of each bucket of a previous aggregation.
The `derivative` aggregation is a parent aggregation that calculates 1st order and 2nd order derivatives of each bucket of a previous aggregation.

In mathematics, the derivative of a function measures its sensitivity to change. In other words, a derivative evaluates the rate of change in some function with respect to some variable. To learn more about derivates, see [Wikipedia](https://en.wikipedia.org/wiki/Derivative).
In mathematics, the derivative of a function measures its sensitivity to change. In other words, a derivative evaluates the rate of change in some function with respect to some variable. To learn more about derivatives, see [Wikipedia](https://en.wikipedia.org/wiki/Derivative).

You can use derivates to calculate the rate of change of numeric values compared to its previous time periods.
You can use derivatives to calculate the rate of change of numeric values compared to its previous time periods.

The 1st order derivative indicates whether a metric is increasing or decreasing, and by how much it's increasing or decreasing.

Expand Down
2 changes: 1 addition & 1 deletion _query-dsl/analyzers/language-analyzers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To use the analyzer when you map an index, specify the value within your query.
"analyzer": "french"
```

#### Sample Request
#### Example request

The following query maps an index with the language analyzer set to `french`:

Expand Down
Loading

0 comments on commit ee7d1ef

Please sign in to comment.