控制台插件提供一個用戶界面來和 Elasticsearch 的 REST API 交互。控制台有兩個主要部分: editor ,用來編寫提交給 Elasticsearch 的請求; response 面板,用來展示請求結果的響應。在頁面頂部的文本框中輸入 Elasticsearch 服務器的地址。默認地址是:“localhost:9200”。
控制台可以解析像 cURL 命令這樣的語句。例如以下控制台命令
GET /_search
{
"query": {
"match_all": {}
}
}
是 Elasticsearch _search API 的簡單 GET 請求。下面是同樣效果的 cURL 命令。
curl -XGET "http://localhost:9200/_search" -d'
{
"query": {
"match_all": {}
}
}'
實際上,您可以復制粘貼上面的命令到控制台,它會自動轉換成控制台語句。
當敲入一行命令,控制台會給出上下文相關的提示。這些提示可以幫助您探索每條 API 參數,或者用於提高輸入速度。控制台會提示 APIs 、索引和字段名。
一旦您在左邊的面板中敲入命令,您可以點擊 URL 行邊上的綠色小三角提交這條請求到 Elasticsearch。注意,當您移動光標的時候,會有一個小三角和扳手圖標跟隨着您。我們把這個叫做動作菜單。您也可以選擇寫多條請求並一起提交它們。
當請求響應后,您可以在側面的面板中看到它
多請求支持
控制台編輯器允許您編寫相互層疊的多個請求,像在控制台章節展示中那樣,您可以通過定位光標並使用動作菜單向 Elasticsearch 提交請求。類似的,您可以一次選擇多個請求
控制台會依次提交請求到 Elasticsearch ,並將 Elasticsearch 返回的結果顯示在右邊窗口。這在調試問題或在多個場景中嘗試查詢組合時會非常方便。
選擇多個請求還允許您自動格式化並將其復制為 cURL 命令。
自動格式化
控制台允許您自動格式化復雜的請求。為此,請將光標置於您想格式化的請求上,並從操作菜單中選擇自動縮進,控制台將調整請求的 JSON 體.
如果在已完全格式化的請求上選擇自動縮進,控制台將把每個文檔的請求體折疊到一行,這在使用 Elasticsearch 的批量 API 的時候會非常方便。
鍵盤快捷鍵
控制台配備了一套非常方便的鍵盤快捷鍵,使其工作效率更高。下面是一段概述:
一般編輯
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個請求列表。點擊窗口右上角的時鍾圖標即可查看歷史記錄。這個圖標會打開歷史記錄面板,您可以在其中查看歷史請求。您也可以在這里選擇一個請求,它將被添加到編輯器中當前光標所在的位置。
設置
控制台有很多設置,這些設置都可以在控制面板中找到。點擊右上角的齒輪按鈕就能打開設置面板。
配置控制台
您可以在 config/kibana.yml 文件中添加以下配置:
console.enabled
默認: true 。設置為 false 以禁用控制台。切換此配置將導致服務器在下次啟動時重新生成資源,這可能會造成頁面開始服務之前有些延遲。