Link Search Menu Expand Document

Open Distro for Elasticsearch development has moved to OpenSearch. The ODFE plugins will continue to work with legacy versions of Elasticsearch OSS, but we recommend upgrading to OpenSearch to take advantage of the latest features and improvements.

Standalone Kibana plugin install

If you don’t want to use the all-in-one Open Distro for Elasticsearch installation options, you can install the security, alerting, and Index State Management plugins for Kibana individually.


Table of contents

  1. Plugin compatibility
  2. Prerequisites
  3. Install
  4. List installed plugins
  5. Remove plugins
  6. Update plugins

Plugin compatibility

Kibana version Plugin versions
7.10.2
opendistroAlertingKibana          1.13.0.0
opendistroAnomalyDetectionKibana  1.13.0.0
opendistroGanttChartKibana        1.13.0.0
opendistroIndexManagementKibana   1.13.0.1
opendistroNotebooksKibana         1.13.2.0
opendistroQueryWorkbenchKibana    1.13.0.0
opendistroReportsKibana           1.13.2.0
opendistroSecurityKibana          1.13.0.1
opendistroTraceAnalyticsKibana    1.13.2.0
7.10.0
opendistroAnomalyDetectionKibana  1.12.0.0
opendistroAlertingKibana          1.12.0.2
opendistroIndexManagementKibana   1.12.0.0
opendistroSecurityKibana          1.12.0.0
opendistroQueryWorkbenchKibana    1.12.0.0
opendistroNotebooksKibana         1.12.0.0
opendistroReportsKibana           1.12.0.0
opendistroGanttChartKibana        1.12.0.0
opendistroTraceAnalyticsKibana    1.12.0.0
7.9.1
opendistro-anomaly-detection-kibana  1.10.1.0, 1.11.0.0
opendistro-alerting                  1.10.1.1, 1.11.0.2
opendistro_index_management_kibana   1.10.1.0, 1.11.0.0
opendistro_security_kibana_plugin    1.10.1.1, 1.11.0.0
opendistro-query-workbench           1.11.0.0
opendistro-notebooks-kibana          1.11.0.0
7.8.0
opendistro-anomaly-detection-kibana  1.9.0.0
opendistro-alerting                  1.9.0.0
opendistro_index_management_kibana   1.9.0.0
opendistro_security_kibana_plugin    1.9.0.0
opendistro-sql-workbench             1.9.0.0

Prerequisites

Install

Navigate to the Kibana home directory (likely /usr/share/kibana) and run the install command for each plugin.

Security Kibana

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-security/opendistroSecurityKibana-1.13.0.1.zip

This plugin provides a user interface for managing users, roles, mappings, action groups, and tenants.

Alerting Kibana

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-alerting/opendistroAlertingKibana-1.13.0.0.zip

This plugin provides a user interface for creating monitors and managing alerts.

Index State Management Kibana

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-index-management/opendistroIndexManagementKibana-1.13.0.1.zip

This plugin provides a user interface for managing policies.

Anomaly Detection Kibana

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-anomaly-detection/opendistroAnomalyDetectionKibana-1.13.0.0.zip

This plugin provides a user interface for adding detectors.

Query Workbench Kibana

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-query-workbench/opendistroQueryWorkbenchKibana-1.13.0.0.zip

This plugin provides a user interface for using SQL queries to explore your data.

Trace Analytics

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-trace-analytics/opendistroTraceAnalyticsKibana-1.13.2.0.zip

This plugin uses distributed trace data (indexed in Elasticsearch using Data Prepper) to display latency trends, error rates, and more.

Notebooks Kibana

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-notebooks/opendistroNotebooksKibana-1.13.2.0.zip

This plugin lets you combine Kibana visualizations and narrative text in a single interface.

Reports Kibana

# x86 Linux
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-reports/linux/x64/opendistroReportsKibana-1.13.2.0-linux-x64.zip
# ARM64 Linux
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-reports/linux/arm64/opendistroReportsKibana-1.13.2.0-linux-arm64.zip
# x86 Windows
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-reports/windows/x64/opendistroReportsKibana-1.13.2.0-windows-x64.zip

This plugin lets you export and share reports from Kibana dashboards, visualizations, and saved searches.

Gantt Chart Kibana

sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-gantt-chart/opendistroGanttChartKibana-1.13.0.0.zip

This plugin adds a new Gantt chart visualization.

List installed plugins

To check your installed plugins:

sudo bin/kibana-plugin list

Remove plugins

sudo bin/kibana-plugin remove <plugin-name>

For certain plugins, you must also remove the “optimze” bundle. Here is a sample command for the Anomaly Detection plugin:

sudo rm /usr/share/kibana/optimize/bundles/opendistro-anomaly-detection-kibana.*

Then restart Kibana. After the removal of any plugin, Kibana performs an optimize operation the next time you start it. This operation takes several minutes even on fast machines, so be patient.

Update plugins

Kibana doesn’t update plugins. Instead, you have to remove the old version and its optimized bundle, reinstall them, and restart Kibana:

  1. Remove the old version:

    sudo bin/kibana-plugin remove <plugin-name>
    
  2. Remove the optimized bundle:

    sudo rm /usr/share/kibana/optimize/bundles/<bundle-name>
    
  3. Reinstall the new version:

    sudo bin/kibana-plugin install <plugin-name>
    
  4. Restart Kibana.

For example, to remove and reinstall the anomaly detection plugin:

sudo bin/elasticsearch-plugin remove opendistro-anomaly-detection
sudo rm /usr/share/kibana/optimize/bundles/opendistro-anomaly-detection-kibana.*
sudo bin/kibana-plugin install <AD Kibana plugin artifact URL>