Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
582 changes: 0 additions & 582 deletions _includes/icons.html

This file was deleted.

20 changes: 10 additions & 10 deletions _search-plugins/ubi/ubi-dashboard-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To quickly view a dashboard without completing the full tutorial, do the followi
## 1. Start OpenSearch Dashboards

Start OpenSearch Dashboards. For example, go to `http://{server}:5601/app/home#/`. For more information, see [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/). The following image shows the home page.
![Dashboard Home]({{site.url}}{{site.baseurl}}/images/ubi/home.png "Dashboards")
![Dashboard Home]({{site.url}}{{site.baseurl}}/images/ubi/home.png)

## 2. Create an index pattern

Expand All @@ -31,7 +31,7 @@ In OpenSearch Management, navigate to **Dashboards Management > Index patterns**
OpenSearch Dashboards accesses your indexes using index patterns. To visualize your users' online search behavior, you must create an index pattern in order to access the indexes that UBI creates. For more information, see [Index patterns]({{site.url}}{{site.baseurl}}/dashboards/management/index-patterns/).

After you select **Create index pattern**, a list of indexes in your OpenSearch instance is displayed. The UBI stores may be hidden by default, so make sure to select **Include system and hidden indexes**, as shown in the following image.
![Index Patterns]({{site.url}}{{site.baseurl}}/images/ubi/index_pattern2.png "Index Patterns")
![Index Patterns]({{site.url}}{{site.baseurl}}/images/ubi/index_pattern2.png)

You can group indexes into the same data source for your dashboard using wildcards. For this tutorial you'll combine the query and event stores into the `ubi_*` pattern.

Expand All @@ -50,7 +50,7 @@ If you haven't previously created a dashboard, you are presented with the option
In the **New Visualization** window, select **Pie** to create a new pie chart. Then select the index pattern you created in step 2.

Most visualizations require some sort of aggregate function on a bucket/facet/aggregatable field (numeric or keyword). You'll add a `Terms` aggregation to the `action_name` field so that you can view the distribution of event names. Change the **Size** to the number of slices you want to display, as shown in the following image.
![Pie Chart]({{site.url}}{{site.baseurl}}/images/ubi/pie.png "Pie Chart")
![Pie Chart]({{site.url}}{{site.baseurl}}/images/ubi/pie.png)

Save the visualization so that it's added to your new dashboard. Now that you have a visualization displayed on your dashboard, you can save the dashboard.

Expand All @@ -61,34 +61,34 @@ Now you'll add a word cloud for trending searches by creating a new visualizatio
In the **New Visualization** window, select **Tag Cloud**, and then select the index pattern you created in step 2. Choose the tag cloud visualization of the terms in the `message` field where the JavaScript client logs the raw search text. Note: The true query, as processed by OpenSearch with filters, boosting, and so on, resides in the `ubi_queries` index. However, you'll view the `message` field of the `ubi_events` index, where the JavaScript client captures the text that the user actually typed.

The following image shows the tag cloud visualization on the `message` field.
![Word Cloud]({{site.url}}{{site.baseurl}}/images/ubi/tag_cloud1.png "Word Cloud")
![Word Cloud]({{site.url}}{{site.baseurl}}/images/ubi/tag_cloud1.png)

The underlying queries can be found at [SQL trending queries]({{site.url}}{{site.baseurl}}/search-plugins/ubi/sql-queries/#trending-queries).
{: .note}


The resulting visualization may contain different information than you're looking for. The `message` field is updated with every event, and as a result, it can contain error messages, debug messages, click information, and other unwanted data.
To view only search terms for query events, you need to add a filter to your visualization. Because during setup you provided a `message_type` of `QUERY` for each search event, you can filter by that message type to isolate the specific users' searches. To do this, select **Add filter** and then select **QUERY** in the **Edit filter** panel, as shown in the following image.
![Word Cloud]({{site.url}}{{site.baseurl}}/images/ubi/tag_cloud2.png "Word Cloud")
![Word Cloud]({{site.url}}{{site.baseurl}}/images/ubi/tag_cloud2.png)

There should now be two visualizations (the pie chart and the tag cloud) displayed on your dashboard, as shown in the following image.
![UBI Dashboard]({{site.url}}{{site.baseurl}}/images/ubi/dashboard2.png "UBI Dashboard")
![UBI Dashboard]({{site.url}}{{site.baseurl}}/images/ubi/dashboard2.png)

## 5. Add a histogram of item clicks

Now you'll add a histogram visualization to your dashboard, similarly to the previous step. In the **New Visualization** window, select **Vertical Bar**. Then select the index pattern you created in step 2.

Examine the `event_attributes.position.ordinal` data field. This field contains the position of the item in a list selected by the user. For the histogram visualization, the x-axis represents the ordinal number of the selected item (n). The y-axis represents the number of times that the nth item was clicked, as shown in the following image.

![Vertical Bar Chart]({{site.url}}{{site.baseurl}}/images/ubi/histogram.png "Vertical Bar Chart")
![Vertical Bar Chart]({{site.url}}{{site.baseurl}}/images/ubi/histogram.png)

## 6) Filter the displayed data
## 6. Filter the displayed data

Now you can further filter the displayed data. For example, you can see how the click position changes when a purchase occurs. Select **Add filter** and then select the `action_name:product_purchase` field, as shown in the following image.
![Product Purchase]({{site.url}}{{site.baseurl}}/images/ubi/product_purchase.png "Product Purchase")
![Product Purchase]({{site.url}}{{site.baseurl}}/images/ubi/product_purchase.png)


You can filter event messages containing the word `*laptop*` by adding wildcards, as shown in the following image.
![Laptop]({{site.url}}{{site.baseurl}}/images/ubi/laptop.png "Laptop").
![Laptop]({{site.url}}{{site.baseurl}}/images/ubi/laptop.png).


Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Complete the following fields, keeping all other fields at their default values:

If you already have a SageMaker inference endpoint, you can configure a model using that endpoint, as shown in the following image.

![Using an existing SageMaker inference endpoint]({{site.url}}{{site.baseurl}}/images/semantic_search/semantic_search_remote_model_Integration_3.png)
![Using an existing SageMaker inference endpoint]({{site.url}}{{site.baseurl}}/images/vector-search-tutorials/semantic_search_remote_model_Integration_3.png)

Complete the following fields, keeping all others at their default values:

Expand Down
Binary file removed images/1_search.png
Binary file not shown.
Binary file removed images/2_monitoring.png
Binary file not shown.
Binary file removed images/3_security.png
Binary file not shown.
Binary file removed images/4_tracking.png
Binary file not shown.
Binary file removed images/Flight-data.png
Binary file not shown.
Binary file removed images/Security/agg-view-saved-objects.png
Binary file not shown.
Binary file removed images/Security/create-a-rule.png
Binary file not shown.
Binary file removed images/Security/field_map.png
Binary file not shown.
Binary file removed images/Security/log-field.png
Binary file not shown.
Binary file removed images/Security/rule-dup3.png
Binary file not shown.
Binary file removed images/Security/select_rules.png
Binary file not shown.
Binary file removed images/admin-ui-index/admin-UI-preview.gif
Binary file not shown.
Binary file removed images/admin-ui-index/create-template.png
Binary file not shown.
Binary file removed images/admin-ui-index/datastreams2.png
Binary file not shown.
Binary file removed images/admin-ui-index/reindex.png
Binary file not shown.
Binary file removed images/admin-ui-index/split.png
Binary file not shown.
Binary file removed images/admin-ui-index/view-template.png
Binary file not shown.
Binary file removed images/alerting.png
Binary file not shown.
Binary file removed images/analyzing-data-logs.png
Binary file not shown.
Binary file removed images/anomaly-detection.png
Binary file not shown.
Binary file removed images/benchmark/metric-index-pattern.png
Binary file not shown.
Binary file removed images/county-regionmap.png
Binary file not shown.
Binary file removed images/creating-user.png
Binary file not shown.
Binary file removed images/dashboard-flight.png
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed images/dashboards-assistant/entry.png
Diff not rendered.
Binary file removed images/dashboards-assistant/rate.png
Diff not rendered.
Binary file removed images/dashboards-assistant/response.png
Diff not rendered.
Diff not rendered.
Binary file removed images/dashboards-assistant/start-conversation.png
Diff not rendered.
Binary file removed images/dashboards-assistant/suggestions.png
Diff not rendered.
Binary file removed images/dashboards-assistant/traces.png
Diff not rendered.
Binary file removed images/dashboards-nav.png
Diff not rendered.
Binary file removed images/dashboards/S3-config-UI.png
Diff not rendered.
Binary file removed images/dashboards/SigV4-setup.png
Diff not rendered.
Binary file removed images/dashboards/accelerate-data-popup.png
Diff not rendered.
Binary file removed images/dashboards/add-data.png
Diff not rendered.
Binary file removed images/dashboards/add-fields-skipping-index.png
Diff not rendered.
Binary file removed images/dashboards/add-panel.png
Diff not rendered.
Binary file removed images/dashboards/add-panel2.png
Diff not rendered.
Binary file removed images/dashboards/add-sample-data-2.png
Diff not rendered.
Binary file removed images/dashboards/add-sample-data.gif
Diff not rendered.
Binary file removed images/dashboards/add-sample-data.png
Diff not rendered.
Binary file removed images/dashboards/appearance-home.png
Diff not rendered.
Binary file removed images/dashboards/arrange-columns.png
Diff not rendered.
Binary file removed images/dashboards/configure-bar-viz.png
Diff not rendered.
Binary file removed images/dashboards/covering-index-fields.png
Diff not rendered.
Binary file removed images/dashboards/covering-index-naming.png
Diff not rendered.
Binary file removed images/dashboards/create-index-pattern.png
Diff not rendered.
Diff not rendered.
Binary file removed images/dashboards/dashboard-index.png
Diff not rendered.
Binary file removed images/dashboards/dashboards-home.png
Diff not rendered.
Binary file removed images/dashboards/dashboards-management-ui.png
Diff not rendered.
Binary file removed images/dashboards/dashboards-mgmt.png
Diff not rendered.
Binary file removed images/dashboards/dashboards-overview-page.png
Diff not rendered.
Binary file removed images/dashboards/data-fields.png
Diff not rendered.
Binary file removed images/dashboards/data-source-connection.png
Diff not rendered.
Binary file removed images/dashboards/data-sources-UI.png
Diff not rendered.
Binary file removed images/dashboards/data-sources-management.png
Diff not rendered.
Binary file removed images/dashboards/data-sources.png
Diff not rendered.
Binary file removed images/dashboards/dataset-ui.png
Diff not rendered.
Binary file removed images/dashboards/dev-tools-ui.png
Diff not rendered.
Binary file removed images/dashboards/discover-app.png
Diff not rendered.
Binary file removed images/dashboards/discover-basics.png
Diff not rendered.
Binary file removed images/dashboards/discover-quickstart.png
Diff not rendered.
Binary file removed images/dashboards/discover-view.png
Diff not rendered.
Binary file removed images/dashboards/dql-search-field.png
Diff not rendered.
Binary file removed images/dashboards/edit-viz.png
Diff not rendered.
Binary file removed images/dashboards/ellipsis-icon.png
Diff not rendered.
Binary file removed images/dashboards/example-dashboard.png
Diff not rendered.
Binary file removed images/dashboards/explorer-S3viz-UI.png
Diff not rendered.
Binary file removed images/dashboards/filter-data-discover.png
Diff not rendered.
Binary file removed images/dashboards/gantt-chart.png
Diff not rendered.
Binary file removed images/dashboards/index-patterns-ui.png
Diff not rendered.
Binary file removed images/dashboards/make_tsvb.gif
Diff not rendered.
Binary file removed images/dashboards/manage-data-source-UI.png
Diff not rendered.
Binary file removed images/dashboards/markdown-1.png
Diff not rendered.
Binary file removed images/dashboards/multidatasources.png
Diff not rendered.
Binary file removed images/dashboards/navigation-pane.png
Diff not rendered.
Binary file removed images/dashboards/new-bar-viz.png
Diff not rendered.
Binary file removed images/dashboards/new-look.png
Diff not rendered.
Binary file removed images/dashboards/observability-logs-UI.png
Diff not rendered.
Binary file removed images/dashboards/opensearch-dashboards-home.png
Diff not rendered.
Binary file removed images/dashboards/query-PPL-explain.png
Diff not rendered.
Binary file removed images/dashboards/query-data-sources-UI-2.png
Diff not rendered.
Binary file removed images/dashboards/query-explain.png
Diff not rendered.
Binary file removed images/dashboards/query-list.png
Diff not rendered.
Binary file removed images/dashboards/query-request-ui.png
Diff not rendered.
Binary file removed images/dashboards/query-workbench-S3.png
Diff not rendered.
Diff not rendered.
Binary file removed images/dashboards/query-workbench-ppl.png
Diff not rendered.
Diff not rendered.
Binary file removed images/dashboards/query-workbench-ui.png
Diff not rendered.
Binary file removed images/dashboards/run-index-query-workbench.png
Diff not rendered.
Binary file removed images/dashboards/sample-data.png
Diff not rendered.
Binary file removed images/dashboards/skipping-index-settings.png
Diff not rendered.
Binary file removed images/dashboards/snapshot-management-UI.png
Diff not rendered.
Binary file removed images/dashboards/time-filter-data-sources.png
Diff not rendered.
Binary file removed images/dashboards/tsvb-viz.png
Diff not rendered.
Binary file removed images/dashboards/tsvb.png
Diff not rendered.
Binary file removed images/dashboards/vega-2.png
Diff not rendered.
Binary file removed images/dashboards/viz-panel-quickstart.png
Diff not rendered.
Binary file removed images/dashboards/viz-type-UI.png
Diff not rendered.
Diff not rendered.
Binary file removed images/discover-analyze.png
Diff not rendered.
Binary file removed images/discover-data-fields.png
Diff not rendered.
Binary file removed images/discover-filter.png
Diff not rendered.
Binary file removed images/discover-save.png
Diff not rendered.
Binary file removed images/discover-search.png
Diff not rendered.
Binary file removed images/discover-setting-up-data.gif
Diff not rendered.
Binary file removed images/discover-visualize-2.png
Diff not rendered.
Binary file removed images/discover-visualize.png
Diff not rendered.
Binary file removed images/edit-filter.png
Diff not rendered.
Binary file removed images/enable-experimental-viz.png
Diff not rendered.
Binary file removed images/feature-contribution-ad.png
Diff not rendered.
Binary file removed images/feature-output-ad.png
Diff not rendered.
Binary file removed images/forecast/no_rcf_calibration.png
Diff not rendered.
Binary file removed images/graphic-bg.png
Diff not rendered.
Binary file removed images/icons/arrow-down-icon.png
Diff not rendered.
Binary file removed images/icons/clock-icon.png
Diff not rendered.
Binary file removed images/icons/play-icon.png
Diff not rendered.
Binary file removed images/icons/question-circle.png
Diff not rendered.
Binary file removed images/icons/save-icon.png
Diff not rendered.
Binary file removed images/icons/theme-icon.png
Diff not rendered.
Binary file removed images/icons/tip-icon.png
Diff not rendered.
Binary file removed images/icons/trash-can-icon.png
Diff not rendered.
Binary file removed images/icons/wrench-icon.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed images/integrations/import-saved-objects.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed images/integrations/nginx-integration.png
Diff not rendered.
Binary file removed images/interact-filter-dashboard.png
Diff not rendered.
Binary file removed images/kibanauser.png
Diff not rendered.
Binary file removed images/last-7--days.png
Diff not rendered.
Binary file removed images/log-dashboard-filter.png
Diff not rendered.
Binary file removed images/make_vega.gif
Diff not rendered.
Binary file removed images/metrics/metricsgif.gif
Diff not rendered.
2 changes: 0 additions & 2 deletions images/migrations/migration-architecture-overview.svg
Diff not rendered.
Binary file removed images/monitors.png
Diff not rendered.
Binary file removed images/multi-data-sources-1.png
Diff not rendered.
Binary file removed images/multi-data-sources-10.png
Diff not rendered.
Binary file removed images/multi-data-sources-11.jpg
Diff not rendered.
Binary file removed images/multi-data-sources-12.jpg
Diff not rendered.
Binary file removed images/multi-data-sources-2.png
Diff not rendered.
Binary file removed images/multi-data-sources-3.5.png
Diff not rendered.
Binary file removed images/multi-data-sources-3.png
Diff not rendered.
Binary file removed images/multi-data-sources-5.png
Diff not rendered.
Binary file removed images/multi-data-sources-6.png
Diff not rendered.
Binary file removed images/multi-data-sources-7.png
Diff not rendered.
Binary file removed images/multi-data-sources-8.png
Diff not rendered.
Binary file removed images/multi-data-sources-9.png
Diff not rendered.
Binary file removed images/neural-search-ingestion.png
Diff not rendered.
Binary file removed images/neural-search-query.png
Diff not rendered.
Binary file removed images/observability.png
Diff not rendered.
Binary file removed images/perftop.png
Diff not rendered.
Binary file removed images/ppl.png
Diff not rendered.
Binary file removed images/procedures.PNG
Diff not rendered.
Binary file removed images/query-workbench-UI.png
Diff not rendered.
Binary file removed images/review_ad.png
Diff not rendered.
Binary file removed images/security.png
Diff not rendered.
Binary file removed images/stack-management-settings.png
Diff not rendered.
Binary file removed images/ta-services.png
Diff not rendered.
Binary file removed images/theme-icon.png
Diff not rendered.
Binary file removed images/ubi/001_screens_side_by_side.png
Diff not rendered.
Binary file removed images/ubi/first_dashboard.png
Diff not rendered.
Binary file removed images/ubi/index_pattern1.png
Diff not rendered.
Binary file removed images/ubi/new_widget.png
Diff not rendered.
Binary file removed images/ubi/query_id.png
Diff not rendered.
Binary file removed images/ubi/ubi.png
Diff not rendered.
Binary file removed images/ubi/visualizations.png
Diff not rendered.
Binary file removed images/ubi/visualizations2.png
Diff not rendered.
Binary file removed images/vega.png
Diff not rendered.
Binary file removed images/visualization-notebook.png
Diff not rendered.
Binary file removed images/visualize-log-data.png
Diff not rendered.
Binary file removed images/workbench.gif
Diff not rendered.
Loading