Update multiple data sources and add TSVB and Vega viz types (opensea…

…rch-project#7229) * Update multiple data sources and add TSVB and Vega viz types Signed-off-by: Melissa Vagi <[email protected]> * add text Signed-off-by: Melissa Vagi <[email protected]> * Add tutorials Signed-off-by: Melissa Vagi <[email protected]> * Add tutorials Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Huy Nguyen <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update tsvb.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update vega.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update vega.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update tsvb.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update vega.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Address SME feedback Signed-off-by: Melissa Vagi <[email protected]> * Address SME feedback Signed-off-by: Melissa Vagi <[email protected]> * Address SME feedback Signed-off-by: Melissa Vagi <[email protected]> * Address SME feedback Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/geojson-regionmaps.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/selfhost-maps-server.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/visbuilder.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/management/multi-data-sources.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/management/multi-data-sources.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/management/multi-data-sources.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/management/multi-data-sources.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/management/multi-data-sources.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/management/multi-data-sources.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/selfhost-maps-server.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/tsvb.md Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _dashboards/visualize/vega.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Huy Nguyen <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sander van de Geijn <[email protected]>
sandervandegeijn · Jul 30, 2024 · 7188618 · 7188618
1 parent 6f47d61
commit 7188618
Show file tree

Hide file tree

Showing 21 changed files with 183 additions and 168 deletions.
diff --git a/_dashboards/visualize/area.md b/_dashboards/visualize/area.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Using area charts
+title: Area charts
 parent: Building data visualizations
 nav_order: 5
 ---

diff --git a/_dashboards/visualize/gantt.md b/_dashboards/visualize/gantt.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Using Gantt charts
+title: Gantt charts
 parent: Building data visualizations
 nav_order: 30
 redirect_from:
@@ -18,7 +18,7 @@ To create a Gantt chart, perform the following steps:
 1. In the visualizations menu, choose **Create visualization** and **Gantt Chart**.
 1. Choose a source for the chart (e.g. some log data).
 1. Under **Metrics**, choose **Event**. For log data, each log is an event.
-1. Select the **Start Time** and **Duration** fields from your data set. The start time is the timestamp for the beginning of an event. The duration is the amount of time to add to the start time.
+1. Select the **Start Time** and **Duration** fields from your dataset. The start time is the timestamp for the beginning of an event. The duration is the amount of time to add to the start time.
 1. Under **Results**, choose the number of events to display on the chart. Gantt charts sequence events from earliest to latest based on start time.
 1. Choose **Panel settings** to adjust axis labels, time format, and colors.
 1. Choose **Update**.

diff --git a/_dashboards/visualize/geojson-regionmaps.md b/_dashboards/visualize/geojson-regionmaps.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Using coordinate and region maps
+title: Coordinate and region maps
 parent: Building data visualizations
 has_children: true
 nav_order: 15
@@ -12,7 +12,7 @@ redirect_from:
 
 OpenSearch has a standard set of GeoJSON files that provide a vector map with each region map. OpenSearch Dashboards also provides basic map tiles with a standard vector map to create region maps. You can configure the base map tiles using [Web Map Service (WMS)](https://www.ogc.org/standards/wms). For more information, see [Configuring WMS in OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/maptiles/). 
 
-For air gapped environments, OpenSearch Dashboards provides a self-host maps server. For more information, see [Using the self-host maps server]({{site.url}}{{site.baseurl}}/dashboards/selfhost-maps-server/)
+For air-gapped environments, OpenSearch Dashboards provides a self-host maps server. For more information, see [Using the self-host maps server]({{site.url}}{{site.baseurl}}/dashboards/selfhost-maps-server/).
 
 While you can't configure a server to support user-defined vector map layers, you can configure your own GeoJSON file and upload it for this purpose. 
 {: .note}
@@ -35,7 +35,7 @@ You can use [geojson.io](https://geojson.io/#map=2/20.0/0.0) to extract GeoJSON
 
 To create your own custom vector map, upload a JSON file that contains GEO data for your customized regional maps. The JSON file contains vector layers for visualization.
 
-1. Prepare a JSON file to upload. Make sure the file has either a .geojson or .json extension.
+1. Prepare a JSON file to upload. Make sure the file has either a `.geojson` or `.json` extension.
 1. On the top menu bar, go to **OpenSearch Dashboards > Visualize**.
 1. Select the **Create Visualization** button.
 1. Select **Region Map**.

diff --git a/_dashboards/visualize/maps-stats-api.md b/_dashboards/visualize/maps-stats-api.md
@@ -3,7 +3,7 @@ layout: default
 title: Maps Stats API
 nav_order: 20
 grand_parent: Building data visualizations
-parent: Using coordinate and region maps 
+parent: Coordinate and region maps 
 has_children: false
 ---
 

diff --git a/_dashboards/visualize/maps.md b/_dashboards/visualize/maps.md
@@ -2,7 +2,7 @@
 layout: default
 title: Using maps 
 grand_parent: Building data visualizations
-parent: Using coordinate and region maps
+parent: Coordinate and region maps
 nav_order: 10
 redirect_from:
   - /dashboards/maps-plugin/

diff --git a/_dashboards/visualize/maptiles.md b/_dashboards/visualize/maptiles.md
@@ -2,7 +2,7 @@
 layout: default
 title: Configuring a Web Map Service (WMS)
 grand_parent: Building data visualizations
-parent: Using coordinate and region maps
+parent: Coordinate and region maps
 nav_order: 30
 redirect_from:
   - /dashboards/maptiles/

diff --git a/_dashboards/visualize/selfhost-maps-server.md b/_dashboards/visualize/selfhost-maps-server.md
@@ -1,14 +1,14 @@
 ---
 layout: default
-title: Using the self-host maps server
+title: Using self-hosted map servers
 grand_parent: Building data visualizations
-parent: Using coordinate and region maps
+parent: Coordinate and region maps
 nav_order: 40
 redirect_from:
   - /dashboards/selfhost-maps-server/
 ---
 
-# Using the self-host maps server
+# Using self-hosted map servers
 
 The self-host maps server for OpenSearch Dashboards allows users to access the default maps service in air-gapped environments. OpenSearch-compatible map URLs include a map manifest with map tiles and vectors, the map tiles, and the map vectors.
 

diff --git a/_dashboards/visualize/tsvb.md b/_dashboards/visualize/tsvb.md
@@ -0,0 +1,70 @@
+---
+layout: default
+title: TSVB
+parent: Building data visualizations
+nav_order: 45
+---
+
+# TSVB
+
+The Time-Series Visual Builder (TSVB) is a powerful data visualization tool in OpenSearch Dashboards that allows you to create detailed time-series visualizations. One of its key features is the ability to add annotations or markers at specific time points based on index data. This feature is particularly useful for making connections between multiple indexes and building visualizations that display data over time, such as flight status, delays by type, and more. TSVB currently supports the following visualization types: Area, Line, Metric, Gauge, Markdown, and Data Table.
+
+## Creating TSVB visualizations from multiple data sources
+Introduced 2.14
+{: .label .label-purple }
+
+Before proceeding, ensure that the following configuration settings are enabled in the `config/opensearch_dasboards.yaml` file:
+
+```yaml
+data_source.enabled: true
+vis_type_timeseries.enabled: true
+```
+{% include copy-curl.html %}
+
+Once you have configured [multiple data sources]({{site.url}}{{site.baseurl}}/dashboards/management/multi-data-sources/) in OpenSearch Dashboards, you can use Vega to query those data sources. The following GIF shows the process of creating TSVB visualizations in OpenSearch Dashboards.
+
+![Process of creating TSVB visualizations in OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/images/dashboards/configure-tsvb.gif)
+
+**Step 1: Set up and connect data sources**
+
+Open OpenSearch Dashboards and follow these steps:
+
+1. Select **Dashboards Management** from the main menu on the left.
+2. Select **Data sources** and then select the **Create data source** button.
+3. On the **Create data source** page, enter the connection details and endpoint URL.
+4. On the **Home** page, select **Add sample data** and then select the **Add data** button for the **Sample web logs** dataset.
+
+The following GIF shows the steps required to set up and connect a data source.
+
+![Create data source]({{site.url}}{{site.baseurl}}/images/dashboards/create-datasource.gif)
+
+**Step 2: Create the visualization**
+
+Follow these steps to create the visualization:
+
+1. From the menu on the left, select **Visualize**.
+2. On the **Visualizations** page, select **Create Visualization** and then select **TSVB** in the pop-up window.
+
+**Step 3: Specify data sources**
+
+After creating a TSVB visualization, data may appear based on your default index pattern. To change the index pattern or configure additional settings, follow these steps:
+
+1. In the **Create** window, select **Panel options**.
+2. Under **Data source**, select the OpenSearch cluster from which to pull data. In this case, choose your newly created data source.
+3. Under **Index name**, enter `opensearch_dashboards_sample_data_logs`.
+4. Under **Time field**, select `@timestamp`. This setting specifies the time range for rendering the visualization.
+
+**(Optional) Step 4: Add annotations**
+
+Annotations are markers that can be added to time-series visualizations. Follow these steps to add annotations:
+
+1. On the upper-left corner of the page, select **Time Series**.
+2. Select the **Annotations** tab and then **Add data source**.
+3. In the **Index** name field, specify the appropriate index. In this case, continue using the same index from the previous steps, that is, `opensearch_dashboards_sample_data_logs`.
+4. From **Time** field, select `@timestamp`.
+5. In the **Fields** field, enter `timestamp`.
+6. In the **Row template** field, enter `timestamp`.
+
+The visualization automatically updates to display your annotations, as shown in the following image.
+
+  <img src="{{site.url}}{{site.baseurl}}/images/dashboards/tsvb-with-annotations.png" alt="TSVB visualization with annotations" width="700"/>