如何编写 elasticsearch 插件来扩展 /_search 端点？

Question

我使用的是 ES 5.1.2，我想为每个 /_search 请求做一些简单的身份验证密钥查找。 我在 elastic.co 上没有找到非常详细的插件开发指南，目前我找到的唯一文档是这个http://david.pilato.fr/blog/2016/10/19/adding-a-new-rest-endpoint-to-elasticsearch-updated-for-ga/，但它是关于创建另一个端点的。

我找到了 search-guard https://github.com/floragunncom/search-guard，从源代码中感觉我可以创建自己的插件 extends Plugin implements ActionPlugin，但后来我被卡住了，不知道该去哪里。

从源代码中我知道我可以添加自己的ActionFilter 并将其添加到Plugin 中的操作链中，这样所有请求都会通过/_search 端点也将通过我的ActionFilter。但我没有可能采取的行动的完整列表，可能是indices:data/read/search（搜索）或indices:admin/delete（删除索引）。有太多的尝试和错误。

另一件事是，在ActionFilter 中，我如何从Request 对象获取POST 请求有效负载？在/_search 请求中，我得到了SearchRequest，但它没有来自浏览器的http 请求标头。

== 更新 ==

发现我可以使用堆栈跟踪来获取调用历史记录，所以对于ActionFilter，调用堆栈就像

at org.elasticsearch.action.support.TransportAction$RequestFilterChain.proceed(TransportAction.java:171)
at org.elasticsearch.action.support.TransportAction.execute(TransportAction.java:145)
at org.elasticsearch.action.support.TransportAction.execute(TransportAction.java:87)
at org.elasticsearch.client.node.NodeClient.executeLocally(NodeClient.java:75)
at org.elasticsearch.client.node.NodeClient.doExecute(NodeClient.java:64)
at org.elasticsearch.client.support.AbstractClient.execute(AbstractClient.java:403)
at org.elasticsearch.client.support.AbstractClient.search(AbstractClient.java:530)
at org.elasticsearch.rest.action.search.RestSearchAction.lambda$prepareRequest$0(RestSearchAction.java:83)
at org.elasticsearch.rest.action.search.RestSearchAction$$Lambda$1405/1241306571.accept(Unknown Source)
at org.elasticsearch.rest.BaseRestHandler.handleRequest(BaseRestHandler.java:82)

在RestSearchAction#prepareRequest 中，ES 使用parseSearchRequest 并将RestRequest 数据转换为SearchRequest，这意味着我无法在我的ActionFitler 中获得RestRequest。是否应该有另一种方式来传递这些数据？因为我想扩展现有的/_search 而不是添加另一个端点，所以我认为我不应该再创建RestHandler

Answer 1

我找到了一个临时解决方案，源代码是here。

长话短说，当您将插件实现为RestHandler（通常使用新端点）时，您可以跳过registerHandler，只执行registerFilter。我在RestFilter 中实现我的逻辑。这是有效的，因为在 ElasticSearch source code 中，当 RestController 收到新请求时，它会检查您是否有任何 RestFilter，如果有，它将通过整个过滤器链，然后根据请求 URI。

在search guard 5 中似乎有一种方法可以直接在RestController 中注册RestFilter 而无需创建RestHandler，但我不了解整个流程所以我没有使用它。

我的主要参考资料：

• http://david.pilato.fr/blog/2016/10/19/adding-a-new-rest-endpoint-to-elasticsearch-updated-for-ga/
• https://github.com/floragunncom/search-guard/tree/es-5.1.2