Console
Console插件提供了一个与Elasticsearch的REST API交互的UI,Console有两个主要区域:编辑器,你在其中组成对Elasticsearch的请求,以及响应窗格,它显示对请求的响应。
图1.控制台UI
控制台以类似cURL的语法理解命令,例如,以下控制台命令:
GET /_search
{
"query": {
"match_all": {}
}
}
是对Elasticsearch的_search
API的简单GET
请求,这是cURL中的等效命令:
curl -XGET "http://localhost:9200/_search" -d'
{
"query": {
"match_all": {}
}
}'
实际上,你可以将上述命令粘贴到Console中,它将自动转换为Console语法。
键入命令时,Console将提供上下文相关的建议,这些建议可以帮助你探索每个API的参数,或者只是加快输入速度,控制台将建议API,索引和字段名称。
图2.API建议
在左窗格中键入命令后,可以通过单击请求的URL行旁边显示的绿色小三角形将其提交给Elasticsearch,请注意,当你移动光标时,小三角和扳手图标会跟随你,我们称之为操作菜单,你还可以选择多个请求并一次提交所有请求。
图3.操作菜单
当响应返回时,你应该在左侧面板中看到它。
图4.输出窗格
Console UI
在本节中,你将找到有关控制台UI的更详细说明,Console部分介绍了UI的基本方面。
多请求支持
控制台编辑器允许在彼此之下写入多个请求,如控制台部分所示,你可以通过定位光标并使用操作菜单向Elasticsearch提交请求,同样,你可以一次选择多个请求:
图5.选择多个请求
控制台将逐个发送请求到Elasticsearch,并在Elasticsearch响应时在右侧窗格中显示输出,在调试问题或在多个方案中尝试查询组合时,这非常方便。
选择多个请求还允许你自动格式化并一次性将它们复制为cURL。
自动格式化
控制台允许你自动格式化凌乱的请求,为此,请将光标置于要格式化的请求上,然后从操作菜单中选择Auto Indent:
图6.自动缩进请求
控制台将调整请求的JSON主体,现在看起来像这样:
图7.格式化的请求
如果在已完全格式化的请求上选择“自动缩进”,则控制台会将请求正文折叠为每个文档一行,使用Elasticsearch的批量API时,这非常方便:
图8.每行一个doc
键盘快捷键
控制台带有一组漂亮的键盘快捷键,使得使用它更加高效,这是一个概述:
一般编辑
快捷键 | 描述 |
---|---|
Ctrl/Cmd + I | 自动缩进当前请求 |
Ctrl + Space | 打开自动完成(即使没有打字) |
Ctrl/Cmd + Enter | 提交请求 |
Ctrl/Cmd + Up/Down | 跳转到上一个/下一个请求开始或结束 |
Ctrl/Cmd + Alt + L | 折叠/展开当前范围 |
Ctrl/Cmd + Option + 0 | 折叠所有范围但当前范围,通过添加shift进行扩展 |
当自动完成可见时
快捷键 | 描述 |
---|---|
Down arrow | 将焦点切换到自动完成菜单,使用箭头进一步选择一个术语 |
Enter/Tab | 在自动完成菜单中选择当前选定或最常用的术语 |
Esc | 关闭自动完成菜单 |
历史
控制台维护Elasticsearch成功执行的最近500个请求的列表,单击窗口右上角的时钟图标可以获得历史记录,图标将打开历史记录面板,你可以在其中查看旧请求,你也可以在此处选择一个请求,它将被添加到当前光标位置的编辑器中。
图9.历史面板
设置
控制台有多种设置可供你设置,所有这些都可以在Settings面板中找到,要打开面板,请单击右上角的Settings。
图10.设置面板
配置控制台
你可以在config/kibana.yml文件中添加以下选项:
console.enabled
- Default: true 设置为false以禁用控制台,切换这将导致服务器在下次启动时重新生成资产,这可能会导致页面开始服务之前的延迟。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。