› ›

入门

入门编辑

开始构建您自己的插件，或直接为 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 服务器重新启动。

入门