Elasticsearch插件体系

Elasticsearch插件体系

插件分类

Elasticsearch支持三种类型的插件:

1、java插件

这些插件只包含Jar文件，并且必须安装在集群中的每个节点上。安装后，每个节点必须重新启动，该插件才变得可见。

2、站点插件

这些插件包含了静态的Web内容，如JavaScript，HTML和CSS文件，可直接从Elasticsearch 访问。站点插件可能只需要在一个节点上安装，并且不需要重新启动就能变得可见。

站点插件的内容是通过一个类似的网址访问：

HTTP：/ / yournode：9200 / _plugin / [插件名称]

3、混合插件

混合插件同时包含jar文件和静态的Web内容

插件管理

命令查看

1、查看plugin命令用法：

插件安装

2、安装Elasticsearch核心插件命令格式：

例子：

该命令将安装与你的Elasticsearch版本相匹配的插件版本。

3、安装社区插件或非核心插件

非核心插件由Elasticsearch提供，或者由社区提供，可以从download.elastic.co，Maven

（中央和Sonatype），或从GitHub安装。在这种情况下，命令如下：

例子：

sudo bin/plugin install lmenezes/elasticsearch-kopf

sudo bin/plugin install lmenezes/elasticsearch-kopf/2.x

Installs the latest version from GitHub.

Installs the 2.x version from GitHub.

从Maven Central/Sonatype安装时, [org]需要替换为groupId,

[user|component]替换为artifactId. For plugin from Sonatype, run:

sudo bin/plugin install org.elasticsearch.plugin/mapper-attachments/3.0.0

当从

download.elastic.co或Maven Central/Sonatype安装时, version 是必须的。

自定义URL或文件系统

插件可以直接从自定义URL下载，格式如下:

sudo bin/plugin install [url]

must be a valid URL, the plugin name is determined from its descriptor.

例如从本地文件系统安装插件:

sudo bin/plugin install file:///path/to/plugin.zip

The plugin script will refuse to talk to an HTTPS URL with an untrusted

certificate. To use a self-signed HTTPS cert, you will need to add the CA cert to

a local Java truststore and pass the location to the script as follows:

sudo bin/plugin .ssl.trustStore=/path/to/trustStore.jks install https://....

查询及删除插件

列出已加载的插件

删除插件

方式1：删除plugins/目录下的插件对应的文件夹，即可删除插件,

方式2：使用脚本：

sudo bin/plugin remove [pluginname]

插件删除以后需要重新启动服务节点。

plugin命令的其他参数

Silent/Verbose模式

--verbose：输出调试信息

--silent：关闭所有输出

plugin命令可能返回的错误码:

0everything was OK

64unknown command or incorrect option parameter

74IO error

70any other error

指定自定义配置文件目录

如果 elasticsearch.yml在自定义位置, 使用plugin命令时需要指定配置文件位置。格式如下:

sudo bin/plugin -Des.path.conf=/path/to/custom/config/dir install

也可以设置CONF_DIR环境变量来设置自定义的配置文件目录。

超时设置

默认情况,插件脚本将在未下载的时候等待下去。超时参数可以用来显式地指定等待多长时间。下面是将其设置为不同的值的一些例子:

# Wait for 30 seconds before failing

sudo bin/plugin install mobz/elasticsearch-head --timeout 30s

# Wait for 1 minute before failing

sudo bin/plugin install mobz/elasticsearch-head --timeout 1m

# Wait forever (default)

sudo bin/plugin install mobz/elasticsearch-head --timeout 0

Proxy设置

通过代理安装一个插件，需要指定proxy host和proxy port。

在基于Unix的系统上，如下

sudo bin/plugin install mobz/elasticsearch-head -DproxyHost=host_name

-DproxyPort=port_number

在Windows下, 需要添加JAVA_OPTS环境变量:

set JAVA_OPTS="-DproxyHost=host_name -DproxyPort=port_number"

bin/plugin install mobz/elasticsearch-head

与插件相关的设置

自定义插件目录：

修改elasticsearch.yml：

配置必需的插件：