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 Dashboards plugin list extension #3443

Merged
merged 46 commits into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
4cfaeec
Content development
vagimeli Mar 13, 2023
6972f7a
Content planning
vagimeli Mar 17, 2023
6c3a70e
Content planning
vagimeli Mar 17, 2023
84cfa09
Content planning
vagimeli Mar 21, 2023
d26b52c
Content planning
vagimeli Mar 23, 2023
7a8101a
Content planning
vagimeli Mar 23, 2023
1fe5e67
Add new dashboards extension feature
vagimeli Mar 24, 2023
a521e3a
Address IA issues
vagimeli Mar 28, 2023
267fbdb
Content planning
vagimeli Mar 30, 2023
205f318
Content planning
vagimeli Mar 31, 2023
c9da84d
Content planning
vagimeli Mar 31, 2023
af49ac3
Content planning
vagimeli Apr 4, 2023
ed37ba0
Content planning
vagimeli Apr 4, 2023
a91860e
Content planning
vagimeli Apr 7, 2023
504b04a
Remove images and demo placeholder
vagimeli Apr 21, 2023
3a61faa
Copy edits
vagimeli Apr 21, 2023
2aaf105
Copy edits
vagimeli Apr 21, 2023
0077901
Copy edits
vagimeli Apr 21, 2023
fa81ea8
Copy edits
vagimeli Apr 21, 2023
1e7ad88
Copy edits
vagimeli Apr 24, 2023
0b5900e
Copy edits
vagimeli Apr 24, 2023
4691174
Update plugins-dashboards.md
vagimeli Apr 25, 2023
63d4fd6
Update plugins-dashboards.md
vagimeli Apr 25, 2023
337a1e8
Update plugins-dashboards.md
vagimeli Apr 25, 2023
7a37156
Update plugins-dashboards.md
vagimeli Apr 25, 2023
dbb9d0e
Update plugins-dashboards.md
vagimeli Apr 25, 2023
56a7900
Update plugins-dashboards.md
vagimeli Apr 25, 2023
2ea4acf
Update plugins-dashboards.md
vagimeli Apr 25, 2023
d5f595f
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 25, 2023
ae02cd8
Update plugins-dashboards.md
vagimeli Apr 25, 2023
44fb7a4
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 25, 2023
3560768
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 25, 2023
9a9f824
Update plugins-dashboards.md
vagimeli Apr 25, 2023
1967fdb
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 25, 2023
3cc2192
Update _install-and-configure/install-dashboards/plugins.md
vagimeli Apr 25, 2023
08fc178
Update _install-and-configure/install-dashboards/plugins.md
vagimeli Apr 25, 2023
3c788ad
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 26, 2023
e739452
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 26, 2023
e9defbb
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 26, 2023
4bffc72
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 26, 2023
c5cddea
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 26, 2023
72a8a39
Update _dashboards/dashboard/plugins-dashboards.md
vagimeli Apr 26, 2023
04722e8
Update _install-and-configure/install-dashboards/plugins.md
vagimeli Apr 26, 2023
e6730f5
Change has_children from false to true
vagimeli Apr 26, 2023
454f806
Address editorial review comments
vagimeli Apr 26, 2023
7845d18
Address editorial review feedback
vagimeli Apr 27, 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
47 changes: 47 additions & 0 deletions _dashboards/dashboard/plugins-dashboards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: default
title: Managing plugins with a dashboard
parent: Observability
nav_order: 5
---

# Managing plugins with a dashboard

Introduced 2.7
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
{: .label .label-purple }

The default installation of OpenSearch Dashboards includes the Observability plugin, which you can use to visualize data-driven events using Piped Processing Language (PPL) to explore, discover, and query data stored in OpenSearch. The plugin requires OpenSearch 1.2 or later.

The Observability plugin provides a unified experience for collecting and monitoring metrics, logs, and traces from common data sources. Data collection and monitoring in one place enables 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. The plugins are integrated automatically into Observability Dashboards and Dashboard. This feature provides you:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

- **Instant access to installed plugins:** Viewing a list of plugins from a dashboard displays all the installed plugins in one place.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- **Improved efficiency:** With a list of plugins readily available from a dashboard, you can enable, disable, update, or remove them with just a few clicks.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- **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.

## Viewing installed plugins

There are two ways to view installed plugins from a dashboard: with Observability Dashboards application or with Dashboard. To view your installed plugins, follow these steps:

1. From the OpenSearch Dashboards main menu, select **Observability** > **Dashboard**. Alternatively, 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 to concentrate on just what you want to see.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

The following image shows a list of plugins viewed in the Observability Dashboard interface.

<insert image>

## Installing and removing plugins

To install plugins using the Observability Dashboards application, follow these steps:

1. From the OpenSearch Dashboards main menu, select **Observability Dashboards**. Alternatively, select **Dashboard**.
2. From the **Dashboards** window, select **Create** > **Observability 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 Plugins application and the Dashboards application.
4. To remove the plugin, select <insert steps>.

## Staying updated about OpenSearch Dashboards plugins
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

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, feature requests, enhancements, and bugs. The OpenSearch Project team welcomes your input.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
47 changes: 20 additions & 27 deletions _install-and-configure/install-dashboards/plugins.md
Original file line number Diff line number Diff line change
@@ -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 uses a command line tool called `opensearch-plugin` for managing plugins. This tool allows you to:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

---

#### Table of contents
1. TOC
{:toc}


---
- List installed plugins.
- Install plugins.
- Remove an installed plugin.

## Plugin compatibility

Expand All @@ -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

Expand All @@ -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 %}

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -144,14 +131,21 @@ 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
```

To view a list of plugins the OpenSearch Dashboards user interface (UI):
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. Connect to OpenSearch Dashboards.
2. Select
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming there should be more text here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted from this page, as it's covered in the Dashboard app section.


Viewing the list of plugins from the UI was introduced in OpenSearch Dashboards 2.7. Earlier versions do not have this feature.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
{: .note}

## Remove plugins

Expand All @@ -171,8 +165,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:

Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/ad/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Anomaly detection
nav_order: 90
nav_order: 80
has_children: true
redirect_from:
- /monitoring-plugins/ad/
Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/notifications/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Notifications
nav_order: 80
nav_order: 90
has_children: true
redirect_from:
- /notifications-plugin/
Expand Down