Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
146 commits
Select commit Hold shift + click to select a range
faf423e
Create Dashboards quickstart
vagimeli Jan 14, 2023
70dacab
Create new pages
vagimeli Jan 14, 2023
6d7adf2
Create pages
vagimeli Jan 14, 2023
dcb2a1f
Add new content and pages
vagimeli Jan 17, 2023
477cb49
Move DQL page and copy edit
vagimeli Jan 17, 2023
26cea8d
Add more content
vagimeli Jan 17, 2023
37505f5
Add more content
vagimeli Jan 18, 2023
8ac263c
Continue writing
vagimeli Jan 18, 2023
31329c9
Send out first pass draft
vagimeli Jan 18, 2023
6fec96d
Address tech review
vagimeli Jan 18, 2023
06fc26c
Update _dashboards/get-started/dql.md
vagimeli Jan 23, 2023
bb7f3be
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 24, 2023
8f15e8d
Update _dashboards/get-started/dql.md
vagimeli Jan 24, 2023
b668580
Update _dashboards/get-started/dql.md
vagimeli Jan 24, 2023
39fa3b9
Add new Rules documentation that covers YAML Editor view (#2407)
cwillum Jan 14, 2023
38eaa6b
Update opensearch-documentation-release-notes-2.4.0.md (#2406)
hdhalter Jan 17, 2023
b5e4383
Adds documentation for Admin UI index operations (#2403)
ariamarble Jan 17, 2023
41217aa
Fixes allow_partial_pit_creation (#2411)
kolchfa-aws Jan 17, 2023
6a69d19
Adds border to images (#2415)
kolchfa-aws Jan 17, 2023
c36ae65
Adds Jaeger trace data for analytics documentation (#2374)
alicejw1 Jan 17, 2023
21f0d00
Adds maps documentation (#2376)
kolchfa-aws Jan 17, 2023
161fbd7
Updates to Security Analytics documentation (#2408)
cwillum Jan 18, 2023
c3f3fe7
Add GPU acceleration documentation (#2384)
Naarcha-AWS Jan 18, 2023
1faeaf5
Adds cluster health by awareness attribute documentation (#2398)
kolchfa-aws Jan 18, 2023
80e7599
Updates remote-backed storage documentation (#2363)
kolchfa-aws Jan 18, 2023
de36e45
Move pages (#2425)
vagimeli Jan 18, 2023
056df67
Add Query String for rollups (#2428)
Naarcha-AWS Jan 19, 2023
6603ab4
Adds query string query documentation (#2427)
kolchfa-aws Jan 19, 2023
07cf3e4
Editorial for Admin UI index operations (#2421)
ariamarble Jan 19, 2023
2cfbe3c
Admin UI further editorial updates (#2444)
ariamarble Jan 19, 2023
8947b7e
Adds second image style with no border (#2445)
kolchfa-aws Jan 20, 2023
7f84872
Adds installation guide for OpenSearch Dashboards debian distribution…
Jan 20, 2023
e58ad65
Update field mapping documentation for Security Analytics (#2422)
cwillum Jan 23, 2023
9ca2980
Minor changes to Data Prepper index.md. (#2426)
carolxob Jan 23, 2023
0f451f7
Editorial changes (#2454)
Jan 23, 2023
055f269
add two new settings for Anomaly Detection 2.5 (#2450)
amitgalitz Jan 23, 2023
b0d20fe
Add new ML cluster settings for 2.5 (#2442)
Naarcha-AWS Jan 23, 2023
c5cf556
Remove Install and Configure home page (#2449)
Naarcha-AWS Jan 23, 2023
891be1f
Add cluster awareness and decommission docs (#2438)
Naarcha-AWS Jan 23, 2023
ef69c95
Adds generated documentation to clients (#2458)
kolchfa-aws Jan 24, 2023
94a2f52
Fix links for 2.5 doc changes. (#2465)
Naarcha-AWS Jan 24, 2023
20d4c55
Add k-NN filter to neural search (#2466)
Naarcha-AWS Jan 24, 2023
30d65e2
Adds release notes 2.5 (#2441)
kolchfa-aws Jan 24, 2023
8b93fd7
Fix typo in Neural Search (#2468)
Naarcha-AWS Jan 24, 2023
96f127a
Adds version history 2.5 (#2437)
kolchfa-aws Jan 24, 2023
7998786
Adds 2.5.0 version (#2436)
kolchfa-aws Jan 24, 2023
d7fb1ba
Rewords release notes header (#2470)
kolchfa-aws Jan 24, 2023
e427f8f
Updates table format for version history (#2480)
kolchfa-aws Jan 24, 2023
b4bb86a
Add Monitoring to doc website repo (#2018)
carolxob Jan 24, 2023
ba735f0
Update docker.md (#2375)
justinhyou Jan 24, 2023
6f0a3c5
Add additional ML cluster settings (#2487)
Naarcha-AWS Jan 25, 2023
e402ebd
Adds UI text guidance to style guide (#2495)
natebower Jan 25, 2023
cc5f4a7
Adjusts spacing (#2496)
natebower Jan 25, 2023
7693322
Address tech and doc reviewer feedback
vagimeli Jan 23, 2023
7c47d0a
Address tech and doc review feedback
vagimeli Jan 24, 2023
ef4c78a
Address tech and doc review comments
vagimeli Jan 24, 2023
57d75ed
Copy edits
vagimeli Jan 24, 2023
a601948
Copy edits
vagimeli Jan 24, 2023
2f663bc
Copy edits
vagimeli Jan 24, 2023
e1efc70
Copy edits
vagimeli Jan 24, 2023
674f779
Address tech review feedback
vagimeli Jan 25, 2023
745a456
Continue updating for accuracy
vagimeli Jan 25, 2023
350b046
address tech and doc review
vagimeli Jan 25, 2023
47f149c
Finalize for editorial review
vagimeli Jan 25, 2023
88c15c7
Revert "Adjusts spacing (#2496)"
vagimeli Jan 25, 2023
c6784ca
Revert "Adds UI text guidance to style guide (#2495)"
vagimeli Jan 25, 2023
cc24181
Revert "Add additional ML cluster settings (#2487)"
vagimeli Jan 26, 2023
051c873
Copy edits
vagimeli Jan 26, 2023
d4b9898
Revert "Update docker.md (#2375)"
vagimeli Jan 26, 2023
8127367
Revert "Add Monitoring to doc website repo (#2018)"
vagimeli Jan 26, 2023
102fb59
Revert "Updates table format for version history (#2480)"
vagimeli Jan 26, 2023
4bc2470
Revert "Rewords release notes header (#2470)"
vagimeli Jan 26, 2023
50ac195
Revert "Adds 2.5.0 version (#2436)"
vagimeli Jan 26, 2023
0e6594d
Revert "Adds version history 2.5 (#2437)"
vagimeli Jan 26, 2023
459b702
Revert "Fix typo in Neural Search (#2468)"
vagimeli Jan 26, 2023
d4ea485
Revert "Adds release notes 2.5 (#2441)"
vagimeli Jan 26, 2023
b1f34ae
Revert "Add k-NN filter to neural search (#2466)"
vagimeli Jan 26, 2023
7363e7b
Revert "Fix links for 2.5 doc changes. (#2465)"
vagimeli Jan 26, 2023
cc51c26
Revert "Adds generated documentation to clients (#2458)"
vagimeli Jan 26, 2023
1ef8ff9
Revert "Add cluster awareness and decommission docs (#2438)"
vagimeli Jan 26, 2023
afe92d9
Revert "Remove Install and Configure home page (#2449)"
vagimeli Jan 26, 2023
62b1332
Revert "Add new ML cluster settings for 2.5 (#2442)"
vagimeli Jan 26, 2023
c2a3f64
Revert "add two new settings for Anomaly Detection 2.5 (#2450)"
vagimeli Jan 26, 2023
65a5d20
Revert "Editorial changes (#2454)"
vagimeli Jan 26, 2023
97aaf3f
Revert "Minor changes to Data Prepper index.md. (#2426)"
vagimeli Jan 26, 2023
574d924
Revert "Update field mapping documentation for Security Analytics (#2…
vagimeli Jan 26, 2023
2f00e96
Revert "Adds installation guide for OpenSearch Dashboards debian dist…
vagimeli Jan 26, 2023
97e0644
Revert "Adds second image style with no border (#2445)"
vagimeli Jan 26, 2023
ab12816
Revert "Admin UI further editorial updates (#2444)"
vagimeli Jan 26, 2023
cf48642
Revert "Editorial for Admin UI index operations (#2421)"
vagimeli Jan 26, 2023
e4d4db1
Revert "Adds query string query documentation (#2427)"
vagimeli Jan 26, 2023
05d49e7
Revert "Add Query String for rollups (#2428)"
vagimeli Jan 26, 2023
be89411
Revert "Adds cluster health by awareness attribute documentation (#23…
vagimeli Jan 26, 2023
52092ba
Revert "Updates remote-backed storage documentation (#2363)"
vagimeli Jan 26, 2023
b70cffd
Revert "Updates to Security Analytics documentation (#2408)"
vagimeli Jan 26, 2023
cf64b30
Revert "Adds maps documentation (#2376)"
vagimeli Jan 26, 2023
300e4c7
Revert "Adds Jaeger trace data for analytics documentation (#2374)"
vagimeli Jan 26, 2023
f7b789b
Revert "Adds border to images (#2415)"
vagimeli Jan 26, 2023
22e1f90
Revert "Fixes allow_partial_pit_creation (#2411)"
vagimeli Jan 26, 2023
689a01f
Revert "Adds documentation for Admin UI index operations (#2403)"
vagimeli Jan 26, 2023
b79ef74
Revert "Update opensearch-documentation-release-notes-2.4.0.md (#2406)"
vagimeli Jan 26, 2023
73ae37b
Revert "Add new Rules documentation that covers YAML Editor view (#24…
vagimeli Jan 26, 2023
c57a9b8
Final doc review feedback
vagimeli Jan 26, 2023
94fe97b
Update _dashboards/get-started/dql.md
vagimeli Jan 26, 2023
fe010c1
Update _dashboards/get-started/dql.md
vagimeli Jan 26, 2023
41f013e
Update _dashboards/get-started/dql.md
vagimeli Jan 26, 2023
a2d81f0
Update _dashboards/get-started/dql.md
vagimeli Jan 26, 2023
b70390f
Revert "Add GPU acceleration documentation (#2384)"
vagimeli Jan 26, 2023
52d424f
Address final doc review feedback
vagimeli Jan 26, 2023
abcde81
Copy edits
vagimeli Jan 26, 2023
0a55b3c
Scroll to top when last visit was more than 24 hours ago (#2457)
kolchfa-aws Jan 26, 2023
057d418
Makes version selector sticky (#2492)
kolchfa-aws Jan 26, 2023
c7a03b2
Copy edits
vagimeli Jan 26, 2023
e707aac
Copy edits
vagimeli Jan 26, 2023
94f7186
Finalize for editorial review
vagimeli Jan 26, 2023
b71c337
Revert "Scroll to top when last visit was more than 24 hours ago (#24…
vagimeli Jan 30, 2023
e64fe9f
Revert "Makes version selector sticky (#2492)"
vagimeli Jan 30, 2023
25a1a72
Delete getting started page; replace with Quickstart page
vagimeli Jan 30, 2023
df36658
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
c47067d
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
702e3a5
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
f801bb9
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
b04fff2
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
529e7b0
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
131d188
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
fa625f8
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
7c2d6bb
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
ed04527
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
daaed6b
Update _dashboards/get-started/dql.md
vagimeli Jan 31, 2023
76e6696
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 31, 2023
71b04dc
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 31, 2023
c8f15c2
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 31, 2023
ffcee49
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 31, 2023
4c0dece
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 31, 2023
4c2486f
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 31, 2023
405ff73
Update _dashboards/get-started/quickstart-dashboards.md
vagimeli Jan 31, 2023
49d879e
Address editorial feedback
vagimeli Jan 31, 2023
5416bbc
Delete gantt.md
vagimeli Jan 31, 2023
f27a038
Delete visbuilder.md
vagimeli Jan 31, 2023
a8cc4f5
Move images to dashboards images folder
vagimeli Jan 31, 2023
c82ebac
Address editorial feedback
vagimeli Feb 1, 2023
3017b48
Re-review for editorial
vagimeli Feb 1, 2023
2932dd6
Move page to Discover section
vagimeli Feb 1, 2023
2ebe099
Remove core concepts page; gloassry to be created
vagimeli Feb 1, 2023
08d6e5a
Remove core concepts page; gloassry to be created
vagimeli Feb 1, 2023
821af03
Update sample data graphic
vagimeli Feb 1, 2023
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
142 changes: 0 additions & 142 deletions _dashboards/dql.md

This file was deleted.

8 changes: 8 additions & 0 deletions _dashboards/get-started/core-concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: OpenSearch Dashboards core concepts
nav_order: 30
has_children: true
---

# OpenSearch Dashboards core concepts
134 changes: 134 additions & 0 deletions _dashboards/get-started/dql.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
layout: default
title: Dashboards Query Language
parent: OpenSearch Dashboards core concepts
nav_order: 40
redirect_from:
- /dashboards/dql/
---

# Dashboards Query Language

Dashboards Query Language (DQL) is a simple text-based query language for filtering data in OpenSearch Dashboards. Similar to [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index), DQL uses HTTP request body. For example, to display your site visitor data for a host in the United States, you would enter `geo.dest:US` into the search field.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

This documentation uses the Dashboards web log sample data set. See [Quickstart for OpenSearch Dashboards]() to learn how to add sample data to Dashboards.
{: .note}

## Terms query

The most basic query is to specify the search term.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
host:www.example.com
```

To access an object's nested field, list the complete path to the field separated by periods. For example, to retrieve the `lat` field in the `coordinates` object:
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
coordinates.lat:43.7102
```

DQL supports leading and trailing wildcards, so you can search for any terms that match your pattern.

```
host.keyword:*.example.com/*
```

To check if a field exists or has any data, use a wildcard to see if Dashboards returns any results.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
host.keyword:*
```

## Boolean query

To mix and match or combine multiple queries for more refined results, you can use the boolean operators `and`, `or`, and `not`. DQL is not case sensitive, so `AND` and `and` are the same.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
host.keyword:www.example.com and response.keyword:200
Comment thread
vagimeli marked this conversation as resolved.
```

The following example shows how to use multiple operators in one query.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
geo.dest:US or response.keyword:200 and host.keyword:www.example.com
```

Remember that boolean operators follow the logical precedence order of `not`, `and`, and `or`, so if you have an expression like the previous example, `response.keyword:200 and host.keyword:www.example.com` gets evaluated first, and then Dashboards uses that result to compare with `geo.dest:US`.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

To avoid confusion, use parentheses to dictate the order in which you want to evaluate. If you want to evaluate `geo.dest:US or response.keyword:200` first, the expression is:
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
(geo.dest:US or response.keyword:200) and host.keyword:www.example.com
```

## Date and range queries

DQL supports numeric inequalities.

```
bytes >= 15 and memory < 15
Comment thread
vagimeli marked this conversation as resolved.
Outdated
```

Similarly, you can use the same method to find a date before or after the query. `>` indicates a search for a date after the specified date, and `<` returns dates before.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
@timestamp > "2020-12-14T09:35:33"
Comment thread
vagimeli marked this conversation as resolved.
Outdated
```

## Nested field query

If you have a document with nested fields, you must specify which parts of the document to retrieve.

For example, if you have the following document:

```json
{
"superheroes":[
{
"hero-name": "Superman",
"real-identity": "Clark Kent",
"age": 28
},
{
"hero-name": "Batman",
"real-identity": "Bruce Wayne",
"age": 26
},
{
"hero-name": "Flash",
"real-identity": "Barry Allen",
"age": 28
},
{
"hero-name": "Robin",
"real-identity": "Dick Grayson",
"age": 15
}
]
}
```

The following example shows how to use DQL to retrieve a specific field.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

```
superheroes: {hero-name: Superman}
```

If you want to retrieve multiple objects from your document, specify all the fields you want to retrieve.

```
superheroes: {hero-name: Superman} and superheroes: {hero-name: Batman}
```

The previous boolean and range queries still work, so you can submit a more refined query.

```
superheroes: {hero-name: Superman and age < 50}
```

If your document has an object nested within another object, you can retrieve data by specifying all the levels.

```
justice-league.superheroes: {hero-name:Superman}
Comment thread
vagimeli marked this conversation as resolved.
Outdated
```
15 changes: 7 additions & 8 deletions _dashboards/index.md → _dashboards/get-started/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Getting started with OpenSearch Dashboards
nav_order: 1
title: Get started with OpenSearch Dashboards
nav_order: 10
has_children: false
has_toc: false
redirect_from:
Expand All @@ -11,15 +11,15 @@ redirect_from:

{%- comment -%}The `/docs/opensearch-dashboards/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}

# Getting started with OpenSearch Dashboards
# Get started with OpenSearch Dashboards

OpenSearch Dashboards is an open-source, integrated visualization tool that makes it easy for users to explore their data in OpenSearch. From real-time application monitoring, threat detection, and incident management to personalized search, OpenSearch Dashboards gives you the data visualizations needed to graphically represent trends, outliers, and patterns in your data. The image below shows a sample of data visualizations in OpenSearch Dashboards.

<img src="{{site.url}}{{site.baseurl}}/images/dashboard-flight.png" alt="User interface showing several data visualizations">
Comment thread
vagimeli marked this conversation as resolved.
Outdated

## Use cases for OpenSearch Dashboards

In OpenSearch Dashboards, a data dashboard is a collection of charts, graphs, gauges, and other visualizations that gives you a snapshot of the data that you're interested in and that you interact with. You can track, analyze, and display real-time search, monitoring, and analysis of business and operational data for use cases like application monitoring, log analytics, observability, and website search. The image below shows data visualization use cases for OpenSearch Dashboards.
A dashboard is a collection of charts, graphs, gauges, and other visualizations that gives you a snapshot of the data that you're interested in and that you interact with. You can track, analyze, and display real-time search, monitoring, and analysis of business and operational data for use cases like application monitoring, log analytics, observability, and website search. The image below shows data visualization use cases for OpenSearch Dashboards.
Comment thread
vagimeli marked this conversation as resolved.
Outdated

<table style="table-layout: fixed; width: 100%;">
<tbody>
Expand Down Expand Up @@ -53,8 +53,7 @@ The image below shows a [Logs] Web Traffic dashboard with filters applied.
You can run OpenSearch Dashboards on a local host after installing OpenSearch. See [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/) and [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/) for installation instructions.

## Related links
- [Getting Started with OpenSearch]({{site.url}}{{site.baseurl}}).
- [Launch Highlight: OpenSearch Playground](https://www.opensearch.org/blog/community/2022/10/opensearch-playground/)
- [Upgrade from Kibana OSS to OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/upgrade-to/dashboards-upgrade-to/)
- [OpenSearch Dashboards Quickstart]()
- [OpenSearch Frequently Asked Questions]({{site.url}}/faq/)
- [OpenSearch Dashboards Developer Guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md)
- [OpenSearch Dashboards Developer Guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md)
- [Upgrade from Kibana OSS to OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/upgrade-to/dashboards-upgrade-to/)
Loading