Skip to content

Add forecasting section #10133

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

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
5b22f53
Forecasting doc
kaituo Jun 23, 2025
ebce30c
Merge branch 'main' into forecasting
Naarcha-AWS Jun 23, 2025
f5dcb8f
Break up intro page and getting started into seperate sections
Naarcha-AWS Jun 23, 2025
845957d
Writer edits for forecasting section
Naarcha-AWS Jun 24, 2025
dd2ddb0
Merge branch 'main' into kaituo-forecasting
Naarcha-AWS Jun 24, 2025
0324d54
Update index.md
Naarcha-AWS Jun 24, 2025
b514f94
Update index.md
Naarcha-AWS Jun 24, 2025
e1981f2
Apply suggestions from code review
Naarcha-AWS Jun 24, 2025
34db31a
Update _observing-your-data/forecast/getting-started.md
Naarcha-AWS Jun 24, 2025
349c683
Update _observing-your-data/forecast/getting-started.md
Naarcha-AWS Jun 24, 2025
07f6bdb
Apply suggestions from code review
Naarcha-AWS Jun 24, 2025
e569953
Add Kaito's feedback.
Naarcha-AWS Jun 24, 2025
377e40d
Merge branch 'main' into kaituo-forecasting
Naarcha-AWS Jun 24, 2025
9b1524c
Address final comments
Naarcha-AWS Jun 24, 2025
241728d
Small tweaks
Naarcha-AWS Jun 24, 2025
7aaefb6
One last small tweak
Naarcha-AWS Jun 24, 2025
172cd9e
Apply suggestions from code review
Naarcha-AWS Jun 25, 2025
ffde249
Remove benefits section
Naarcha-AWS Jun 25, 2025
bd5c9aa
Apply suggestions from code review
Naarcha-AWS Jun 26, 2025
0ad65a1
Apply suggestions from code review
Naarcha-AWS Jun 26, 2025
5c6ca42
Apply suggestions from code review
Naarcha-AWS Jun 26, 2025
936e4e9
Update security.md
Naarcha-AWS Jun 26, 2025
ddee6a7
Apply suggestions from code review
Naarcha-AWS Jun 26, 2025
cb16400
Apply suggestions from code review
Naarcha-AWS Jun 26, 2025
17419c1
Apply suggestions from code review
Naarcha-AWS Jun 27, 2025
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
28 changes: 10 additions & 18 deletions _observing-your-data/ad/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,30 +28,22 @@
A _detector_ is an individual anomaly detection task. You can define multiple detectors, and all detectors can run simultaneously, with each analyzing data from different sources. You can define a detector by following these steps:

1. On the **Anomaly detection** page, select the **Create detector** button.
2. On the **Define detector** page, enter the required information in the **Detector details** pane.
3. In the **Select data** pane, specify the data source by choosing a source from the **Index** dropdown menu. You can choose an index, index patterns, or an alias.
4. (Optional) Filter the data source by selecting **Add data filter** and then entering the conditions for **Field**, **Operator**, and **Value**. Alternatively, you can choose **Use query DSL** and add your JSON filter query. Only [Boolean queries]({{site.url}}{{site.baseurl}}/query-dsl/compound/bool/) are supported for query domain-specific language (DSL).
2. On the **Define detector** page, add the detector details. Enter a name and a brief description. The name must be unique and descriptive enough to help you identify the detector's purpose.

### Example: Filtering data using query DSL
3. In the **Select data** pane, specify the data source by choosing one or more sources from the **Index** dropdown menu. You can select indexes, index patterns, or aliases.

The following example query retrieves documents in which the `urlPath.keyword` field matches any of the specified values. To set up the detector, use the following steps.
- Detectors can use remote indexes, which you can access using the `cluster-name:index-name` pattern. For more information, see [Cross-cluster search]({{site.url}}{{site.baseurl}}/search-plugins/cross-cluster-search/). Starting in OpenSearch Dashboards 2.17, you can also select clusters and indexes directly. If the Security plugin is enabled, see [Selecting remote indexes with fine-grained access control]({{site.url}}{{site.baseurl}}/observing-your-data/ad/security/#selecting-remote-indexes-with-fine-grained-access-control) in the [Anomaly detection security]({{site.url}}{{site.baseurl}}/observing-your-data/ad/security/) documentation.

Check failure on line 35 in _observing-your-data/ad/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _observing-your-data/ad/index.md#L35

[OpenSearch.Spelling] Error: selectin. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: selectin. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_observing-your-data/ad/index.md", "range": {"start": {"line": 35, "column": 475}}}, "severity": "ERROR"}

#### Setting the initial detector settings
- To create a cross-cluster detector in OpenSearch Dashboards, you must have the following [permissions]({{site.url}}{{site.baseurl}}/security/access-control/permissions/): `indices:data/read/field_caps`, `indices:admin/resolve/index`, and `cluster:monitor/remote/info`.

1. Choose **Create detector**.
1. Add the detector details. Enter a name and brief description. Make sure the name is unique and descriptive enough to help you identify the purpose of the detector.
1. Specify the data source.
- For **Data source**, choose one or more indexes to use as the data source. Alternatively, you can use an alias or index pattern to choose multiple indexes, similarly to the following:
- /domain/{id}/short
- /sub_dir/{id}/short
- /abcd/123/{id}/xyz
- Detectors can use remote indexes. You can access them using the `cluster-name:index-name` pattern. See [Cross-cluster search]({{site.url}}{{site.baseurl}}/search-plugins/cross-cluster-search/) for more information. Alternatively, you can select clusters and indexes in OpenSearch Dashboards 2.17 or later. To learn about configuring remote indexes with the Security plugin enabled, see [Selecting remote indexes with fine-grained access control]({{site.url}}{{site.baseurl}}/observing-your-data/ad/security/#selecting-remote-indexes-with-fine-grained-access-control) in the [Anomaly detection security](observing-your-data/ad/security/) documentation.
- (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. Only [Boolean queries]({{site.url}}{{site.baseurl}}/query-dsl/compound/bool/) are supported for query DSL. The following example `bool` query shows you how to use query DSL:
4. (Optional) Filter the data source by selecting **Add data filter** and then specifying the conditions for **Field**, **Operator**, and **Value**. Alternatively, select **Use query DSL** and enter your filter as a JSON-formatted [Boolean query]({{site.url}}{{site.baseurl}}/query-dsl/compound/bool/). Only Boolean queries are supported for query domain-specific language (DSL).

To create a cross-cluster detector in OpenSearch Dashboards, the following [permissions]({{site.url}}{{site.baseurl}}/security/access-control/permissions/) are required: `indices:data/read/field_caps`, `indices:admin/resolve/index`, and `cluster:monitor/remote/info`.
{: .note}




### Example: Filtering data using query DSL

The following example query retrieves documents in which the `urlPath.keyword` field matches any of the specified values:

```json
{
Expand Down
Loading