Skip to content

Commit

Permalink
Merge branch 'main' into agent_tools
Browse files Browse the repository at this point in the history
  • Loading branch information
kolchfa-aws authored Jun 20, 2024
2 parents e82d658 + 737e227 commit 5001ec2
Show file tree
Hide file tree
Showing 46 changed files with 2,387 additions and 246 deletions.
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ assignees: ''
- [ ] Report a technical problem with the documentation
- [ ] Other

**Tell us about your request.** Provide a summary of the request and all versions that are affected.

**Tell us about your request.** Provide a summary of the request.

***Version:** List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.

**What other resources are available?** Provide links to related issues, POCs, steps for testing, etc.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Follow these steps to set up your local copy of the repository:

```
curl -sSL https://get.rvm.io | bash -s stable
rvm install 3.2
rvm install 3.2.4
ruby -v
```

Expand Down
25 changes: 4 additions & 21 deletions _dashboards/visualize/visbuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ redirect_from:

# Using VisBuilder

VisBuilder is an experimental feature and shouldn't be used in a production environment. For updates on its progress, or if you want to leave feedback that helps improve the feature, see the [GitHub issue](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2280).
{: .warning}

You can use the VisBuilder visualization type in OpenSearch Dashboards to create data visualizations by using a drag-and-drop gesture. With VisBuilder you have:

* An immediate view of your data without the need to preselect the visualization output.
Expand All @@ -22,36 +19,22 @@ You can use the VisBuilder visualization type in OpenSearch Dashboards to create

## Try VisBuilder in the OpenSearch Dashboards playground

If you'd like to try out VisBuilder without installing OpenSearch locally, you can do so in the [Dashboards playground](https://playground.opensearch.org/app/vis-builder#/). VisBuilder is enabled by default.
If you'd like to try out VisBuilder without installing OpenSearch locally, you can do so in the [Dashboards playground](https://playground.opensearch.org/app/vis-builder#/).

## Try VisBuilder locally

VisBuilder is enabled by default. If you want to disable it, set the feature `flag vis_builder.enabled:` to `false` in the `opensearch_dashboards.yml` file as follows:

```
# Set the value of this setting to false to disable VisBuilder
# functionality in Visualization.
vis_builder.enabled: false
```

Follow these steps to create a new visualization using VisBuilder in your environment:

1. Open Dashboards:
- If you're not running the Security plugin, go to http://localhost:5601.
- If you're running the Security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).

2. Confirm that the **Enable experimental visualizations** option is turned on.
- From the top menu, select **Management** > **Dashboards Management** > **Advanced Settings**.
- Select **Visualization** and verify that the option is turned on.

<img src="{{site.url}}{{site.baseurl}}/images/enable-experimental-viz.png" alt="Enable experimental visualizations" width="600">

3. From the top menu, select **Visualize** **>** **Create visualization** **>** **VisBuilder**.
1. From the top menu, select **Visualize > Create visualization > VisBuilder**.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/vis-builder-1.png" alt="Select the VisBuilder visualization type" width="550">

4. Drag and drop field names from the left column into the **Configuration** panel to generate a visualization.
1. Drag and drop field names from the left column into the **Configuration** panel to generate a visualization.

Here’s an example visualization. Your visualization will look different depending on your data and the fields you select.

<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-generated-viz.png" alt="Visualization generated using sample data">
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/drag-drop-generated-viz.png" alt="Visualization generated using sample data">
Loading

0 comments on commit 5001ec2

Please sign in to comment.