Dev Lake

English	中文

什么是 Dev Lake？

Dev Lake 是一个研发效能分析平台，它通过对软件开发生命周期（SDLC）中产生的数据进行 整合、分析和可视化 ，提升研发效能。

为什么选择 Dev Lake？

支持各种数据源(Gitlab, Jira)，而且还在不断增加
相关的、可定制的数据指标，可随时作为可视化图表查看
利用 Grafana 轻松构建和查看新的图表和仪表盘
易于通过 Docker 进行设置
可扩展的插件系统，可添加您自己的数据采集器
专为处理企业规模的数据而设计

内容

目录	描述	文档链接
数据源	链接到具体的插件使用和细节	查看本节
用户设置	以用户身份运行项目的步骤	查看本节
开发者设置	如何设置开发环境	查看本节
测试	运行测试的命令	查看本节
Grafana	如何将数据进行可视化	查看本节
添加一个插件	如何制作自己的插件的详细信息	链接
添加新的指标	如何给插件添加指标	链接
贡献	如何进行贡献	链接

我们目前支持的数据源

下面是一个 数据源插件（data source plugins） 的列表，用于收集和处理特定来源的数据。每个插件都有一个 README.md 文件，包含基本设置、故障排除和指标信息。

关于建立一个新的 data source plugins 的更多信息，请参见添加一个插件。

目录	内容	文档
Jira	指标，生成 API Token，查找项目/看板ID，配置事务状态和字段名称	Link
Gitlab	指标，生成 API Token	Link
Jenkins	指标，生成 API Token	Link

用户设置

注意：如果你只打算运行 Dev Lake，你只需要阅读这一小节
注意：写成 这样 的命令需要在你的终端中运行

需要安装的软件包

NOTE: 安装完 Docker 后，你可能需要运行 Docker 应用程序并重新启动你的终端

在你的终端中运行的命令

克隆仓库

git clone https://github.com/merico-dev/lake.git devlake
cd devlake
cp .env.example .env

启动 Docker，然后运行 docker-compose up config-ui 来启动配置界面。

关于如何配置插件的更多信息，请参考数据源插件部分

访问 localhost:4000 来设置配置文件
运行 docker-compose up -d 来启动其他服务
访问 localhost:4000/triggers 以运行插件的收集触发器

请替换请求正文中的 gitlab projectId 和 jira boardId。对于大型项目，这可能需要20分钟。 (Gitlab 10k+ commits 或 Jira 5k+ 事务)

完成后，点击 Go to grafana (用户名: admin, 密码: admin)

设置 Cron job

通常情况下，我们有定期同步数据的要求。我们提供了一个叫做 lake-cli 的工具来满足这个要求。请在这里查看 lake-cli 的用法。

除此之外，如果你只想使用 Cron job，请在这里查看 docker-compose 版本。

开发者设置

前期准备

Docker
Golang
Make
- Mac (Already installed)
- Windows: Download
- Ubuntu: sudo apt-get install build-essential

如何设置开发环境

进入你想安装本项目的路径，并克隆资源库

git clone https://github.com/merico-dev/lake.git
cd lake

安装 go packages
```
make install
```
将样本配置文件复制到新的本地文件
```
cp .env.example .env
```
启动 Docker
确保在此步骤之前 Docker 正在运行。
```
make compose
```
运行项目
```
make dev
```

发送请求到 /task，创建一个 Jira 任务。这将从 Jira 收集数据

curl -XPOST 'localhost:8080/task' \
-H 'Content-Type: application/json' \
-d '[{
    "plugin": "jira",
    "options": {
        "boardId": 8
    }
}]'

在Grafana仪表板中实现数据的可视化
从这里你可以看到丰富的图表，这些图表来自于收集和处理后的数据
- 导航到 http://localhost:3002 (用户名: admin, 密码: admin)
- 你也可以创建/修改现有的/保存到 Dev lake 中的仪表板
- 关于在Dev Lake中使用Grafana的更多信息，请看 Grafana 文档

测试

运行测试: make test

Grafana

我们使用 Grafana 作为可视化工具，为存储在我们数据库中的数据建立图表。可以使用SQL查询，添加面板来构建、保存和编辑自定义仪表盘。

关于配置和定制仪表盘的所有细节可以在 Grafana 文档中找到。

贡献

CONTRIBUTING.md

需要帮助?

在 Discord 上给我们发消息