在Windows环境下搭建kibana开发环境及开发插件

时间:2024-04-14 16:12:11

在Windows环境下搭建kibana开发环境及开发插件

最近项目中需要自定义kibana页面,参阅了很多博客,借鉴了如下几篇:
https://blog.****.net/qq_41882147/article/details/81120716
https://kibana.gitbook.io/kibana-plugin-development-tutorial/kuai-su-ru-men/appcha-jian-an-li
因为大多数服务器是部署在linux环境下,自己在Windows下踩了一些坑,搞了好几天时间,所以以此记录一下。

前提条件

  • kibana 源码包
  • es 安装包 及 es 运行环境(jdk1.8)
  • yarn
  • nodejs
  • git bash

我开发的是kibana6.3.2。本帖应该适用于kibana 6.3以上,未验证。

搭建开发环境

  1. 下载kibana 源码包,地址:地址:https://github.com/elastic/kibana;
    然后解压并进行重命名为 kibana,因为在后面安装插件的时候,匹配的文件名是 kibana,不然会安装插件失败。

  2. 在kibana源目录下,查看文件 .node-version 查看需要使用的node 版本号

  3. 下载并安装nodejs,要与 .node-version 中一致,在 cmd 执行 node -v ,看是否安装成功
    https://nodejs.org/zh-cn/download/releases/

  4. 下载最新的安装yarn,在 cmd 执行 yarn -v ,看是否安装成功(不同版本可能会有问题,不确定)
    https://github.com/yarnpkg/yarn/tags?after=v1.7.0

  5. 下载Git,选择最新的版本安装即可,将 git/bin 加入环境变量
    在Windows环境下搭建kibana开发环境及开发插件
    在Windows环境下搭建kibana开发环境及开发插件

  6. 安装依赖包
    Cmd 命令进入kibana目录,先执行 git init ,再执行 yarn kbn bootstrap ,等待执行完成。
    在Windows环境下搭建kibana开发环境及开发插件

  7. 安装插件
    先启动es,然后使用kibana内置的插件模板生成插件。
    执行 node scripts/generate_plugin <my_plugin_name>
    在Windows环境下搭建kibana开发环境及开发插件
    在Windows环境下搭建kibana开发环境及开发插件
    输入的版本号要与kibana一致。

在Windows环境下搭建kibana开发环境及开发插件
安装完成,按照命令提示 依次输入 cd "..\kibana-extra\my_pluggin" yarn start

kibana 正常启动后,访问网页。
在Windows环境下搭建kibana开发环境及开发插件

插件的打包
进入插件目录 cd "..\kibana-extra\my_pluggin",执行 yarn build
在kibana-extra\my_pluggin\build 文件夹 下可以看到插件压缩包
在Windows环境下搭建kibana开发环境及开发插件

安装插件

1.用kibana命令安装
在kibana/bin目录下执行kibana-plugin installl file:///D:/k/kibana/plugins/app/build/app-0.0.0.zip,其中D:/k/kibana/plugins/app/build/app-0.0.0.zip为压缩包地址
重启后会optimize,如果太慢,
改一下 bin目录下的 kibana文件,修改最后一行
NODE_ENV=production exec "${NODE}" $NODE_OPTIONS --max_old_space_size=3072 --no-warnings "${DIR}/src/cli" ${@}

  1. 直接解压安装

将插件压缩包解压到要安装的kibana/pluggin 目录,解压后路径会目录存在多级,插件会访问不到的,
在Windows环境下搭建kibana开发环境及开发插件
只保存my-pluggin

踩到的坑

a) 错误1

Error: Spawn git enoent

在Windows环境下搭建kibana开发环境及开发插件
解决方案:下载 安装 Git

b) 错误2

Error fatal: not a git repository

在Windows环境下搭建kibana开发环境及开发插件
解决方案:执行 git init 重新执行yarn kbn bootstrap

c) 错误3

Error: ‘sh’不是内部或外部命令
解决方案:将git/bin 加入环境变量