Skip to content
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

Add documentation for Dev Tools multple data source integration feature #3653

Merged
merged 110 commits into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
110 commits
Select commit Hold shift + click to select a range
1916452
Create new doc site section Dev Tools
vagimeli Apr 3, 2023
ecbd7af
Content planning
vagimeli Apr 3, 2023
ad91a9f
Content planning
vagimeli Apr 3, 2023
52819ad
Content planning
vagimeli Apr 3, 2023
4a1ab2e
Content planning
vagimeli Apr 3, 2023
2abdada
Content planning
vagimeli Apr 4, 2023
2856699
Content planning
vagimeli Apr 4, 2023
2cef527
Content planning
vagimeli Apr 5, 2023
d66a6e6
Content planning
vagimeli Apr 5, 2023
432fbd4
Content planning
vagimeli Apr 5, 2023
8898aeb
Content planning
vagimeli Apr 5, 2023
979c54b
Content planning
vagimeli Apr 5, 2023
a53d24d
Content planning
vagimeli Apr 5, 2023
8d9ab13
Content planning
vagimeli Apr 5, 2023
74a2726
Address SME feedback
vagimeli Apr 7, 2023
a98019b
Copy edit
vagimeli Apr 7, 2023
2b1be2c
Copy edit
vagimeli Apr 7, 2023
3bd76ac
Copy edit
vagimeli Apr 7, 2023
6c6c241
Address doc review feedback
vagimeli Apr 10, 2023
aea4c0a
Update _dashboards/dev-tools/index-dev.md
vagimeli Apr 25, 2023
25270bc
Update _dashboards/dev-tools/index-dev.md
vagimeli Apr 25, 2023
fcdf518
Update _dashboards/discover/multi-data-sources.md
vagimeli Apr 25, 2023
d296e6c
Update _dashboards/discover/multi-data-sources.md
vagimeli Apr 25, 2023
5e641ba
Update _dashboards/discover/multi-data-sources.md
vagimeli Apr 25, 2023
9cb69a6
Update _dashboards/discover/multi-data-sources.md
vagimeli Apr 25, 2023
59f4855
Delete run-queries.md
vagimeli Apr 25, 2023
1f1f2ad
Address editorial review
vagimeli Apr 25, 2023
0fcdfcc
Revert "Delete run-queries.md"
vagimeli Apr 25, 2023
17e845b
address editorial review
vagimeli Apr 25, 2023
9f89505
Add Mutate event processor doc. (#3234)
carolxob Apr 3, 2023
0cebc2d
Add CI with link checker. (#3584)
dblock Apr 4, 2023
dd4b0e8
Adding documentation for behavior of indices.recovery.max_bytes_per_s…
AmiStrn Apr 4, 2023
481883f
Refactor k-NN filter search (#3613)
kolchfa-aws Apr 5, 2023
64a0ab5
Add Security information to Security Analytics documentation (#3184)
cwillum Apr 5, 2023
ecd5563
Add path to the script for the securityadmin.sh troubleshooting topic…
cwillum Apr 5, 2023
c0b33fd
Link checker update: fail on PRs and run for all branches (#3690)
kolchfa-aws Apr 6, 2023
9e8256c
Specify versions in the link checker (#3696)
kolchfa-aws Apr 6, 2023
b7bd601
Add Parse JSON processor doc. (#3237)
carolxob Apr 6, 2023
2f38e51
Update MAINTAINERS.md (#3641)
Naarcha-AWS Apr 6, 2023
cc3cb0c
Update CODEOWNERS to reflect team (#3639)
Naarcha-AWS Apr 6, 2023
c8b3da3
Fixing brand and trademark links (#3647)
dtaivpp Apr 6, 2023
6afe235
Remove dynamic templates from a mapping example (#3698)
kolchfa-aws Apr 8, 2023
8bf381b
Updates Trace Analytics overview (#3727)
natebower Apr 10, 2023
522d98c
Remove the list of branches for link checker (#3731)
kolchfa-aws Apr 10, 2023
2d74967
Fix put rollup job api documentation (#3637)
tanqiuliu Apr 10, 2023
7513270
Add documentation for Searchable Snapshots GA release (#3462)
ariamarble Apr 11, 2023
81ef3d1
Add Trace peer forwarder doc. (#3238)
carolxob Apr 11, 2023
172b472
Update java client version (#3753)
VachaShah Apr 11, 2023
cf9e0c6
Add config parameters for traced models (#3456)
Naarcha-AWS Apr 12, 2023
5388131
Modify link checker to run once a week and not to run in forks (#3759)
kolchfa-aws Apr 12, 2023
8dac80f
Add auto-truncation to pretrained models (#3756)
Naarcha-AWS Apr 13, 2023
5bd95aa
Use the modified dates of files in the sitemap (#3774)
AMoo-Miki Apr 14, 2023
1b7f6eb
Add additonal Snapshot Restore (#3783)
Naarcha-AWS Apr 14, 2023
d5358ce
Add maximum allowed monitor number. (#3732)
carolxob Apr 17, 2023
681755d
Update link-checker.yml (#3787)
kolchfa-aws Apr 18, 2023
0d17e7d
Add documentation for segment replication GA release (#3461)
ariamarble Apr 18, 2023
3c2b47b
Add filtering data in maps doc. (#3640)
carolxob Apr 18, 2023
85a5aa6
Add documentation for wait_for_completion API (#3458)
ariamarble Apr 20, 2023
9597769
Add Anomaly detector plugin doc. (#3569)
carolxob Apr 20, 2023
030c149
Add E2E acknowledgements (#3811)
Naarcha-AWS Apr 20, 2023
725c2ed
Add opensearch sink security (#3809)
lizsnyder Apr 20, 2023
02c8c15
Add list to map processor (#3806)
Naarcha-AWS Apr 20, 2023
3f61319
Add documentation for IM UI index templates (#3459)
ariamarble Apr 20, 2023
f5ba385
Update Maintainer.md to match CODEOWNER (#3831)
ananzh Apr 20, 2023
c490b20
Add documentation for dynamic configuration of tenancy in Dashboards …
cwillum Apr 21, 2023
3ddc267
Content updates for segrep - benchmarking and recommended settings (#…
ariamarble Apr 21, 2023
124901e
Update baseline maintainer and CODEOWNER format (#3832)
ananzh Apr 24, 2023
52355fb
Add editorial to maintainers and codeowners (#3840)
Naarcha-AWS Apr 24, 2023
10f1b59
Add new settings for SAML and OIDC that allow for cookie splitting (#…
cwillum Apr 24, 2023
3456545
Add Event Analytics visualizations in Dashboards feature (#3752)
vagimeli Apr 24, 2023
2bfb411
Revert "Delete run-queries.md"
vagimeli Apr 25, 2023
d6193d5
Revert "Add Event Analytics visualizations in Dashboards feature (#37…
vagimeli Apr 25, 2023
b347de2
Revert "Add new settings for SAML and OIDC that allow for cookie spli…
vagimeli Apr 25, 2023
9a5e44e
Revert "Add Mutate event processor doc. (#3234)"
vagimeli Apr 25, 2023
b7f0773
Revert "Add CI with link checker. (#3584)"
vagimeli Apr 25, 2023
f32fa23
Revert "Add editorial to maintainers and codeowners (#3840)"
vagimeli Apr 25, 2023
5de357c
Revert "Update baseline maintainer and CODEOWNER format (#3832)"
vagimeli Apr 25, 2023
05880e6
Revert "Content updates for segrep - benchmarking and recommended set…
vagimeli Apr 25, 2023
cd9d0de
Revert "Add documentation for IM UI index templates (#3459)"
vagimeli Apr 25, 2023
89ce678
Revert "Add list to map processor (#3806)"
vagimeli Apr 25, 2023
09b9909
Revert "Add opensearch sink security (#3809)"
vagimeli Apr 25, 2023
9d584bf
Revert "Add E2E acknowledgements (#3811)"
vagimeli Apr 25, 2023
d002dcc
Revert "Add Anomaly detector plugin doc. (#3569)"
vagimeli Apr 25, 2023
905a388
Revert "Adding documentation for behavior of indices.recovery.max_byt…
vagimeli Apr 25, 2023
5cda322
Revert "Refactor k-NN filter search (#3613)"
vagimeli Apr 25, 2023
3ad997f
Revert "Add Security information to Security Analytics documentation …
vagimeli Apr 25, 2023
619b3b3
Revert "Add path to the script for the securityadmin.sh troubleshooti…
vagimeli Apr 25, 2023
16a9688
Revert "Add Parse JSON processor doc. (#3237)"
vagimeli Apr 25, 2023
ae160c0
Revert commit
vagimeli Apr 25, 2023
e00f73c
Revert "Update CODEOWNERS to reflect team (#3639)"
vagimeli Apr 25, 2023
8515c5e
Revert "Fixing brand and trademark links (#3647)"
vagimeli Apr 25, 2023
b9bef2f
Revert "Remove dynamic templates from a mapping example (#3698)"
vagimeli Apr 25, 2023
2a26593
Revert "Fix put rollup job api documentation (#3637)"
vagimeli Apr 25, 2023
81d6819
Revert "Add documentation for Searchable Snapshots GA release (#3462)"
vagimeli Apr 25, 2023
100aebc
Revert "Updates Trace Analytics overview (#3727)"
vagimeli Apr 25, 2023
06806c8
Revert "Add auto-truncation to pretrained models (#3756)"
vagimeli Apr 25, 2023
370eec9
Revert "Use the modified dates of files in the sitemap (#3774)"
vagimeli Apr 25, 2023
e974146
Revert "Add editorial to maintainers and codeowners (#3840)"
vagimeli Apr 25, 2023
6b7dc02
Revert "Add list to map processor (#3806)"
vagimeli Apr 25, 2023
f12309c
Revert "Add maximum allowed monitor number. (#3732)"
vagimeli Apr 25, 2023
66f90a8
Revert "Update java client version (#3753)"
vagimeli Apr 25, 2023
c896b2c
Revert "Add Trace peer forwarder doc. (#3238)"
vagimeli Apr 25, 2023
08230dc
Revert "Add filtering data in maps doc. (#3640)"
vagimeli Apr 25, 2023
cb8f206
Revert "Add documentation for wait_for_completion API (#3458)"
vagimeli Apr 25, 2023
7f929dd
Revert "Add config parameters for traced models (#3456)"
vagimeli Apr 25, 2023
92a5da4
Revert "Add additonal Snapshot Restore (#3783)"
vagimeli Apr 25, 2023
1a46c3b
Revert "Add documentation for dynamic configuration of tenancy in Das…
vagimeli Apr 25, 2023
7c0e8f4
Revert "Add documentation for segment replication GA release (#3461)"
vagimeli Apr 25, 2023
3f2cfe0
Merge branch 'main' into issue-3452
vagimeli Apr 25, 2023
d5a2ef8
Resolve merge conflicts
vagimeli Apr 25, 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
14 changes: 14 additions & 0 deletions _dashboards/dev-tools/index-dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: default
title: Dev Tools
nav_order: 100
has_children: true
---

# Dev Tools

**Dev Tools** allows you to set up your OpenSearch Dashboards environment, identify and fix bugs, and customize your dashboards' appearance and behavior.

To access the Dev Tools console, select **Dev Tools** in the menu on the OpenSearch Dashboards home page. You'll see an interface like the one shown in the following image.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dev-tools-console.png" alt="Dev Tools interface from home page">
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
layout: default
title: Running queries in the console
nav_order: 110
title: Running queries in the Dev Tools console
parent: Dev Tools
nav_order: 10
redirect_from:
- /dashboards/run-queries/
---

# Running queries in the console
# Running queries in the Dev Tools console

You can use the OpenSearch Dev Tools Console to send queries to OpenSearch.

Expand Down
35 changes: 31 additions & 4 deletions _dashboards/discover/multi-data-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@
layout: default
title: Adding multiple data sources
parent: Exploring data
nav_order: 5
nav_order: 20
---

# Adding multiple data sources

The multiple data sources feature is an experimental feature released in OpenSearch 2.4. It can't be used in a production environment. For updates on the feature’s progress or to leave feedback on improving the feature, see the [OpenSearch Forum discussion](https://forum.opensearch.org/t/feedback-experimental-feature-connect-to-external-data-sources/11144).
{: .warning }

You can add multiple data sources to a single dashboard. OpenSearch Dashboards allows you to dynamically manage data sources, create index patterns based on those data sources, and execute queries against a specific data source and then combine visualizations in one dashboard.
OpenSearch Dashboards allows you to dynamically manage data sources, create index patterns based on those data sources, run queries against a specific data source, and combine visualizations in one dashboard.

In this tutorial we provide the steps for enabling the `data_source` setting in Dashboards; adding credentials, data source connections, and index patterns; and combining visualizations in a single dashboard.

## Try it: Exploring the multiple data sources feature in your local environment
## Enabling the multiple data sources feature

This tutorial uses a preconfigured data source and index pattern, and you aren’t required to configure settings. However, you’ll need to enable the `data_source` setting in the configuration file before before getting started with exploring this feature.
{: .note }

The multiple data sources feature is experimental and can't be deployed into production. You can try it out with a sample data source and a sample index pattern. Before getting started, you must first edit the YAML configuration. The following section provides the steps for enabling the feature.

## Modifying the multiple data sources settings
## Modifying the YAML file settings for multiple data sources

Dashboards is configured in the cluster settings, and the multiple data sources feature is disabled by default. To enable it, you need to edit the configuration in `opensearch_dashboards.yml` and then restart the cluster.

Expand Down Expand Up @@ -132,6 +132,33 @@ The following image shows a date histogram with an interval dropdown list.

<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-11.jpg" alt="Histogram user interface">

## Selecting multiple data sources in the Dev Tools console

Selecting multiple data sources in the Dev Tools console allows you to work with a broader range of data and gain deeper insights into your code and applications. You can follow these steps:

1. Open `opensearch_dashboards.yml` in the editor of your choice.
2. Set `data_source.enabled:` to `true`, as shown in the following example:

```
# Set the value of this setting to true to enable the experimental multiple data source
# support feature. Use with caution.
data_source.enabled: true
```

3. Connect to OpenSearch Dashboards and select **Dev Tools** in the menu.
5. Enter the following query in the editor pane of the **Console** and then select the play button:

```json
GET /_cat/indices
```

6. From the **DataSource** dropdown menu, select a data source and then query the source.
7. Repeat the preceding steps for each data source you want to select.

For an overview of this process, watch the following 15-second video.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/multidata-dev-tools.gif" alt="Multiple data sources in Dev Tools demo">{: .img-fluid}

## Creating data visualizations for a dashboard

Follow these steps to learn how to create data visualizations for a dashboard:
Expand Down
Binary file added images/dashboards/dev-tools-console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/multidata-dev-tools.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.