入门
编辑入门
编辑开始构建您自己的插件,或直接为 Kibana 代码库做贡献。
在 Windows 上开发
编辑我们不再支持 Windows 原生开发,为了在 Windows 上开发 Kibana,请设置 WSL 环境,这将给您带来更好的体验。除此之外,您还将受益于在 WSL 上运行 GUI 应用程序,例如用于测试和调试的 Chrome。完成后,请在 WSL 内遵循本指南的其余部分。
获取代码
编辑Fork,然后克隆 Kibana 代码库,并将目录更改到该代码库中
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
可能会使用 Node.js 原生模块,而 node-gyp 是用于构建它们的工具。您需要为每个平台安装工具,并使用特定的 Python 版本。请参阅 https://github.com/nodejs/node-gyp#installation,并根据您的平台遵循该指南。
如果您没有互联网连接,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
配置环境设置
编辑增加 node.js 堆大小
编辑Kibana 是一个大型项目,对于某些命令,进程可能会达到默认的堆限制,并因内存不足错误而崩溃。如果遇到此问题,您可以通过在命令行中设置 --max_old_space_size
选项来增加最大堆大小。要为所有命令设置限制,只需将以下行添加到您的 shell 配置中:export NODE_OPTIONS="--max_old_space_size=2048"
。
运行 Elasticsearch
编辑运行最新的 Elasticsearch 快照。使用 --license
标志指定可选的许可证。
yarn es snapshot --license trial
trial
将使您可以访问所有功能。
阅读有关开发期间运行 Elasticsearch的更多选项,例如连接到远程主机、从源代码运行、在运行之间保留数据、运行远程集群等。
运行 Kibana
编辑在另一个终端窗口中,启动 Kibana。通过添加可选的 --run-examples
标志来包含开发人员示例。
yarn start --run-examples
通过运行 yarn start --help
查看所有可用选项
阅读有关运行 Kibana的更多高级选项。
安装 pre-commit 钩子(可选)
编辑如果您想运行一些检查,例如 linting 或检查要提交的文件的文件大小写,我们提供了一种安装 pre-commit 钩子的方法。要配置它,您只需运行以下命令
node scripts/register_git_hook
脚本完成后,pre-commit 钩子将在文件 .git/hooks/pre-commit
内创建。如果您选择不安装它,请不要担心,我们仍然会运行快速 CI 检查,以便尽早提供有关相同检查的反馈。
开始编码!
编辑现在您可以开始开发了。对文件的更改应会自动拾取。服务器端更改将导致 Kibana 服务器重新启动。