Kibana User Guide [4.2] » Kibana Plugins

Kibana Plugins

Kibana插件

Add-on functionality for Kibana is implemented with plug-in modules. You can use the bin/kibana plugincommand to manage these modules. You can also install a plugin manually by moving the plugin file to theinstalledPlugins directory and unpacking the plugin files into a new directory.

Kibana的额外功能通过plug-in模块被执行。你可以使用bin/kibana plugin来操作这些模块。你也可以手动安装插件，通过把插件文件移动到installedPlugins目录，然后解压插件文件到一个新目录。

Installing Plugins

安装插件

Use the following command to install a plugin:

用下面的命令安装：

bin/kibana plugin --install <org>/<package>/<version>

You can also use -i instead of --install, as in the following example:

可以使用-i代替--install。

bin/kibana plugin -i elasticsearch/marvel/latest

Because the organization given is elasticsearch, the plugin management tool automatically downloads the plugin from download.elastic.co.

因为官方发布者是elasticsearch，插件管理工具可以从下载download.elastic.co。

Installing Plugins from Github

从Github安装插件

When the specified plugin is not found at download.elastic.co, the plugin management tool parses the element as a Github user name, as in the following example:

当在download.elastic.co找不到特殊的插件时，插件管理工具就解析元素成一个Github用户名。

bin/kibana plugin --install github-user/sample-plugin
Installing sample-plugin
Attempting to extract from https://download.elastic.co/github-user/sample-plugin/sample-plugin-latest.tar.gz
Attempting to extract from https://github.com/github-user/sample-plugin/archive/master.tar.gz
Downloading <some number> bytes....................
Extraction complete
Optimizing and caching browser bundles...
Plugin installation complete

Installing Plugins from an Arbitrary URL

从任意URL安装插件

You can specify a URL to a plugin with the -u or --url options after the -i or --install option, as in the following example:

你可以使用-u和--url选项来来确定一个URL。

bin/kibana plugin -i sample-plugin -u https://some.sample.url/directory
Installing sample-plugin
Attempting to extract from https://some.sample.url/directory
Downloading <some number> bytes....................
Extraction complete
Optimizing and caching browser bundles...
Plugin installation complete

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

URL可以使用HTTP，HTTPs或者文件协议。

Installing Plugins to an Arbitrary Directory

从任意路径安装插件

Use the -d or --plugin-dir option to specify a directory for plugins, as in the following example:

使用-d或--plugin-dir来确定路径。

bin/kibana plugin -i elasticsearch/sample-plugin/latest -d <path/to/directory>
Installing sample-plugin
Attempting to extract from https://download.elastic.co/elasticsearch/sample-plugin/sample-plugin-latest.tar.gz
Downloading <some number> bytes....................
Extraction complete
Optimizing and caching browser bundles...
Plugin installation complete

This command creates the specified directory if it does not already exist.

如果命令中的路径不存在，将会生成这个路径。

Removing Plugins

删除插件

Use the --remove or -r option to remove a plugin, including any configuration information, as in the following example:

使用--remove或-r 选项。

bin/kibana plugin --remove marvel

You can also remove a plugin manually by deleting the plugin’s subdirectory under the installedPluginsdirectory.

你也可以手动删除路径，通过删除installedPlugins目录下的子目录。

Updating Plugins

更新插件

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

想要更新插件，要删除现有版本，然后重新安装。

Configuring the Plugin Manager

配置插件管理器

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 with the --quiet and --silent options. Use the --quiet option to suppress all non-error output. Use the --silent option to suppress all output.

一般情况下，插件管理器会为你反馈你要求它操作的结果。你通过--quiet和--silent选项可以控制反馈的级别。使用--quiet选项来控制没有错误返回。使用 --silent来压制所有返回。

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

一般情况下，管理器请求不会有超时。可以使用--timeout选项来控制时间。

Waits for 30 seconds before failing. 

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

Waits for 1 minute before failing. 

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

Plugins and Custom Kibana Configurations

插件和定制的Kibana配置

Use the -c or --config options 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, thebin/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 plugincommand.

使用-c或--config 选项来确定启动Kibana的配置文件位置。一般情况下，Kibana使用配置文件config/kibana.yml。当你更改已安装的插件时，需要使用bin/kibana plugin命令重启Kibana服务。当你使用定制的配置文件时，你必须确定每次你使用bin/kibana plugin命令的路径。

备注：

材料来自elastic官网。

地址：

https://www.elastic.co/guide/en/kibana/current/kibana-plugins.html