附加的功能在 Kibana 中是以插件的形式提供的。您可以利用 bin/kibana-plugin 命令來管理這些模塊。您也可以手動安裝這些插件,只需要將這些插件包放到 plugins 目錄並解壓到新的目錄就可以了。
插件兼容性
Kibana 插件接口在不斷的發展變化。由於插件更新很快,因此很難向后兼容。Kibana 強制要求安裝的插件版本必須和 Kibana 版本一致。插件開發者必須為每個新的 Kibana 版本發布新的插件版本。
安裝插件
使用以下命令安裝插件:
bin/kibana-plugin install <package name or URL>
當您指定的插件名沒有帶 URL,插件工具將會嘗試去下載 Elastic 官方插件。例如:
$ bin/kibana-plugin install x-pack
通過指定的 URL 地址安裝插件
您可以簡單的指定插件名稱來下載 Elastic 官方插件。也可以指定插件具體的 URL 來下載安裝,例如:
$ bin/kibana-plugin install https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-6.0.0.zip
您可以在 URL 中指定多種協議,例如 HTTP 、 HTTPS 或者 文件
協議。
向指定的目錄安裝插件
在 install
命令后面通過 -d
或者 --plugin-dir
選項指定插件安裝目錄,例如:
$ bin/kibana-plugin install file:///some/local/path/x-pack.zip -d path/to/directory
如果目錄不存在,這條命令會創建這個目錄。
通過 Linux 安裝包安裝插件
Kibana 服務需要有 optimize
目錄的寫權限。如果您使用 sudo 或者 su 安裝插件,您需要確保這些命令使用 kibana
用戶執行。這個用戶已經默認為您添加了,它用於包的安裝。
$ sudo -u kibana bin/kibana-plugin install x-pack
如果插件使用了不同的用戶安裝且服務又沒有運行起來,您就需要修改這些文件的所屬用戶:
$ chown -R kibana:kibana /path/to/kibana/optimize
升級和移除插件
通過刪除當前版本重裝新的插件來升級插件。
通過 remove 命令來刪除插件:
$ bin/kibana-plugin remove x-pack
您也可以通過手動刪除 plugins/ 目錄下的插件子目錄來手動刪除插件。
刪除插件之后將會在下一次 Kibana 啟動的時候觸發一次 “優化(optimize)” 動作,可能會使啟動有點延遲。
關閉插件
使用如下命令來關閉插件:
./bin/kibana --<plugin ID>.enabled=false
關閉或打開插件將會在下一次 Kibana 啟動的時候觸發一次 “優化(optimize)” 動作,可能會使啟動有點延遲。
您可以在
package.json
文件中通過name
屬性查看插件的 ID。
配置插件管理器
默認情況下,插件管理器會為您的插件管理動作做出信息反饋。您可以通過添加 --quiet
和 --silent
選項為 install
和 remove
命令控制反饋信息的級別。使用 --quiet
選項屏蔽除錯誤信息以外的日志輸出。使用 --silent
選項屏蔽所有輸出。
默認情況下,插件管理器安裝插件不會超時。使用 --timeout
選項並添加一個時間來指定安裝超時時間:
設定30秒安裝超時.
bin/kibana-plugin install --timeout 30s sample-plugin
設定1分鍾安裝超時.
bin/kibana-plugin install --timeout 1m sample-plugin
插件及自定義 Kibana 的配置
在 install
和 remove
命令中使用 -c
或者 --config
選項來指定啟動 Kibana 的配置文件的路徑。默認情況下,Kibana 使用 config/kibana.yml
配置文件。當您需要修改已安裝好的插件配置時,使用 bin/kibana-plugin
命令來重啟 Kibana 服務。當您使用自定義的配置文件時,每次使用 bin/kibana-plugin
命令必須指定配置文件的路徑。
插件管理器退出代碼
0 | 成功 |
---|---|
64 | 未知命令或錯誤的參數 |
74 | I/O 錯誤 |
70 | 其它錯誤 |
已知的插件
插件兼容性
Kibana 插件接口一直在不斷發展中,由於變化太快我們無法為插件提供向后的兼容性。Kibana 會強制要安裝的插件與 Kibana 當前版本相匹配。因此,插件的開發者需要不斷為每個 Kibana 的新版本發布他們所提供插件的新版本。
包
- X-Pack - 安全、監控、報告、告警、圖形
應用
- LogTrail - 為開發者/系統管理員提供實時查看、分析、搜索事件的易用接口
- Own Home (wtakase) - 支持多租戶
- Shard Allocation (asileon) - 可視化 elasticsearch 分片的分配
Timelion 擴展
- mathlion (fermiumlabs) - 為 Timelion 增加方程解析和高數能力
可視化組件
- Swimlanes (prelert)
- Line (sbeyn)
- Gauge (sbeyn)
- Traffic (sbeyn)
- 3D Graph (JuanCarniglia)
- Enhanced Tilemap (nreese)
- Network Plugin (dlumbrer)
- C3JS Visualizations (mstoyano)
- Health Metric (clamarque)
- Extended Metric (ommsolutions)
- 3D Charts (virusu)
- Colored Metric Visualization (deanf)
- Cohort analysis (elo7)
- Percent (amannocci)
- Funnel Visualization (roybass)
- Transform Visualization (PhaedrusTheGreek)
- Search-Tables (dlumbrer)
其他
- Time picker as a dashboard panel 可以在儀表板內查看和編輯時間范圍的小組件
如果您希望將您的插件也添加到此頁面,請打開 pull request。