7.4 KiB
| layout | title | parent | nav_order |
|---|---|---|---|
| default | OpenSearch Dashboards plugins | Install OpenSearch Dashboards | 50 |
Standalone plugin install
If you don't want to use the all-in-one installation options, you can install the various plugins for OpenSearch Dashboards individually.
Table of contents
- TOC {:toc}
Plugin compatibility
| OpenSearch Dashboards version | Plugin versions |
|---|---|
| 1.0.0-rc1 |
alertingDashboards 1.0.0.0-rc1 anomalyDetectionDashboards 1.0.0.0-rc1 ganttChartDashboards 1.0.0.0-rc1 indexManagementDashboards 1.0.0.0-rc1 notebooksDashboards 1.0.0.0-rc1 queryWorkbenchDashboards 1.0.0.0-rc1 reportsDashboards 1.0.0.0-rc1 securityDashboards 1.0.0.0-rc1 traceAnalyticsDashboards 1.0.0.0-rc1 |
| 1.0.0-beta1 |
alertingDashboards 1.0.0.0-beta1 anomalyDetectionDashboards 1.0.0.0-beta1 ganttChartDashboards 1.0.0.0-beta1 indexManagementDashboards 1.0.0.0-beta1 notebooksDashboards 1.0.0.0-beta1 queryWorkbenchDashboards 1.0.0.0-beta1 reportsDashboards 1.0.0.0-beta1 securityDashboards 1.0.0.0-beta1 traceAnalyticsDashboards 1.0.0.0-beta1 |
Prerequisites
- A compatible OpenSearch cluster
- The corresponding OpenSearch plugins installed on that cluster
- The corresponding version of OpenSearch Dashboards (e.g. OpenSearch Dashboards 1.0.0 works with OpenSearch 1.0.0)
Install
Navigate to the OpenSearch Dashboards home directory (likely /usr/share/opensearch-dashboards) and run the install command for each plugin.
{% comment %}
Security OpenSearch Dashboards
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-security/opensearchSecurityOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.1.zip
This plugin provides a user interface for managing users, roles, mappings, action groups, and tenants.
Alerting OpenSearch Dashboards
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-alerting/opensearchAlertingOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
This plugin provides a user interface for creating monitors and managing alerts.
Index State Management OpenSearch Dashboards
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-index-management/opensearchIndexManagementOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.1.zip
This plugin provides a user interface for managing policies.
Anomaly Detection OpenSearch Dashboards
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-anomaly-detection/opensearchAnomalyDetectionOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
This plugin provides a user interface for adding detectors.
Query Workbench OpenSearch Dashboards
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-query-workbench/opensearchQueryWorkbenchOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
This plugin provides a user interface for using SQL queries to explore your data.
Trace Analytics
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-trace-analytics/opensearchTraceAnalyticsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0.zip
This plugin uses distributed trace data (indexed in OpenSearch using Data Prepper) to display latency trends, error rates, and more.
Notebooks OpenSearch Dashboards
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-notebooks/opensearchNotebooksOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0.zip
This plugin lets you combine OpenSearch Dashboards visualizations and narrative text in a single interface.
Reports OpenSearch Dashboards
# x86 Linux
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-reports/linux/x64/opensearchReportsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0-linux-x64.zip
# ARM64 Linux
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-reports/linux/arm64/opensearchReportsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0-linux-arm64.zip
# x86 Windows
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-reports/windows/x64/opensearchReportsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0-windows-x64.zip
This plugin lets you export and share reports from OpenSearch Dashboards dashboards, visualizations, and saved searches.
Gantt Chart OpenSearch Dashboards
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-gantt-chart/opensearchGanttChartOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
This plugin adds a new Gantt chart visualization.
{% endcomment %}
List installed plugins
To check your installed plugins:
sudo bin/opensearch-dashboards-plugin list
Remove plugins
To remove a plugin:
sudo bin/opensearch-dashboards-plugin remove <plugin-name>
For certain plugins, you must also remove the "optimze" bundle. This is a sample command for the Anomaly Detection plugin:
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
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
OpenSearch Dashboards doesn’t update plugins. Instead, you have to remove the old version and its optimized bundle, reinstall them, and restart OpenSearch Dashboards:
-
Remove the old version:
sudo bin/opensearch-dashboards-plugin remove <plugin-name> -
Remove the optimized bundle:
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/<bundle-name> -
Reinstall the new version:
sudo bin/opensearch-dashboards-plugin install <plugin-name> -
Restart OpenSearch Dashboards.
For example, to remove and reinstall the anomaly detection plugin:
sudo bin/opensearch-plugin remove opensearch-anomaly-detection
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
sudo bin/opensearch-dashboards-plugin install <AD OpenSearch Dashboards plugin artifact URL>