Querying Loki with LogCLI

If you prefer a command line interface, LogCLI also allows users to run LogQLqueries against a Loki server.

Installation

Binary (Recommended)

Navigate to the Loki Releases pageand download the logcli binary for your OS:

  1. # download a binary (adapt app, os and arch as needed)
  2. # installs v0.3.0. For up to date URLs refer to the release's description
  3. $ curl -fSL -o "/usr/local/bin/logcli.gz" "https://github.com/grafana/logcli/releases/download/v0.3.0/logcli-linux-amd64.gz"
  4. $ gunzip "/usr/local/bin/logcli.gz"
  6. # make sure it is executable
  7. $ chmod a+x "/usr/local/bin/logcli"

From source

Use go get to install logcli to $GOPATH/bin:

  1. $ go get github.com/grafana/loki/cmd/logcli

Usage

Example

If you are running on Grafana Cloud, use:

  1. $ export GRAFANA_ADDR=https://logs-us-west1.grafana.net
  2. $ export GRAFANA_USERNAME=<username>
  3. $ export GRAFANA_PASSWORD=<password>

Otherwise you can point LogCLI to a local instance directlywithout needing a username and password:

  1. $ export GRAFANA_ADDR=http://localhost:3100

Note: If you are running Loki behind a proxy server and you haveauthentication configured, you will also have to pass in GRAFANA_USERNAMEand GRAFANA_PASSWORD accordingly.

  1. $ logcli labels job
  2. https://logs-dev-ops-tools1.grafana.net/api/prom/label/job/values
  3. cortex-ops/consul
  4. cortex-ops/cortex-gw
  5. ...
  7. $ logcli query '{job="cortex-ops/consul"}'
  8. https://logs-dev-ops-tools1.grafana.net/api/prom/query?query=%7Bjob%3D%22cortex-ops%2Fconsul%22%7D&limit=30&start=1529928228&end=1529931828&direction=backward&regexp=
  9. Common labels: {job="cortex-ops/consul", namespace="cortex-ops"}
  10. 2018-06-25T12:52:09Z {instance="consul-8576459955-pl75w"} 2018/06/25 12:52:09 [INFO] raft: Snapshot to 475409 complete
  11. 2018-06-25T12:52:09Z {instance="consul-8576459955-pl75w"} 2018/06/25 12:52:09 [INFO] raft: Compacting logs from 456973 to 465169

Configuration

Configuration values are considered in the following order (lowest to highest):

  • Environment variables
  • Command line flags

Details

  1. $ logcli help
  2. usage: logcli [<flags>] <command> [<args> ...]
  4. A command-line for loki.
  6. Flags:
  7.       --help             Show context-sensitive help (also try --help-long and --help-man).
  8.   -q, --quiet            suppress everything but log lines
  9.   -o, --output=default   specify output mode [default, raw, jsonl]
  10.       --addr="https://logs-us-west1.grafana.net"
  11.                          Server address.
  12.       --username=""      Username for HTTP basic auth.
  13.       --password=""      Password for HTTP basic auth.
  14.       --ca-cert=""       Path to the server Certificate Authority.
  15.       --tls-skip-verify  Server certificate TLS skip verify.
  16.       --cert=""          Path to the client certificate.
  17.       --key=""           Path to the client certificate key.
  19. Commands:
  20.   help [<command>...]
  21.     Show help.
  23.   query [<flags>] <query> [<regex>]
  24.     Run a LogQL query.
  26.   labels [<label>]
  27.     Find values for a given label.
  29. $ logcli help query
  30. usage: logcli query [<flags>] <query> [<regex>]
  32. Run a LogQL query.
  34. Flags:
  35.       --help             Show context-sensitive help (also try --help-long and --help-man).
  36.   -q, --quiet            suppress everything but log lines
  37.   -o, --output=default   specify output mode [default, raw, jsonl]
  38.       --addr="https://logs-us-west1.grafana.net"
  39.                          Server address.
  40.       --username=""      Username for HTTP basic auth.
  41.       --password=""      Password for HTTP basic auth.
  42.       --ca-cert=""       Path to the server Certificate Authority.
  43.       --tls-skip-verify  Server certificate TLS skip verify.
  44.       --cert=""          Path to the client certificate.
  45.       --key=""           Path to the client certificate key.
  46.       --limit=30         Limit on number of entries to print.
  47.       --since=1h         Lookback window.
  48.       --from=FROM        Start looking for logs at this absolute time (inclusive)
  49.       --to=TO            Stop looking for logs at this absolute time (exclusive)
  50.       --forward          Scan forwards through logs.
  51.   -t, --tail             Tail the logs
  52.       --delay-for=0      Delay in tailing by number of seconds to accumulate logs for re-ordering
  53.       --no-labels        Do not print any labels
  54.       --exclude-label=EXCLUDE-LABEL ...
  55.                          Exclude labels given the provided key during output.
  56.       --include-label=INCLUDE-LABEL ...
  57.                          Include labels given the provided key during output.
  58.       --labels-length=0  Set a fixed padding to labels
  60. Args:
  61.   <query>    eg '{foo="bar",baz="blip"}'
  62.   [<regex>]