目录
1.控制台
控制台插件提供一个用户界面来和 Elasticsearch 的 REST API 交互。控制台有两个主要部分: editor,用来编写提交给 Elasticsearch 的请求; response 面板,用来展示请求结果的响应。在页面顶部的文本框中输入 Elasticsearch 服务器的地址。默认地址是:“localhost:9200”。
图 1. 控制台用户界面
控制台可以解析像 cURL 命令这样的语句。例如以下控制台命令
GET /_search
{
"query": {
"match_all": {}
}
}
是 Elasticsearch _search API
的简单 GET 请求。下面是同样效果的 cURL 命令。
curl -XGET "http://localhost:9200/_search" -d'
{
"query": {
"match_all": {}
}
}'
当敲入一行命令,控制台会给出上下文相关的提示。这些提示可以帮助您探索每条 API 参数,或者用于提高输入速度。控制台会提示 APIs 、索引和字段名。
图 2. API 提示
图 3. 动作菜单
图 4. 输出面板
1.1.多请求支持
控制台编辑器允许您编写相互层叠的多个请求,像在控制台章节展示中那样,您可以通过定位光标并使用动作菜单向 Elasticsearch 提交请求。类似的,您可以一次选择多个请求:
图 5. 选择多个请求
控制台会依次提交请求到 Elasticsearch ,并将 Elasticsearch 返回的结果显示在右边窗口。这在调试问题或在多个场景中尝试查询组合时会非常方便。
选择多个请求还允许您自动格式化并将其复制为 cURL 命令。
1.2.自动格式化
控制台允许您自动格式化复杂的请求。为此,请将光标置于您想格式化的请求上,并从操作菜单中选择自动缩进:
图 6. 自动缩进一个请求
图 7. 格式化的请求
如果在已完全格式化的请求上选择自动缩进,控制台将把每个文档的请求体折叠到一行,这在使用 Elasticsearch 的批量 API 的时候会非常方便。
图 8. 每个文档一行
1.3.键盘快捷键
控制台配备了一套非常方便的键盘快捷键,使其工作效率更高。
1.3.1.一般编辑
Ctrl/Cmd + I
当前请求自动缩进。
Ctrl + Space
打开自动补全 (即使没有打字也可以)。
Ctrl/Cmd + Enter
提交请求。
Ctrl/Cmd + Up/Down
跳转到上一个/下一个请求的开始或结束。
Ctrl/Cmd + Alt + L
折叠或展开当前代码块。
Ctrl/Cmd + Option + 0
折叠除当前代码块之外的所有代码块,通过添加 shift 来展开。
1.3.2.自动补全可见时
Down arrow
光标切换到自动补全菜单,使用方向键选择下一个选项。
Enter/Tab
在自动补全菜单中选择当前或最上面的选项。
Esc
关闭自动补全菜单。
1.4.键盘快捷键
控制台维护 Elasticsearch 成功执行的最后500个请求列表。点击窗口右上角的时钟图标即可查看历史记录。这个图标会打开历史记录面板,您可以在其中查看历史请求。您也可以在这里选择一个请求,它将被添加到编辑器中当前光标所在的位置。
图 9. 历史记录面板
1.5.设置
控制台有很多设置,这些设置都可以在控制面板中找到。点击右上角的齿轮按钮就能打开设置面板。
图 10. 设置面板
1.6.配置控制台
可以在 config/kibana.yml
文件中添加以下配置:
console.enabled
默认: true 。设置为 false 以禁用控制台。切换此配置将导致服务器在下次启动时重新生成资源,这可能会造成页面开始服务之前有些延迟。