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.
Building
While go install ./cmd/loki
works, the preferred way to build is by using
make
:
-
make loki
: builds Loki and outputs the binary to./cmd/loki/loki
-
make promtail
: builds Promtail and outputs the binary to./cmd/promtail/promtail
-
make logcli
: builds LogCLI and outputs the binary to./cmd/logcli/logcli
-
make loki-canary
: builds Loki Canary and outputs the binary to./cmd/loki-canary/loki-canary
-
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-image
, e.g.,make loki-image
).
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
The official Loki helm charts can be found in the Grafana Helm Charts Repo.
Related Loki resources
Getting started with logging and Grafana Loki (APAC timezone)
Join this webinar to learn why correlating metrics and logs is critical across the development lifecycle, and how Loki helps reduce logging costs and operations overhead.
Logging with Loki: Essential configuration settings
This webinar focuses on Grafana Loki configuration including agents Promtail and Docker; the Loki server; and Loki storage for popular backends.
Observability with logs & Grafana
Discover how you can utilize, manage, and visualize log events with Grafana and Grafana’s logging application Loki.