菜单
开源

贡献 Loki

Loki 使用 GitHub 来管理拉取请求的评审

  • 如果您有简单的修复或改进,请直接创建拉取请求。
  • 如果您计划进行更复杂的工作,请在相关的 GitHub Issue 上讨论您的想法(如果不存在则创建一个新 Issue)。

贡献步骤

要为 Loki 贡献代码,您必须将其克隆到您的 $GOPATH 并添加您的 Fork 作为远程仓库。

bash
$ git clone https://github.com/grafana/loki.git $GOPATH/src/github.com/grafana/loki
$ cd $GOPATH/src/github.com/grafana/loki
$ git remote add fork <FORK_URL>

进行您的更改,将更改添加到 commit,并打开一个拉取请求 (PR)。

bash
$ git add .
$ git commit -m "docs: fix spelling error"
$ git push -u fork HEAD

注意

如果您使用 go get 下载了 Loki,消息 package github.com/grafana/loki: no Go files in /go/src/github.com/grafana/loki 是正常的,无需采取任何措施来解决。

构建

虽然 go install ./cmd/loki 可以工作,但首选的构建方式是使用 make

  • make loki: 构建 Loki 并将二进制文件输出到 ./cmd/loki/loki

  • make promtail: 构建 Promtail 并将二进制文件输出到 ./clients/cmd/promtail/promtail

  • make logcli: 构建 LogCLI 并将二进制文件输出到 ./cmd/logcli/logcli

  • make loki-canary: 构建 Loki Canary 并将二进制文件输出到 ./cmd/loki-canary/loki-canary

  • make docker-driver: 构建 Loki Docker Driver 并将其安装到 Docker 中。

  • make images: 构建所有 Docker 镜像(可以选择在前述二进制命令后添加 -image 后缀,例如 make loki-image)。

这些命令可以链式执行,一次构建多个二进制文件。以下示例构建 Loki、Promtail 和 LogCLI 的二进制文件。

bash
$ make loki promtail logcli

为 Helm Chart 贡献

官方 Loki Helm Chart 位于 Grafana Helm Charts Repo