mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-03-03 06:29:26 +00:00
[DOC] Fix dashboards management navigation changes and make copy edits to c… (#4658)
* Fix dashboards management navigation changes and make copy edits to content --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
This commit is contained in:
parent
7e0c6c4e04
commit
465c8af217
@ -7,8 +7,14 @@ has_children: true
|
||||
|
||||
# Dev Tools
|
||||
|
||||
Use **Dev Tools** to set up your OpenSearch Dashboards environment, identify and fix bugs, and customize dashboards' appearance and behavior.
|
||||
Interact directly with OpenSearch by using **Dev Tools** to set up your OpenSearch Dashboards environment, run queries, explore data, and debug problems. To access the Dev Tools console, select **Dev Tools** from the **Management** menu on the OpenSearch Dashboards home page. The following are examples of how you can use the Dev Tools console in OpenSearch Dashboards:
|
||||
|
||||
To access the Dev Tools console, select **Dev Tools** under the **Management** menu on the OpenSearch Dashboards home page. You'll see an interface like the one shown in the following image.
|
||||
- Set up your OpenSearch Dashboards environment. For example, you can use the console to configure authentication settings for your OpenSearch Dashboards instance.
|
||||
- [Run queries to explore your data]({{site.url}}{{site.baseurl}}/dashboards/dev-tools/run-queries/). For example, you can use the console to run a query to find all the documents in your index that contain a specific word.
|
||||
- Debug problems with your queries. For example, if your query is not returning the results you expect, you can use the console to look for error messages and identify the problem.
|
||||
- Learn about the APIs in OpenSearch. For example, you can use the API reference documentation linked in the console (select the question circle icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/question-circle.png" class="inline-icon" alt="question circle icon"/>{:/})) to look up the syntax for different API calls.
|
||||
- Develop custom visualizations. For example, you can use the console to create Vega visualizations.
|
||||
- Customize the appearance and behavior of dashboards. For example, you can use the console to customize dashboard visualization colors or to add new filters.
|
||||
- Identify and fix bugs. For example, you can use the console to view logs and identify the cause of the problem.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dev-tools-console.png)" alt="Dev Tools interface">
|
||||
The Dev Tools console is a valuable resource for developers, analysts, and anyone else who works with OpenSearch data.
|
||||
|
@ -23,7 +23,7 @@ To enable multiple data sources:
|
||||
4. Restart the Dashboards container.
|
||||
5. Verify that the configuration settings were created and configured properly by connecting to Dashboards and viewing the **Dashboards Management** console. **Data Sources** appears in the sidebar, as shown in the following image.
|
||||
|
||||

|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dashboards-mgmt.png" alt="Data sources sidebar on the Dashboards Management interface" width="40%">
|
||||
|
||||
## Creating a data source connection
|
||||
|
||||
@ -32,23 +32,21 @@ A data source connection specifies the parameters needed to connect to a data so
|
||||
To create a new data source connection:
|
||||
|
||||
1. Go to [`http://localhost:5601`](http://localhost:5601/) and log in with the username `admin` and password `admin`. If you’re running the Security plugin, go to [`https://localhost:5601`](https://localhost:5601/).
|
||||
2. From the OpenSearch Dashboards main menu, select **Dashboards Management** > **Data Sources** > **Create data source connection**.
|
||||
3. Add information to each field to configure **Connection Details** > **Endpoint URL** > **Authentication Method**.
|
||||
2. From the OpenSearch Dashboards main menu, select **Dashboards Management** > **Data sources** > **Create data source connection**.
|
||||
3. Add information to each field to configure **Connection Details** and **Authentication Method**.
|
||||
|
||||
In the **Connection Details** window, enter a title. Entering a description is optional.
|
||||
Under **Connection Details**, enter a title and endpoint URL. For this tutorial, use the URL `http://localhost:5601/app/management/opensearch-dashboards/dataSources`. Entering a description is optional.
|
||||
|
||||
In the **Endpoint** window, enter the **Endpoint URL**. For this tutorial, use the URL `http://localhost:5601/app/management/opensearch-dashboards/dataSources`.
|
||||
|
||||
In the **Authentication** window, select an **Authentication Method**. The applicable fields for the selected method appear. You can then enter the required details. The authentication method options include:
|
||||
Under **Authentication Method**, select an authentication method from the dropdown list. Once an authentication method is selected, the applicable fields for that method appear. You can then enter the required details. The authentication method options are:
|
||||
- **No authentication**: No authentication is used to connect to the data source.
|
||||
- **Username & Password**: A basic username and password are used to connect to the data source.
|
||||
- **AWS SigV4**: An AWS Signature Version 4 (SigV4) authenticating request is used to connect to the data source. AWS SigV4 requires an access key and a secret key.
|
||||
- **AWS SigV4**: An AWS Signature Version 4 authenticating request is used to connect to the data source. AWS Signature Version 4 requires an access key and a secret key.
|
||||
|
||||
For SigV4 authentication, first specify the **Region**. Next, select the OpenSearch service in the **Service Name** list. The options are **Amazon OpenSearch Service** and **Amazon OpenSearch Serverless**. Last, enter the **Access Key** and **Secret Key** for authorization. For an example setup, see the following image.
|
||||
For AWS Signature Version 4 authentication, first specify the **Region**. Next, select the OpenSearch service in the **Service Name** list. The options are **Amazon OpenSearch Service** and **Amazon OpenSearch Serverless**. Last, enter the **Access Key** and **Secret Key** for authorization. For an example setup, see the following image.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/SigV4-setup.png" alt="SigV4 auth type setup" width="40%">
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/SigV4-setup.png" alt="AWS Signature Version 4 auth type setup" width="40%">
|
||||
|
||||
For information about available AWS Regions for AWS accounts, see [Available Regions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions). For more information about SigV4 authentication requests, see [Authenticating Requests (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
|
||||
For information about available AWS Regions for AWS accounts, see [Available Regions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions). For more information about AWS Signature Version 4 authentication requests, see [Authenticating Requests (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
|
||||
{: .note }
|
||||
|
||||
After you have entered the appropriate details in all of the required fields, the **Test connection** and **Create data source** buttons become active. You can select **Test connection** to confirm that the connection is valid.
|
||||
@ -94,9 +92,7 @@ To set the time filter:
|
||||
2. Select the calendar icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/calendar-icon.png" class="inline-icon" alt="calendar icon"/>{:/}) to change the time field. The default time period is **Last 15 minutes**.
|
||||
3. Change the time field to a particular time period, for example, **Last 7 days**, and then select **Refresh**.
|
||||
4. Change start or end times by selecting the start or end time in the search bar.
|
||||
5. In the pop-up window, choose **Absolute**, **Relative**, or **Now** and then specify the date, for example, as shown in the following image.
|
||||
|
||||

|
||||
5. In the pop-up window, choose **Absolute**, **Relative**, or **Now** and then specify the date.
|
||||
|
||||
### Selecting a time range from the histogram
|
||||
|
||||
@ -148,7 +144,7 @@ Your dashboard might look like the one in the following image.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-12.jpg" width=700 alt="Example dashboard using data visualizations from many data sources">
|
||||
|
||||
## Understanding feature limitations
|
||||
## Limitations
|
||||
|
||||
This feature has the following limitations:
|
||||
|
||||
|
@ -16,7 +16,7 @@ The default time range is **Last 15 minutes**. You can change the time range at
|
||||
|
||||
To change the time range at the dashboard level, perform the following steps:
|
||||
|
||||
1. From an OpenSearch Dashboards application (Discover, Dashboard, or Visualize), select the time clock or calendar icon.
|
||||
1. From an OpenSearch Dashboards application (Discover, Dashboards, or Visualize), select the calendar icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/calendar-icon.png" class="inline-icon" alt="calendar icon"/>{:/}) on the right of the search bar.
|
||||
2. Select one of the time filter options, as shown in the following image:
|
||||
- **Quick select:** Choose a time based on the last or next number of seconds, minutes, hours, days, or another time unit.
|
||||
- **Commonly used:** Choose a common time range like **Today**, **Last 7 days**, or **Last 30 days**.
|
||||
|
@ -16,7 +16,7 @@ The Index Management interface in OpenSearch Dashboards provides a unified solut
|
||||
## Get started with index management using Dashboards
|
||||
|
||||
**Step 1: Open Index Management**
|
||||
Once you're in OpenSearch Dashboards, select **Index Management** under the Management main menu. Then select **Indices**.
|
||||
Once you're in OpenSearch Dashboards, select **Index Management** from the **OpenSearch Plugins** main menu. Then select **Indices**.
|
||||
|
||||
**Step 2: View indexes**
|
||||
In the Indices interface you will see a list of existing indexes in your OpenSearch cluster. The list provides information such as index name, health state, document count, index size, and other relevant details.
|
||||
|
@ -20,7 +20,7 @@ In the **Notification settings** interface, you can configure the default notifi
|
||||
- Clone
|
||||
- Force merge
|
||||
|
||||
To get started, under the OpenSearch Dashboards main menu, select **Management** > **Index Management**. Under **Index Management**, select **Notification settings**.
|
||||
To get started, from the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Index Management**. Under **Index Management**, select **Notification settings**.
|
||||
|
||||
You can choose to be notified when the operation has completed or failed. Additionally, you can select the notification channels for this notification, as shown in the following image.
|
||||
|
||||
@ -33,7 +33,7 @@ If you don't have permission to view notification settings, you cannot view the
|
||||
|
||||
You can view default notification settings when you perform an indexing operation as well as set up additional notifications. For example, if you want to configure an additional notification for a reindex operation, perform the following steps:
|
||||
|
||||
1. Select **Management** > **Index Management**.
|
||||
1. Select **OpenSearch Plugins** > **Index Management**.
|
||||
|
||||
1. In the **Index Management** interface, select **Indices**.
|
||||
|
||||
|
@ -24,7 +24,7 @@ Snapshots have two main uses:
|
||||
|
||||
Before you create an SM policy, set up a repository for snapshots.
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
|
||||
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
|
||||
1. In the left panel, under **Snapshot Management**, select **Repositories**.
|
||||
1. Choose the **Create Repository** button.
|
||||
1. Enter the repository name, type, and location.
|
||||
@ -51,7 +51,7 @@ To delete a snapshot repository configuration, select the repository from the **
|
||||
|
||||
Create an SM policy to set up automatic snapshots. An SM policy defines an automated snapshot creation schedule and an optional automated deletion schedule.
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
|
||||
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
|
||||
1. In the left panel, under **Snapshot Management**, select **Snapshot Policies**.
|
||||
1. Select the **Create Policy** button.
|
||||
1. In the **Policy settings** section:
|
||||
@ -77,7 +77,7 @@ Create an SM policy to set up automatic snapshots. An SM policy defines an autom
|
||||
|
||||
You can view, edit, or delete an SM policy on the policy details page.
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
|
||||
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
|
||||
1. In the left panel, under **Snapshot Management**, select **Snapshot Policies**.
|
||||
1. Click on the **Policy name** of the policy you want to view, edit, or delete. <br>
|
||||
The policy settings, snapshot schedule, snapshot retention period, notifications, and last creation and deletion are displayed in the policy details page. <br> If a snapshot creation or deletion fails, you can view information about the failure in the **Last Creation/Deletion** section. To view the failure message, click on the **cause** in the **Info** column.
|
||||
@ -85,14 +85,14 @@ The policy settings, snapshot schedule, snapshot retention period, notifications
|
||||
|
||||
## Enable, disable, or delete SM policies
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
|
||||
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
|
||||
1. In the left panel, under **Snapshot Management**, select **Snapshot Policies**.
|
||||
1. Select one or more policies in the list.
|
||||
1. To enable or disable selected SM policies, select the **Enable** or **Disable** button. To delete selected SM policies, in the **Actions** list, select the **Delete** option.
|
||||
|
||||
## View snapshots
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
|
||||
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
|
||||
1. In the left panel, under **Snapshot Management**, select **Snapshots**.
|
||||
All automatically or manually taken snapshots appear in the list.
|
||||
1. To view a snapshot, click on its **Name**.
|
||||
@ -101,7 +101,7 @@ All automatically or manually taken snapshots appear in the list.
|
||||
|
||||
Follow these steps to take a snapshot manually:
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
|
||||
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
|
||||
1. In the left panel, under **Snapshot Management**, select **Snapshots**.
|
||||
1. Select the **Take snapshot** button.
|
||||
1. Enter the snapshot name.
|
||||
@ -122,7 +122,7 @@ The **Delete** button [deletes]({{site.url}}{{site.baseurl}}/api-reference/snaps
|
||||
|
||||
## Restoring a snapshot
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
|
||||
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
|
||||
1. In the left panel, under **Snapshot Management**, select **Snapshots**. The **Snapshots** tab is selected by default.
|
||||
1. Select the checkbox next to the snapshot you want to restore, as shown in the following image:
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/restore-snapshot/restore-snapshot-main.png" alt="Snapshots">{: .img-fluid}
|
||||
|
BIN
images/dashboards/dashboards-mgmt.png
Normal file
BIN
images/dashboards/dashboards-mgmt.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 100 KiB |
BIN
images/icons/question-circle.png
Normal file
BIN
images/icons/question-circle.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.5 KiB |
Loading…
x
Reference in New Issue
Block a user