apitech
/
loki
mirror of https://github.com/grafana/loki
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Like Prometheus, but for logs.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1589 Commits
1063 Branches
354 Tags
711 MiB
Tag: Branch: Tree: ae33258aca
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ae33258aca'
${ noResults }
loki/docs/sources/getting-started/logcli.md

266 lines
13 KiB
Raw Normal View History Unescape

Sync docs to website (#2378) * update docs location * add workflow * update docs content * update content * cleanup
5 years ago
---
title: LogCLI
---
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
# Querying Loki with LogCLI
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
If you prefer a command line interface, LogCLI also allows users to run LogQL
queries against a Loki server.
Update logcli doc Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
## Installation
docs: general documentation rework - restructures the docs to make them easier to explore - rewrites promtail docs - unifies, shortens and extends docs
6 years ago
### Binary (Recommended)
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
simplify the release page and instructions on installing and working with binaries to remove our opinionated installation path. (#1290)
6 years ago
Every release includes binaries for `logcli` which can be found on the
[Releases page](https://github.com/grafana/loki/releases).
Update logcli doc Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
docs: general documentation rework - restructures the docs to make them easier to explore - rewrites promtail docs - unifies, shortens and extends docs
6 years ago
### From source
Update logcli doc Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
Use `go get` to install `logcli` to `$GOPATH/bin`:
Update logcli doc Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
```
docs: general documentation rework - restructures the docs to make them easier to explore - rewrites promtail docs - unifies, shortens and extends docs
6 years ago
$ go get github.com/grafana/loki/cmd/logcli
Update logcli doc Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
```
## Usage
### Example
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
If you are running on Grafana Cloud, use:
```bash
logcli: replaced GRAFANA_* with LOKI_* in logcli env vars, set default server url for logcli to localhost (#1492) * replaced GRAFANA_* with LOKI_* in logcli env vars, set default server url for logcli to localhost * add env var details in help text of logcli
6 years ago
$ export LOKI_ADDR=https://logs-us-west1.grafana.net
$ export LOKI_USERNAME=<username>
$ export LOKI_PASSWORD=<password>
docs(logcli): clarify usage of GRAFANA_ADDR (#822) Adds an example of how to setup the `GRAFANA_ADDR` environment variable when not using Grafana Cloud but rather a local or otherwise hosted instance of Loki
6 years ago
```
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
Otherwise you can point LogCLI to a local instance directly
without needing a username and password:
```bash
logcli: replaced GRAFANA_* with LOKI_* in logcli env vars, set default server url for logcli to localhost (#1492) * replaced GRAFANA_* with LOKI_* in logcli env vars, set default server url for logcli to localhost * add env var details in help text of logcli
6 years ago
$ export LOKI_ADDR=http://localhost:3100
docs(logcli): clarify usage of GRAFANA_ADDR (#822) Adds an example of how to setup the `GRAFANA_ADDR` environment variable when not using Grafana Cloud but rather a local or otherwise hosted instance of Loki
6 years ago
```
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
> Note: If you are running Loki behind a proxy server and you have
logcli: replaced GRAFANA_* with LOKI_* in logcli env vars, set default server url for logcli to localhost (#1492) * replaced GRAFANA_* with LOKI_* in logcli env vars, set default server url for logcli to localhost * add env var details in help text of logcli
6 years ago
> authentication configured, you will also have to pass in LOKI_USERNAME
> and LOKI_PASSWORD accordingly.
docs(logcli): clarify usage of GRAFANA_ADDR (#822) Adds an example of how to setup the `GRAFANA_ADDR` environment variable when not using Grafana Cloud but rather a local or otherwise hosted instance of Loki
6 years ago
docs: general documentation rework - restructures the docs to make them easier to explore - rewrites promtail docs - unifies, shortens and extends docs
6 years ago
```bash
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
$ logcli labels job
https://logs-dev-ops-tools1.grafana.net/api/prom/label/job/values
cortex-ops/consul
cortex-ops/cortex-gw
...
docs: general documentation rework - restructures the docs to make them easier to explore - rewrites promtail docs - unifies, shortens and extends docs
6 years ago
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
$ logcli query '{job="cortex-ops/consul"}'
Documentation Rewrite (#982) * docs: create structure of docs overhaul This commit removes all old docs and lays out the table of contents and framework for how the new documentation will be intended to be read. * docs: add design docs back in * docs: add community documentation * docs: add LogQL docs * docs: port existing operations documentation * docs: add new placeholder file for promtail configuration docs * docs: add TOC for operations/storage * docs: add Loki API documentation * docs: port troubleshooting document * docs: add docker-driver documentation * docs: link to configuration from main docker-driver document * docs: update API for new paths * docs: fix broken links in api.md and remove json marker from examples * docs: incorporate api changes from #1009 * docs: port promtail documentation * docs: add TOC to promtail configuration reference * docs: fix promtail spelling errors * docs: add loki configuration reference * docs: add TOC to configuration * docs: add loki configuration example * docs: add Loki overview with brief explanation about each component * docs: add comparisons document * docs: add info on table manager and update storage/README.md * docs: add getting started * docs: incorporate config yaml changes from #755 * docs: fix typo in releases url for promtail * docs: add installation instructions * docs: add more configuration examples * docs: add information on fluentd client fluent-bit has been temporarily removed until the PR for it is merged. * docs: PR review feedback * docs: add architecture document * docs: add missing information from old docs * `localy` typo Co-Authored-By: Ed Welch <ed@oqqer.com> * docs: s/ran/run/g * Typo * Typo * Tyop * Typo * docs: fixed typo * docs: PR feedback * docs: @cyriltovena PR feedback * docs: add more details to promtail url config option * docs: expand promtail's pipelines document with extra detail * docs: remove reference to Stage interface in pipelines.md * docs: fixed some spelling * docs: clarify promtail configuration and scraping * docs: attempt #2 at explaining promtail's usage of machine hostname * docs: spelling fixes * docs: add reference to promtail custom metrics and fix silly typo * docs: cognizant -> aware * docs: typo * docs: typos * docs: add which components expose which API endpoints in microservices mode * docs: change ksonnet installation to tanka * docs: address most @pracucci feedback * docs: fix all spelling errors so reviewers don't have to keep finding them :) * docs: incorporate changes to API endpoints made in #1022 * docs: add missing loki metrics * docs: add missing promtail metrics * docs: @pstribrany feedback * docs: more @pracucci feedback * docs: move metrics into a table * docs: update push path references to /loki/api/v1/push * docs: add detail to further explain limitations of monolithic mode * docs: add alternative names to modes_of_operation diagram * docs: add log ordering requirement * docs: add procedure for updating docs with latest version * docs: separate out stages documentation into one document per stage * docs: list supported stores in storage documentation * docs: add info on duplicate log lines in pipelines * docs: add line_format as key feature to fluentd * docs: hopefully final commit :)
6 years ago
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=
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Common labels: {job="cortex-ops/consul", namespace="cortex-ops"}
2018-06-25T12:52:09Z {instance="consul-8576459955-pl75w"} 2018/06/25 12:52:09 [INFO] raft: Snapshot to 475409 complete
2018-06-25T12:52:09Z {instance="consul-8576459955-pl75w"} 2018/06/25 12:52:09 [INFO] raft: Compacting logs from 456973 to 465169
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
...
$ logcli series -q --match='{namespace="loki",container_name="loki"}'
{app="loki", container_name="loki", controller_revision_hash="loki-57c9df47f4", filename="/var/log/pods/loki_loki-0_8ed03ded-bacb-4b13-a6fe-53a445a15887/loki/0.log", instance="loki-0", job="loki/loki", name="loki", namespace="loki", release="loki", statefulset_kubernetes_io_pod_name="loki-0", stream="stderr"}
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
```
Update logcli doc Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
### Configuration
cmd/logcli: support load config from file Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
Configuration values are considered in the following order (lowest to highest):
impr/clients: Handle TLS config and MTLS for logcli and promtail (#540) * impr/clients: Handle TLS config and MTLS for logcli and promtail * fix/tls: Please gofmt... * impr/clients: use prometheus HTTPClientConfig for logcli and promtail * fix/promtail: Set proper Client config name * impr/promtail: Use prometheus HTTPClientConfig configuration * adapt with master * address review * fix conflicts * address requested changes * remove file Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>
7 years ago
docs: general documentation rework - restructures the docs to make them easier to explore - rewrites promtail docs - unifies, shortens and extends docs
6 years ago
- Environment variables
- Command line flags
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
fix small language issue Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
### Details
Update logcli doc Signed-off-by: Xiang Dai <764524258@qq.com>
7 years ago
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
```nohighlight
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
$ logcli help
usage: logcli [<flags>] <command> [<args> ...]
A command-line for loki.
Flags:
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
--help Show context-sensitive help (also try --help-long and --help-man).
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
--version Show application version.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
-q, --quiet Suppress query metadata
--stats Show query statistics
-o, --output=default Specify output mode [default, raw, jsonl]. raw suppresses log labels and timestamp.
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
-z, --timezone=Local Specify the timezone to use when formatting output timestamps [Local, UTC]
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--cpuprofile="" Specify the location for writing a CPU profile.
--memprofile="" Specify the location for writing a memory profile.
--addr="http://localhost:3100"
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
Server address. Can also be set using LOKI_ADDR env var.
--username="" Username for HTTP basic auth. Can also be set using LOKI_USERNAME env var.
--password="" Password for HTTP basic auth. Can also be set using LOKI_PASSWORD env var.
--ca-cert="" Path to the server Certificate Authority. Can also be set using LOKI_CA_CERT_PATH env var.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--tls-skip-verify Server certificate TLS skip verify.
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
--cert="" Path to the client certificate. Can also be set using LOKI_CLIENT_CERT_PATH env var.
--key="" Path to the client certificate key. Can also be set using LOKI_CLIENT_KEY_PATH env var.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--org-id="" adds X-Scope-OrgID to API requests for representing tenant ID. Useful for requesting tenant data when
bypassing an auth gateway.
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Commands:
help [<command>...]
Show help.
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
query [<flags>] <query>
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Run a LogQL query.
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
The "query" command is useful for querying for logs. Logs can be returned in a few output modes:
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
raw: log line
default: log timestamp + log labels + log line
jsonl: JSON response from Loki API of log line
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
The output of the log can be specified with the "-o" flag, for example, "-o raw" for the raw output format.
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
The "query" command will output extra information about the query and its results, such as the API URL, set of common labels,
and set of excluded labels. This extra information can be suppressed with the --quiet flag.
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
While "query" does support metrics queries, its output contains multiple data points between the start and end query time.
This output is used to build graphs, like what is seen in the Grafana Explore graph view. If you are querying metrics and just
want the most recent data point (like what is seen in the Grafana Explore table view), then you should use the "instant-query"
command instead.
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
instant-query [<flags>] <query>
Run an instant LogQL query.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
The "instant-query" command is useful for evaluating a metric query for a single point in time. This is equivalent to the
Grafana Explore table view; if you want a metrics query that is used to build a Grafana graph, you should use the "query"
command instead.
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
This command does not produce useful output when querying for log lines; you should always use the "query" command when you
are running log queries.
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
For more information about log queries and metric queries, refer to the LogQL documentation:
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
https://github.com/grafana/loki/blob/master/docs/logql.md
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
labels [<flags>] [<label>]
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Find values for a given label.
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
series --match=MATCH [<flags>]
Run series query.
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
$ logcli help query
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
usage: logcli query [<flags>] <query>
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Run a LogQL query.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
The "query" command is useful for querying for logs. Logs can be returned in a few output modes:
raw: log line
default: log timestamp + log labels + log line
jsonl: JSON response from Loki API of log line
The output of the log can be specified with the "-o" flag, for example, "-o raw" for the raw output format.
The "query" command will output extra information about the query and its results, such as the API URL, set of common labels, and
set of excluded labels. This extra information can be suppressed with the --quiet flag.
While "query" does support metrics queries, its output contains multiple data points between the start and end query time. This
output is used to build graphs, like what is seen in the Grafana Explore graph view. If you are querying metrics and just want the
most recent data point (like what is seen in the Grafana Explore table view), then you should use the "instant-query" command
instead.
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Flags:
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--help Show context-sensitive help (also try --help-long and --help-man).
--version Show application version.
-q, --quiet Suppress query metadata
--stats Show query statistics
-o, --output=default Specify output mode [default, raw, jsonl]. raw suppresses log labels and timestamp.
-z, --timezone=Local Specify the timezone to use when formatting output timestamps [Local, UTC]
--cpuprofile="" Specify the location for writing a CPU profile.
--memprofile="" Specify the location for writing a memory profile.
--addr="http://localhost:3100"
Server address. Can also be set using LOKI_ADDR env var.
--username="" Username for HTTP basic auth. Can also be set using LOKI_USERNAME env var.
--password="" Password for HTTP basic auth. Can also be set using LOKI_PASSWORD env var.
--ca-cert="" Path to the server Certificate Authority. Can also be set using LOKI_CA_CERT_PATH env var.
--tls-skip-verify Server certificate TLS skip verify.
--cert="" Path to the client certificate. Can also be set using LOKI_CLIENT_CERT_PATH env var.
--key="" Path to the client certificate key. Can also be set using LOKI_CLIENT_KEY_PATH env var.
--org-id="" adds X-Scope-OrgID to API requests for representing tenant ID. Useful for requesting tenant data when
bypassing an auth gateway.
--limit=30 Limit on number of entries to print.
--since=1h Lookback window.
--from=FROM Start looking for logs at this absolute time (inclusive)
--to=TO Stop looking for logs at this absolute time (exclusive)
--step=STEP Query resolution step width, for metric queries. Evaluate the query at the specified step over the time
range.
--interval=INTERVAL Query interval, for log queries. Return entries at the specified interval, ignoring those between.
**This parameter is experimental, please see Issue 1779**
--forward Scan forwards through logs.
--no-labels Do not print any labels
--exclude-label=EXCLUDE-LABEL ...
Exclude labels given the provided key during output.
--include-label=INCLUDE-LABEL ...
Include labels given the provided key during output.
--labels-length=0 Set a fixed padding to labels
--store-config="" Execute the current query using a configured storage from a given Loki configuration file.
-t, --tail Tail the logs
--delay-for=0 Delay in tailing by number of seconds to accumulate logs for re-ordering
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
Args:
clarify logcli commands and output (#1712) * clarify logcli commands and output This commit attempts to do two things: 1. Differentiate between log entries and raw log lines, where the latter is what is produced by `-oraw`. 2. Explain the difference between `logcli query` and `logcli instant-query`. Fixes #1676. * address feedback * address more feedback * explain that instant-query is not useful for log lines * address review feedback This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved. * sync logcli.md with command output
6 years ago
<query> eg '{foo="bar",baz=~".*blip"} |~ ".*error.*"'
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
$ logcli help labels
Support querying labels on time range in logcli (#2083)
6 years ago
usage: logcli labels [<flags>] [<label>]
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
Find values for a given label.
Flags:
--help Show context-sensitive help (also try --help-long and --help-man).
--version Show application version.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
-q, --quiet Suppress query metadata
--stats Show query statistics
-o, --output=default Specify output mode [default, raw, jsonl]. raw suppresses log labels and timestamp.
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
-z, --timezone=Local Specify the timezone to use when formatting output timestamps [Local, UTC]
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--cpuprofile="" Specify the location for writing a CPU profile.
--memprofile="" Specify the location for writing a memory profile.
--addr="http://localhost:3100"
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
Server address. Can also be set using LOKI_ADDR env var.
--username="" Username for HTTP basic auth. Can also be set using LOKI_USERNAME env var.
--password="" Password for HTTP basic auth. Can also be set using LOKI_PASSWORD env var.
--ca-cert="" Path to the server Certificate Authority. Can also be set using LOKI_CA_CERT_PATH env var.
--tls-skip-verify Server certificate TLS skip verify.
--cert="" Path to the client certificate. Can also be set using LOKI_CLIENT_CERT_PATH env var.
--key="" Path to the client certificate key. Can also be set using LOKI_CLIENT_KEY_PATH env var.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--org-id="" adds X-Scope-OrgID to API requests for representing tenant ID. Useful for requesting tenant data when
bypassing an auth gateway.
Support querying labels on time range in logcli (#2083)
6 years ago
--since=1h Lookback window.
--from=FROM Start looking for labels at this absolute time (inclusive)
--to=TO Stop looking for labels at this absolute time (exclusive)
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
Args:
[<label>] The name of the label.
$ logcli help series
usage: logcli series --match=MATCH [<flags>]
Run series query.
Flags:
--help Show context-sensitive help (also try --help-long and --help-man).
--version Show application version.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
-q, --quiet Suppress query metadata
--stats Show query statistics
-o, --output=default Specify output mode [default, raw, jsonl]. raw suppresses log labels and timestamp.
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
-z, --timezone=Local Specify the timezone to use when formatting output timestamps [Local, UTC]
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--cpuprofile="" Specify the location for writing a CPU profile.
--memprofile="" Specify the location for writing a memory profile.
--addr="http://localhost:3100"
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
Server address. Can also be set using LOKI_ADDR env var.
--username="" Username for HTTP basic auth. Can also be set using LOKI_USERNAME env var.
--password="" Password for HTTP basic auth. Can also be set using LOKI_PASSWORD env var.
--ca-cert="" Path to the server Certificate Authority. Can also be set using LOKI_CA_CERT_PATH env var.
--tls-skip-verify Server certificate TLS skip verify.
--cert="" Path to the client certificate. Can also be set using LOKI_CLIENT_CERT_PATH env var.
--key="" Path to the client certificate key. Can also be set using LOKI_CLIENT_KEY_PATH env var.
Add performance profile flags for logcli. (#2248) * Add performance profile flags for logcli. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Update the logcli documentation. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * Remove comment. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com> * remove unused import. Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
6 years ago
--org-id="" adds X-Scope-OrgID to API requests for representing tenant ID. Useful for requesting tenant data when
bypassing an auth gateway.
Support series API in logcli (#1861) * support series API in logcli Signed-off-by: yeya24 <yb532204897@gmail.com> add changelog Signed-off-by: yeya24 <yb532204897@gmail.com> * update logcli docs Signed-off-by: yeya24 <yb532204897@gmail.com>
6 years ago
--since=1h Lookback window.
--from=FROM Start looking for logs at this absolute time (inclusive)
--to=TO Stop looking for logs at this absolute time (exclusive)
--match=MATCH ... eg '{foo="bar",baz=~".*blip"}'
Remove invalidated key (#56) * Remove invalidated key Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com> * Remove env, put logcli docs in separate md file. Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
7 years ago
```