Kibana plugins

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

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.

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

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.17.25.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.

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>

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.

[7.16.0] Deprecated in 7.16.0. In 8.0 and later, this setting will only be supported for a subset of plugins that have opted in to the behavior.

Use the following command to disable a plugin:

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

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

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.