Kibana｜How to develop Plugin for Kibana

環境配置

取得開發程式碼 Template

從官方 repo fork 至自已的 repo，並 clone 之：

git clone https://github.com/[YOUR_USERNAME]/kibana.git

安裝 nvm

在開發 plugin 時，為了整體程式碼的穩定性，相關的套件版本及開發引擎都需要符合要求，否則無法開發。透過 nvm 可以方便的切換到指定的 node version，例如：

nvm use 10.23.1

安裝 yarn

npm install --global yarn

切換 kibana repo 版本

ELK 本身對於版本的要求很嚴謹，所以開發 plugin 也需符合當前 Kibana 的版本，例如：

git checkout v7.12

初始化 kibana 並安裝相依套件

yarn kbn bootstrap

如果失敗可以試著清一下 cache

yarn kbn clean
yarn cache clean

啟動 kibana

因為 kibana 有很多模組，但不見得需要用到，可以用 oss 模式啟動，減少啟動時間。

yarn start --oss

建立 Kibana Plugin

產生 kibana plugin template code

node scripts/generate_plugin --name my_plugin_name -y

程式碼會產生於 plugins 目錄中

打包 kibana plugin

cd plugins/my_plugin_name
yarn build 

會產生 build 目錄並生成一個 my_plugin_name.zip 檔

安裝 Kibana plugin

# 移除舊有的 kibana plugin
bin/kibana-plugin remove apiTracing --allow-root
# 安裝 kibana plugin
bin/kibana-plugin install file:///root/my_plugin_name.zip --allow-root
# 重啟服務
systemctl restart kibana

以上步驟如可以正常執行無誤，即可以放心的開發屬於自已的 Kibana Plugin

有任何問題，或是想看新主題? 聯絡我們