Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: revise the LogCLI subsection #3921

Merged
merged 3 commits into from
Jul 6, 2021

Conversation

KMiller-Grafana
Copy link
Contributor

In this revision:

  • I recaptured the help output from LogCLI for the various commands
  • I separated the help output for the various commands into different sections. Makes it easier to read, and makes it possible to use the horizontal scroll bar.
  • New section title
  • Rewrote the section on batching queries
  • Corrected section/subsection nesting levels and made minor spelling changes

Copy link
Member

@owen-d owen-d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few nits - LGTM

$ export LOKI_ADDR=https://logs-us-west1.grafana.net
$ export LOKI_USERNAME=<username>
$ export LOKI_PASSWORD=<password>
export LOKI_ADDR=https://logs-us-west1.grafana.net
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love these changes - can copy/paste now!

docs/sources/getting-started/logcli.md Outdated Show resolved Hide resolved
When not set, `--limit` defaults to 30.
This low default value protects the user from overwhelming the system
for cases in which the specified query would have returned a large quantity
of log lines.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
of log lines.
of log lines as well as the user from unexpectedly large responses.

@owen-d owen-d merged commit 2aafb0d into grafana:main Jul 6, 2021
@KMiller-Grafana KMiller-Grafana deleted the docs/improve-logcli branch July 7, 2021 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants