-
Notifications
You must be signed in to change notification settings - Fork 656
Update OSD Discover application documentation #12160
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
base: main
Are you sure you want to change the base?
Changes from 7 commits
4c3b77f
d969166
4c64cf5
db28713
52f7465
156c507
b954be2
dafd985
3b4a611
4caa330
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| --- | ||
| layout: default | ||
| title: Field select tool | ||
| parent: Exploring data with Discover | ||
| grand_parent: Exploring data | ||
| nav_order: 40 | ||
| --- | ||
|
|
||
| # Using the field select tool | ||
|
|
||
| By default, the Discover application's **Results** list displays all fields for every document in the list. In the field select tool, you can select which data fields appear in the **Results** list. | ||
|
|
||
| The field select tool is in the vertical panel to the immediate left of the [Discover]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/) application pane. It is available only in the **Discover** application. | ||
|
|
||
|
|
||
| ## Navigating the field select tool | ||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/dashboards/field-select-collapsed-callouts.png" alt="Field select tool" width="400"> | ||
|
|
||
| The following components make up the field select tool. | ||
|
|
||
| - The **Index patterns** dropdown (A) presents all available index patterns. The selected index pattern determines what data are loaded and therefore which fields are available in the field select tool. | ||
| - The **Search field names** (B) box narrows the fields available in the select tool by matching field names to your search string. | ||
| - The **Filter by type** dropdown (C) narrows the fields available based on data properties such as data type and searchability. | ||
| - The **Selected fields** list (D) is a collapsible list of all selected fields. | ||
| - The **Popular fields** list (E) is a collapsible list of recently selected fields. | ||
| - The **Available fields** list (F) is a collapsible list of all fields that have not been selected. | ||
|
|
||
| The **Selected fields**, **Popular fields**, and **Available fields** lists are mutually exclusive. A field appears in only one of these collapsible lists. | ||
| {: .important} | ||
|
|
||
|
|
||
| ## Selecting an index pattern | ||
|
|
||
| Before exploring and visualizing data, you must select an index pattern. | ||
|
|
||
| An index pattern is equivalent to a table view in a traditional relational database system. It defines the data set that you are interested in exploring and visualizing. For information about creating index patterns, see [Index patterns]({{site.url}}{{site.baseurl}}/images/dashboards/field-select-collapsed-callouts.png). | ||
|
|
||
| To select an index pattern: | ||
|
|
||
| In the field select tool, select an index pattern from the **Index patterns** dropdown. | ||
|
|
||
|
|
||
| ## Selecting fields to display | ||
|
|
||
| To select a field for display in the **Results** list: | ||
|
|
||
| 1. Select {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/arrow-right-icon.png" class="inline-icon" alt="expand icon"/>{:/} (expand icon) **Available fields** to expand the **Available fields**. | ||
|
|
||
| If the field has been used recently, it might be in the **Popular fields** list instead of **Available fields**. | ||
| {: .note} | ||
|
|
||
| 1. (Optional) [Use the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="funnel icon"/>{:/} **Filter by type**](#filtering-fields-by-type ) popover to narrow the available fields by type. | ||
|
|
||
| 1. (Optional) Enter text in the **Search field names** box to narrow the list of available fields. | ||
|
|
||
| 1. Select a field in the **Available fields** or **Popular fields** list. | ||
|
|
||
| 1. Choose the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/green-plus-icon.png" class="inline-icon" alt="green plus icon"/>{:/} (add field) icon of the selected field. | ||
|
|
||
| The field is added as a column in the **Results** list in the **Discover** application pane. | ||
|
|
||
| ## Removing fields | ||
|
|
||
| To remove a field from display in the **Results** list: | ||
|
|
||
| 1. Select {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/arrow-right-icon.png" class="inline-icon" alt="expand icon"/>{:/} (expand icon) **Selected fields** to expand the **Selected fields**. | ||
|
|
||
| 1. Choose a field in the **Selected fields** list. | ||
|
|
||
| 1. Choose the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/red-cross-icon.png" class="inline-icon" alt="red cross icon"/>{:/} (remove) icon of the selected field. | ||
|
|
||
| The field is removed from the **Results** list in the **Discover** application pane. | ||
|
|
||
| If the removed field was the last selected field, the **Results** list defaults back to displaying all fields. | ||
| {: .note} | ||
|
|
||
|
|
||
| ## Filtering fields by type | ||
|
|
||
| Often the list of available fields is long. To avoid scrolling through the list you can filter fields in the field select tool by data type and by whether they are aggregatable or searchable. | ||
|
|
||
| The number to the right of {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="funnel icon"/>{:/} **Filter by type** indicates the number of active type filters. | ||
| {: .tip} | ||
|
|
||
| ### Filtering fields by data type | ||
|
|
||
| To narrow the fields in the field select tool by data type: | ||
|
|
||
| 1. Select {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="funnel icon"/>{:/} **Filter by type**. | ||
|
|
||
| 1. In the **Filter by type** popover, select a data type from the **Type** dropdown. | ||
|
|
||
| The fields are restricted to the selected type. | ||
|
|
||
| Fields are restricted in all the lists: **Selected fields**, **Popular fields**,and **Available fields**. | ||
| {: .note} | ||
|
|
||
| ### Filtering fields by property | ||
|
|
||
| 1. Select {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="funnel icon"/>{:/} **Filter by type**. | ||
|
|
||
| 1. In the **Filter by type** popover, select an **Aggregatable** option. For example, selecing **yes** filters out all non-aggregatable fields. | ||
|
|
||
| 1. In the **Filter by type** popover, select a **Searchable** option. For example, selecing **yes** filters out all non-searchable fields. | ||
dwelsch-esi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Searchable fields are fields that are included in the inverted index and are available for search; for more information see [Index]({{site.url}}{{site.baseurl}}/mappings/mapping-parameters/index-parameter). | ||
|
|
||
| ### Filtering missing fields | ||
|
|
||
| To filter out fields with missing data: | ||
|
|
||
| 1. Select {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="funnel icon"/>{:/} **Filter by type**. | ||
|
|
||
| 1. In the **Filter by type** popover, activate on the **Hide missing fields** toggle. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| --- | ||
| layout: default | ||
| title: Filter tool | ||
| parent: Exploring data with Discover | ||
| grand_parent: Exploring data | ||
| nav_order: 30 | ||
| --- | ||
|
|
||
| # Using the filter tool | ||
|
|
||
| The filter tool is at the top of the [Discover]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/) and [Dashboard]({{site.url}}{{site.baseurl}}/dashboards/dashboard/index/) and [Visualize]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/) applications, directly below the **[Search]({{site.url}}{{site.baseurl}}/dashboards/discover/search-bar/)** bar. Use it to add and remove discrete filters to the data displayed in those applications. | ||
|
|
||
| You can create any number of filters. Filters are listed in the filter display between the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) icon and the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/add-filter-icon.png" class="inline-icon" alt="add filter icon"/>{:/} (circle-plus) **Add filter** control. | ||
|
|
||
|
|
||
| ## Navigating the filter tool | ||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/dashboards/filter-tool-callouts.png" alt="Filter tool" width="700"> | ||
|
|
||
| The following components make up the filter tool. | ||
|
|
||
| - The {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) icon (A) provides a drop-down menu of filter options. | ||
| - The filter list (B) shows the currently defined filters. | ||
| - {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/add-filter-icon.png" class="inline-icon" alt="add filter icon"/>{:/} (circle-plus) **Add filter** (C) provides a popover menu for adding data filters. | ||
|
|
||
| ## Adding a filter | ||
|
|
||
| To add a filter using the **Add filter** tool: | ||
|
|
||
| 1. Select {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/add-filter-icon.png" class="inline-icon" alt="add filter icon"/>{:/} (add filter) **Add filter**. | ||
|
|
||
| 1. In the **Edit filter** popover, choose a data field. | ||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/dashboards/edit-filter-popover-filled.png" alt="Edit filter popover" width="400"> | ||
|
|
||
| 1. In the **Operator** field, choose an operator. | ||
|
|
||
| The **Operator** dropdown choices are determined by the chosen data field's type. | ||
| {: .note} | ||
|
|
||
| The Value field appears if needed. | ||
|
|
||
| 1. If required, in the **Value** field, enter or select a value. | ||
|
|
||
| The **Value** entry mode and choices are determined by the chosen operator and data field type. | ||
| {: .note} | ||
|
|
||
| 1. (Optional) Choose **Create custom label?**. | ||
|
|
||
| The custom label replaces the default label composed of the data field name and operator. | ||
|
|
||
| 1. Select **Save**. | ||
|
|
||
| ## Editing a filter | ||
|
|
||
| To change an existing filter: | ||
|
|
||
| 1. Select the filter in the filter list. | ||
|
|
||
| 1. In the filter dropdown, select **Edit filter>**. | ||
|
|
||
| 1. In the **Edit filter** popover, change the **Field**, **Operator**, or **Values** as needed. | ||
|
|
||
| 1. (Optional) Add or change the **Custom label**. | ||
|
|
||
| 1. Select **Save**. | ||
|
|
||
|
|
||
| ## Removing a filter | ||
|
|
||
| To remove a filter, choose the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/cross-icon.png" class="inline-icon" alt="cross icon"/>{:/} (cross) icon to the right of the filter name. | ||
|
|
||
| ## Disabling a filter | ||
|
|
||
| You can disable a filter temporarily without removing it from the filter list. To disable a filter: | ||
|
|
||
| 1. Select the filter in the filter list. | ||
|
|
||
| 1. In the filter dropdown, select **Temporarily disable**. | ||
|
|
||
| Disabled filter names are shown in ~~strikethrough~~ text. | ||
|
Check failure on line 81 in _dashboards/discover/filter-tool.md
|
||
| {: .note} | ||
|
|
||
| ## Re-enabling a filter | ||
|
|
||
| To enable a disabled filter: | ||
|
|
||
| 1. Select a ~~disabled~~ filter in the filter list. | ||
|
|
||
| 1. In the filter dropdown, select **Re-enable**. | ||
|
Check failure on line 90 in _dashboards/discover/filter-tool.md
|
||
|
|
||
|
|
||
| ## Pinning a filter | ||
|
|
||
| You can pin a filter so that it applies to all the applications in OpenSearch Dashboards (Discover, Dashboards, and Visibility). To pin a filter: | ||
dwelsch-esi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 1. Select the filter in the filter list. | ||
|
|
||
| 1. In the filter dropdown, select **Pin across all apps**. | ||
|
|
||
|
|
||
| ## Unpinning a filter | ||
|
|
||
| To unpin a filter that has been pinned to all apps: | ||
|
|
||
| 1. Select the filter in the filter list. | ||
|
|
||
| 1. In the filter dropdown, select **Unpin**. | ||
|
|
||
|
|
||
| ## Modifying all filters as a group | ||
|
|
||
| You can use the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) **Filters** pulldown to change all the filters at once in several ways. | ||
|
Check failure on line 113 in _dashboards/discover/filter-tool.md
|
||
|
|
||
| Modifications made with the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) **Filters** pulldown apply only to the filters in the filter list, not to the query in the **Search** bar or to the time filter. | ||
|
Check failure on line 115 in _dashboards/discover/filter-tool.md
|
||
| {: .note} | ||
|
|
||
| ### Enabling or Disabling all the filters | ||
|
|
||
| To enable or disable all filters: | ||
|
|
||
| 1. Select the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) icon. | ||
|
|
||
| 1. In the **Filters** pulldown, select **Enable all** or **Disable all**. | ||
|
Check failure on line 124 in _dashboards/discover/filter-tool.md
|
||
|
|
||
|
|
||
| ### Inverting which filters are enabled | ||
|
|
||
| To exclude all included filters and include all excluded filters: | ||
|
|
||
| 1. Select the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) icon. | ||
|
|
||
| 1. In the **Filters** pulldown, select **Invert enabled/disabled**. | ||
|
Check failure on line 133 in _dashboards/discover/filter-tool.md
|
||
|
|
||
|
|
||
| ### Inverting the sense of inclusion for all filters | ||
|
|
||
| To negate all filter expressions so that all included documents are excluded and vice versa: | ||
|
Check warning on line 138 in _dashboards/discover/filter-tool.md
|
||
|
|
||
| 1. Select the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) icon. | ||
|
|
||
| 1. In the **Filters** pulldown, select **Invert inclusion**. | ||
|
|
||
| Exclusion filters have **NOT** appended to their title, as shown below. Inverting inclusion a second time removes the **NOT** modifier. | ||
|
Check warning on line 144 in _dashboards/discover/filter-tool.md
|
||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/dashboards/excluded-filter.png" alt="Exclusion filter" width="200"> | ||
|
|
||
| Disabled filters are inverted, but remain disabled. | ||
| {: .note} | ||
|
|
||
| ### Pinning or unpinning all filters | ||
|
|
||
| To pin or unpin all filters in all OpenSearch Dashboards applications (Discover, Dashboards, and Visualize): | ||
|
|
||
| 1. Select the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) icon. | ||
|
|
||
| 1. In the **Filters** pulldown, select **Pin all** or **Unpin all**. | ||
|
|
||
|
|
||
| ### Removing all filters | ||
|
|
||
| To remove all filters from the filter list: | ||
|
|
||
| 1. Select the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/funnel-icon.png" class="inline-icon" alt="filter menu icon"/>{:/} (funnel) icon. | ||
|
|
||
| 1. In the **Filters** pulldown, select **Remove all**. | ||
Uh oh!
There was an error while loading. Please reload this page.