入门指南
开始构建您自己的插件,或直接为 Kibana 仓库做贡献。
我们不再支持 Windows 原生开发,为了在 Windows 上开发 Kibana,请设置 WSL 环境,这将为您带来更好的体验。此外,您还可以受益于在 WSL 上运行 GUI 应用程序,例如用于测试和调试目的的 Chrome。完成后,请在 WSL 内部按照本指南的其余部分进行操作。
git clone https://github.com/[YOUR_USERNAME]/kibana.git kibana
cd kibana
安装 .node-version
文件中列出的 Node.js 版本。这可以通过诸如 nvm 或 avn 等工具进行自动化。由于我们还包含一个 .nvmrc
文件,因此在使用 nvm 时,您可以通过运行以下命令切换到正确的版本
nvm use
安装最新版本的 yarn v1。
引导 Kibana 并安装所有依赖项
yarn kbn bootstrap
如果您没有互联网连接,则 yarn kbn bootstrap
命令将会失败。由于您很可能在离线镜像中拥有所需的 node_modules,您可以尝试使用以下命令在离线模式下运行该步骤
yarn kbn bootstrap --offline
在您想要强制安装 node_modules 的任何其他情况下,您可以使用
yarn kbn bootstrap --force-install
您还可以运行 yarn kbn
来查看其他可用命令。
当切换使用不同 npm 包版本的分支时,您可能需要运行
yarn kbn clean
只有在极少数情况下,当出现问题时需要恢复一致状态时,才需要运行此命令。如果您经常需要运行此命令,请填写此表格以提供反馈:https://ela.st/yarn-kbn-clean
如果在 yarn kbn bootstrap
期间出现故障,则您的 yarn 缓存中可能有一些损坏的包,您可以使用以下命令进行清理
yarn cache clean
Kibana 是一个大型项目,对于某些命令,该过程可能会达到默认堆限制并因内存不足错误而崩溃。如果您遇到此问题,可以通过在命令行上设置 --max_old_space_size
选项来增加最大堆大小。要为所有命令设置限制,只需将以下行添加到您的 shell 配置中:export NODE_OPTIONS="--max_old_space_size=2048"
。
运行最新的 Elasticsearch 快照。 使用 --license
标志指定可选的许可证。
yarn es snapshot --license trial
trial
将使您可以访问所有功能。
阅读有关 在开发期间运行 Elasticsearch 的更多选项,例如连接到远程主机、从源代码运行、在运行之间保留数据、运行远程集群等。
在另一个终端窗口中,启动 Kibana。 通过添加可选的 --run-examples
标志,包含开发人员示例。
yarn start --run-examples
通过运行 yarn start --help
查看所有可用选项
阅读有关 运行 Kibana 的更多高级选项。
如果您想运行一些检查,例如 linting 或检查要提交的文件的文件大小写,我们提供了一种安装 pre-commit hook 的方法。 要配置它,您只需要运行以下命令
node scripts/register_git_hook
脚本完成后,将在文件 .git/hooks/pre-commit
中创建 pre-commit hook。 如果您选择不安装它,请不要担心,我们仍然会运行快速 CI 检查,以尽可能早地提供有关相同检查的反馈。
您现在可以开始开发了。 对文件的更改应会自动获取。 服务器端更改将导致 Kibana 服务器重新启动。