Kibana pluginsedit

Implement add-on functionality for Kibana with plug-in modules.

Plugin compatibility

The Kibana plugin interfaces are in a state of constant development. We cannot provide backwards compatibility for plugins due to the high rate of change. Kibana enforces that the installed plugins match the version of Kibana. Plugin developers must release a new version of their plugin for each new Kibana release.

Known pluginsedit

The known plugins were tested for Kibana 5.x, so we are unable to guarantee compatibility with your version of Kibana. The Kibana installer rejects any plugins that haven’t been published for your specific version of Kibana. We are unable to evaluate or maintain the known plugins, so care should be taken before installation.

Appsedit

  • LogTrail - View, analyze, search and tail log events in realtime with a developer/sysadmin friendly interface
  • Own Home (wtakase) - enables multi-tenancy
  • Shard Allocation (asileon) - visualize elasticsearch shard allocation
  • Wazuh - Wazuh provides host-based security visibility using lightweight multi-platform agents.
  • Indices View - View indices related information.
  • Analyze UI (johtani) - UI for elasticsearch _analyze API
  • Cleaner (TrumanDu)- Setting index ttl.
  • ElastAlert Kibana Plugin (BitSensor) - UI to create, test and edit ElastAlert rules
  • AI Analyst (Query.AI) - App providing: NLP queries, automation, ML visualizations and insights

Timelion Extensionsedit

  • mathlion (fermiumlabs) - enables equation parsing and advanced math under Timelion

Visualizationsedit

Otheredit

  • Time filter as a dashboard panel Widget to view and edit the time range from within dashboards.
  • Kibana-API (webiks) Exposes an API with Kibana functionality. Use it to create, edit and embed visualizations, and also to search inside an embedded dashboard.
  • Markdown Doc View (sw-jung) - A plugin for custom doc view using markdown+handlebars template.
  • Datasweet Formula (datasweet) - enables calculated metric on any standard Kibana visualization.
  • Prometheus Exporter - exports the Kibana metrics in the prometheus format

To add your plugin to this page, open a pull request.

Install pluginsedit

Use the following command to install a plugin:

bin/kibana-plugin install <package name or URL>

When you specify a plugin name without a URL, the plugin tool attempts to download an official Elastic plugin, such as:

$ bin/kibana-plugin install x-pack

Install plugins from an arbitrary URLedit

You can download official Elastic plugins simply by specifying their name. You can alternatively specify a URL or file path to a specific plugin, as in the following examples:

$ bin/kibana-plugin install https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-7.14.1.zip

or

$ bin/kibana-plugin install file:///local/path/to/custom_plugin.zip

You can specify URLs that use the HTTP, HTTPS, or file protocols.

Proxy support for plugin installationedit

Kibana supports plugin installation via a proxy. It uses the http_proxy and https_proxy environment variables to detect a proxy for HTTP and HTTPS URLs.

It also respects the no_proxy environment variable to exclude specific URLs from proxying.

You can specify the environment variable directly when installing plugins:

$ http_proxy="http://proxy.local:4242" bin/kibana-plugin install <package name or URL>

Update and remove pluginsedit

To update a plugin, remove the current version and reinstall the plugin.

To remove a plugin, use the remove command, as in the following example:

$ bin/kibana-plugin remove x-pack

You can also remove a plugin manually by deleting the plugin’s subdirectory under the plugins/ directory.

Removing a plugin will result in an "optimize" run which will delay the next start of Kibana.

Disable pluginsedit

Use the following command to disable a plugin:

./bin/kibana --<plugin ID>.enabled=false 

Disabling or enabling a plugin will result in an "optimize" run which will delay the start of Kibana.

You can find a plugin’s plugin ID as the value of the name property in the plugin’s package.json file.

Configure the plugin manageredit

By default, the plugin manager provides you with feedback on the status of the activity you’ve asked the plugin manager to perform. You can control the level of feedback for the install and remove commands with the --quiet and --silent options. Use the --quiet option to suppress all non-error output. Use the --silent option to suppress all output.

By default, plugin manager installation requests do not time out. Use the --timeout option, followed by a time, to change this behavior, as in the following examples:

Waits for 30 seconds before failing.

bin/kibana-plugin install --timeout 30s sample-plugin

Waits for 1 minute before failing.

bin/kibana-plugin install --timeout 1m sample-plugin

Plugins and custom Kibana configurationsedit

Use the -c or --config options with the install and remove commands to specify the path to the configuration file used to start Kibana. By default, Kibana uses the configuration file config/kibana.yml. When you change your installed plugins, the bin/kibana-plugin command restarts the Kibana server. When you are using a customized configuration file, you must specify the path to that configuration file each time you use the bin/kibana-plugin command.

Plugin manager exit codesedit

0

Success

64

Unknown command or incorrect option parameter

74

I/O error

70

Other error