Contributing to Loki
Loki uses GitHub to manage reviews of pull requests:
- If you have a trivial fix or improvement, go ahead and create a pull request.
- If you plan to do something more involved, discuss your ideas on the relevant GitHub issue (creating one if it doesn’t exist).
Steps to contribute
To contribute to Loki, you must clone it into your
$GOPATH and add your fork
as a remote.
$ 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> # Make some changes! $ git add . $ git commit -m "docs: fix spelling error" $ git push -u fork HEAD # Open a PR!
Note that if you downloaded Loki using
go get, the message
package github.com/grafana/loki: no Go files in /go/src/github.com/grafana/loki
is normal and requires no actions to resolve.
go install ./cmd/loki works, the preferred way to build is by using
make loki: builds Loki and outputs the binary to
make promtail: builds Promtail and outputs the binary to
make logcli: builds LogCLI and outputs the binary to
make loki-canary: builds Loki Canary and outputs the binary to
make docker-driver: builds the Loki Docker Driver and installs it into Docker.
make images: builds all Docker images (optionally suffix the previous binary commands with
These commands can be chained together to build multiple binaries in one go:
# Builds binaries for Loki, Promtail, and LogCLI. $ make loki promtail logcli
Contribute to the Helm Chart
Please follow the Helm documentation.