[DOC] Create Dashboard list extensions documentation (#3443)
* Add documentation for Dashboard plugin list extension feature --------- Signed-off-by: vagimeli <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
This commit is contained in:
Melissa Vagi
GitHub
parent
546491c4bd
commit
93ef1c5a0d
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
layout: default
|
||||
title: Integrating plugins into a dashboard
|
||||
parent: Observability
|
||||
nav_order: 5
|
||||
---
|
||||
|
||||
# Integrating plugins into a dashboard
|
||||
|
||||
Observability is a collection of plugins and applications that let you visualize data-driven events by using [Piped Processing Language]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index/) to explore, discover, and query data stored in OpenSearch. Observability provides a unified experience for collecting and monitoring metrics, logs, and traces from common data sources. With data collection and monitoring in one place, you have full-stack, end-to-end observability of your entire infrastructure.
|
||||
|
||||
As of OpenSearch 2.7, you can manage your observability plugins with **Observability Dashboards** or **Dashboard** instead of the plugins page. This feature provides you:
|
||||
|
||||
- **Instant access to installed plugins:** The dashboard displays all installed plugins in one place.
|
||||
- **Improved efficiency:** With a list of plugins readily available from a dashboard, you can enable, disable, update, or remove plugins in the OpenSearch Dashboards UI.
|
||||
- **Better troubleshooting:** Viewing a list of plugins from a dashboard can help you quickly identify which plugins may be causing a problem.
|
||||
- **Enhanced security:** With a list of plugins readily available from a dashboard, you can easily see if any outdated or vulnerable plugins are present and then quickly remove or update them, minimizing or avoiding security risks.
|
||||
- **Improved website performance:** Viewing a list of plugins from a dashboard can help you identify any plugins that may be slowing down your website or causing performance issues.
|
||||
|
||||
Get familiar with the basics of managing plugins from the Dashboard app in less than 20 seconds in the following video.
|
||||
|
||||
|
||||
|
||||
## Viewing a list of installed plugins
|
||||
|
||||
To view a list of installed plugins from the Dashboard app, follow these steps:
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Dashboard**.
|
||||
2. View the list of items and select your plugin. Plugins are categorized automatically as the Observability Dashboard data type, which you can filter in order to concentrate on just what you want to see.
|
||||
|
||||
## Adding and removing plugins
|
||||
|
||||
To add a plugin from the Dashboard app, follow these steps:
|
||||
|
||||
1. From the OpenSearch Dashboards main menu, select **Dashboard**.
|
||||
2. In the **Dashboards** window, select **Create** > **Dashboard**.
|
||||
3. In the **Create operational panel** window, enter a name in the **Name** field and then select **Create**. The plugin is added to both the Observability app and the Dashboard app.
|
||||
|
||||
You can remove a plugin from the Dashboard app by selecting the edit icon under the **Actions** column and then selecting **Delete**.
|
||||
|
||||
## Staying updated about OpenSearch Dashboards plugins
|
||||
|
||||
The [OpenSearch plugins repository](https://github.com/opensearch-project/opensearch-plugins) on GitHub is a great way to keep track of and contribute to tasks, features, enhancements, and bugs. The OpenSearch Project team welcomes your input.
|
||||
|
|
@ -1,24 +1,19 @@
|
|||
---
|
||||
layout: default
|
||||
title: OpenSearch Dashboards plugins
|
||||
parent: Installing OpenSearch Dashboards
|
||||
nav_order: 50
|
||||
title: Managing OpenSearch Dashboards plugins
|
||||
nav_order: 100
|
||||
redirect_from:
|
||||
- /dashboards/install/plugins
|
||||
- /install-and-configure/install-dashboards/plugins/
|
||||
---
|
||||
|
||||
# Standalone plugin install
|
||||
# Managing OpenSearch Dashboards plugins
|
||||
|
||||
If you don't want to use the all-in-one installation options, you can install the various plugins for OpenSearch Dashboards individually.
|
||||
OpenSearch Dashboards provides a command line tool called `opensearch-plugin` for managing plugins. This tool allows you to:
|
||||
|
||||
---
|
||||
|
||||
#### Table of contents
|
||||
1. TOC
|
||||
{:toc}
|
||||
|
||||
|
||||
---
|
||||
- List installed plugins.
|
||||
- Install plugins.
|
||||
- Remove an installed plugin.
|
||||
|
||||
## Plugin compatibility
|
||||
|
||||
|
|
@ -29,7 +24,7 @@ Major, minor, and patch plugin versions must match OpenSearch major, minor, and
|
|||
|
||||
- A compatible OpenSearch cluster
|
||||
- The corresponding OpenSearch plugins [installed on that cluster]({{site.url}}{{site.baseurl}}/opensearch/install/plugins/)
|
||||
- The corresponding version of [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/) (for example, OpenSearch Dashboards 2.1.0 works with OpenSearch 2.1.0)
|
||||
- The corresponding version of [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/) (for example, OpenSearch Dashboards 2.3.0 works with OpenSearch 2.3.0)
|
||||
|
||||
## Available plugins
|
||||
|
||||
|
|
@ -53,7 +48,7 @@ The following table lists available OpenSearch Dashboards plugins.
|
|||
|
||||
## Install
|
||||
|
||||
Navigate to the OpenSearch Dashboards home directory (likely `/usr/share/opensearch-dashboards`) and run the install command for each plugin.
|
||||
Navigate to the OpenSearch Dashboards home directory (for example, `/usr/share/opensearch-dashboards`) and run the install command for each plugin.
|
||||
|
||||
{% comment %}
|
||||
|
||||
|
|
@ -65,7 +60,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin provides a user interface for managing users, roles, mappings, action groups, and tenants.
|
||||
|
||||
|
||||
#### Alerting OpenSearch Dashboards
|
||||
|
||||
```bash
|
||||
|
|
@ -74,7 +68,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin provides a user interface for creating monitors and managing alerts.
|
||||
|
||||
|
||||
#### Index State Management OpenSearch Dashboards
|
||||
|
||||
```bash
|
||||
|
|
@ -83,7 +76,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin provides a user interface for managing policies.
|
||||
|
||||
|
||||
#### Anomaly Detection OpenSearch Dashboards
|
||||
|
||||
```bash
|
||||
|
|
@ -92,7 +84,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin provides a user interface for adding detectors.
|
||||
|
||||
|
||||
#### Query Workbench OpenSearch Dashboards
|
||||
|
||||
```bash
|
||||
|
|
@ -101,7 +92,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin provides a user interface for using SQL queries to explore your data.
|
||||
|
||||
|
||||
#### Trace Analytics
|
||||
|
||||
```bash
|
||||
|
|
@ -110,7 +100,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin uses distributed trace data (indexed in OpenSearch using Data Prepper) to display latency trends, error rates, and more.
|
||||
|
||||
|
||||
#### Notebooks OpenSearch Dashboards
|
||||
|
||||
```bash
|
||||
|
|
@ -119,7 +108,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin lets you combine OpenSearch Dashboards visualizations and narrative text in a single interface.
|
||||
|
||||
|
||||
#### Reports OpenSearch Dashboards
|
||||
|
||||
```bash
|
||||
|
|
@ -133,7 +121,6 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.
|
|||
|
||||
This plugin lets you export and share reports from OpenSearch Dashboards dashboards, visualizations, and saved searches.
|
||||
|
||||
|
||||
#### Gantt Chart OpenSearch Dashboards
|
||||
|
||||
```bash
|
||||
|
|
@ -144,15 +131,14 @@ This plugin adds a new Gantt chart visualization.
|
|||
|
||||
{% endcomment %}
|
||||
|
||||
## List installed plugins
|
||||
## Viewing a list of installed plugins
|
||||
|
||||
To check your installed plugins:
|
||||
To view the list of installed plugins from the command line, use the following command:
|
||||
|
||||
```bash
|
||||
sudo bin/opensearch-dashboards-plugin list
|
||||
```
|
||||
|
||||
|
||||
## Remove plugins
|
||||
|
||||
To remove a plugin:
|
||||
|
|
@ -171,8 +157,7 @@ sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-det
|
|||
|
||||
Then restart OpenSearch Dashboards. After you remove any plugin, OpenSearch Dashboards performs an optimize operation the next time you start it. This operation takes several minutes even on fast machines, so be patient.
|
||||
|
||||
|
||||
## Update plugins
|
||||
## Updating plugins
|
||||
|
||||
OpenSearch Dashboards doesn’t update plugins. Instead, you have to remove the old version and its optimized bundle, reinstall them, and restart OpenSearch Dashboards:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: default
|
||||
title: Anomaly detection
|
||||
nav_order: 90
|
||||
nav_order: 80
|
||||
has_children: true
|
||||
redirect_from:
|
||||
- /monitoring-plugins/ad/
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: default
|
||||
title: Observability
|
||||
nav_order: 1
|
||||
has_children: false
|
||||
has_children: true
|
||||
redirect_from:
|
||||
- /observability-plugin/index/
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: default
|
||||
title: Notifications
|
||||
nav_order: 80
|
||||
nav_order: 90
|
||||
has_children: true
|
||||
redirect_from:
|
||||
- /notifications-plugin/
|
||||
|
|
|
|||
Loading…
Reference in New Issue