为 Kibana 做贡献
Kibana 是一个用于在 Elasticsearch 中搜索、可视化和分析数据的可插拔平台。你在 Kibana 中看到的大部分 UI 都是在插件内部构建的,并且该平台旨在进行扩展——既可以通过仓库内的插件,也可以通过仓库外开发的插件来扩展。
本文档分为五个部分。选择符合您需求的部分。
- 入门 — 设置本地环境、运行 Kibana 并构建您的第一个“Hello World”插件。
- 关键概念 — 在该平台上进行构建所需的心智模型和架构:插件 vs. 包 vs. 核心、生命周期、保存的对象 (saved objects)、安全性、性能、可嵌入对象 (embeddables) 等。
- 教程 — 针对常见插件开发任务(注册路由、配置插件、访问数据、添加日志等)的任务导向型实操演练。
- 测试 — Kibana 插件的测试金字塔:Jest 单元/集成测试,用于 UI 和 API 的 Scout (Playwright),以及旧版 FTR。
- 贡献 — 如何在 Kibana 仓库中工作:标准、Pull Request、CI、Linting、调试和构建。
- Kibana 开发新手? 请从 入门 开始,然后是 Hello World 插件。
- 在仓库之外基于该平台进行构建? 在设置好环境后,请参阅 外部插件开发指南。
- 想要执行特定任务? 直接跳转到 教程 并按类别查找。