2015-09-15 05:36:47 +02:00
|
|
|
[[kibana-plugins]]
|
2016-10-25 03:41:32 +02:00
|
|
|
= Kibana Plugins
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
[partintro]
|
|
|
|
--
|
2016-07-06 00:16:33 +02:00
|
|
|
Add-on functionality for Kibana is implemented with plug-in modules. You can use the `bin/kibana-plugin`
|
|
|
|
command to manage these modules. You can also install a plugin manually by moving the plugin file to the
|
|
|
|
`plugins` directory and unpacking the plugin files into a new directory.
|
2016-10-25 03:41:32 +02:00
|
|
|
--
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
== Installing Plugins
|
2015-09-15 05:36:47 +02:00
|
|
|
|
|
|
|
Use the following command to install a plugin:
|
|
|
|
|
|
|
|
[source,shell]
|
2016-04-05 01:38:09 +02:00
|
|
|
bin/kibana-plugin install <package name or URL>
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
When you specify a plugin name without a URL, the plugin tool attempts to download an official Elastic plugin, such as:
|
|
|
|
|
|
|
|
["source","shell",subs="attributes"]
|
|
|
|
$ bin/kibana-plugin install x-pack
|
|
|
|
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2015-09-17 02:21:46 +02:00
|
|
|
[float]
|
2016-10-25 03:41:32 +02:00
|
|
|
=== Installing Plugins from an Arbitrary URL
|
2015-09-17 02:21:46 +02:00
|
|
|
|
2016-04-05 01:38:09 +02:00
|
|
|
You can specify a URL to a specific plugin, as in the following example:
|
2015-09-17 02:21:46 +02:00
|
|
|
|
2016-09-08 16:13:03 +02:00
|
|
|
["source","shell",subs="attributes"]
|
2016-09-08 15:53:09 +02:00
|
|
|
$ bin/kibana-plugin install https://download.elastic.co/kibana/x-pack/x-pack-{version}.zip
|
2015-09-17 02:21:46 +02:00
|
|
|
|
2015-09-19 00:24:30 +02:00
|
|
|
You can specify URLs that use the HTTP, HTTPS, or `file` protocols.
|
|
|
|
|
2015-09-17 02:21:46 +02:00
|
|
|
[float]
|
|
|
|
=== Installing Plugins to an Arbitrary Directory
|
|
|
|
|
2016-07-06 00:16:33 +02:00
|
|
|
Use the `-d` or `--plugin-dir` option after the `install` command to specify a directory for plugins, as in the following
|
2016-04-02 20:36:04 +02:00
|
|
|
example:
|
2015-09-17 02:21:46 +02:00
|
|
|
|
|
|
|
[source,shell]
|
2016-04-05 01:38:09 +02:00
|
|
|
$ bin/kibana-plugin install file:///some/local/path/x-pack.zip -d path/to/directory
|
2015-09-17 02:21:46 +02:00
|
|
|
|
|
|
|
NOTE: This command creates the specified directory if it does not already exist.
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
== Updating & Removing Plugins
|
|
|
|
|
|
|
|
To update a plugin, remove the current version and reinstall the plugin.
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
To remove a plugin, use the `remove` command, as in the following example:
|
2015-09-15 05:36:47 +02:00
|
|
|
|
|
|
|
[source,shell]
|
2016-10-25 03:41:32 +02:00
|
|
|
$ bin/kibana-plugin remove x-pack
|
2015-09-19 00:54:49 +02:00
|
|
|
|
2016-07-06 00:16:33 +02:00
|
|
|
You can also remove a plugin manually by deleting the plugin's subdirectory under the `plugins/` directory.
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
NOTE: Removing a plugin will result in an "optimize" run which will delay the next start of Kibana.
|
2016-03-08 02:37:29 +01:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
== Disabling Plugins
|
2016-03-08 02:37:29 +01:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
Use the following command to disable a plugin:
|
2015-09-18 23:56:24 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
[source,shell]
|
|
|
|
-----------
|
|
|
|
./bin/kibana --<plugin ID>.enabled=false <1>
|
|
|
|
-----------
|
2015-09-18 23:56:24 +02:00
|
|
|
|
2016-10-25 03:41:32 +02:00
|
|
|
NOTE: Disabling or enabling a plugin will result in an "optimize" run which will delay the start of Kibana.
|
|
|
|
|
|
|
|
<1> You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file.
|
|
|
|
|
|
|
|
== Configuring the Plugin Manager
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-07-06 00:16:33 +02:00
|
|
|
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
|
2016-04-02 20:36:04 +02:00
|
|
|
output.
|
2015-09-15 05:36:47 +02:00
|
|
|
|
2016-04-02 20:36:04 +02:00
|
|
|
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:
|
2015-09-15 05:36:47 +02:00
|
|
|
|
|
|
|
[source,shell]
|
|
|
|
.Waits for 30 seconds before failing
|
2016-07-06 00:16:33 +02:00
|
|
|
bin/kibana-plugin install --timeout 30s sample-plugin
|
2015-09-15 05:36:47 +02:00
|
|
|
|
|
|
|
[source,shell]
|
|
|
|
.Waits for 1 minute before failing
|
2016-07-06 00:16:33 +02:00
|
|
|
bin/kibana-plugin install --timeout 1m sample-plugin
|
2015-09-17 02:21:46 +02:00
|
|
|
|
2015-09-18 00:36:31 +02:00
|
|
|
[float]
|
2016-10-25 03:41:32 +02:00
|
|
|
=== Plugins and Custom Kibana Configurations
|
2015-09-17 02:21:46 +02:00
|
|
|
|
2016-07-06 00:16:33 +02:00
|
|
|
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,
|
2016-04-05 01:38:09 +02:00
|
|
|
you must specify the path to that configuration file each time you use the `bin/kibana-plugin` command.
|
2015-09-15 05:36:47 +02:00
|
|
|
|
|
|
|
[float]
|
|
|
|
=== Plugin Manager Exit Codes
|
|
|
|
|
|
|
|
[horizontal]
|
|
|
|
0:: Success
|
|
|
|
64:: Unknown command or incorrect option parameter
|
|
|
|
74:: I/O error
|
|
|
|
70:: Other error
|