clarify logcli commands and output #1712
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slim-bean
reviewed
Feb 18, 2020
slim-bean
reviewed
Feb 18, 2020
slim-bean
reviewed
Feb 18, 2020
slim-bean
reviewed
Feb 18, 2020
slim-bean
reviewed
Feb 18, 2020
slim-bean
approved these changes
Feb 18, 2020
|
Thanks for the review @slim-bean! I'd like to wait for @Dieterbe to give this a look before I merge so we get a non-Loki dev's opinion on it. |
fitzoh
reviewed
Feb 18, 2020
fitzoh
reviewed
Feb 18, 2020
fitzoh
reviewed
Feb 18, 2020
fitzoh
reviewed
Feb 18, 2020
Dieterbe
reviewed
Feb 18, 2020
Dieterbe
reviewed
Feb 18, 2020
cmd/logcli/main.go
Outdated
| the performed query and its results. Raw log lines (i.e., without a | ||
| label and timestamp) can be retrieved by passing the "-o raw" flag. | ||
| The extra information about the query (API URL, set of common labels, | ||
| excluded labels) can be suppressed with the --query flag. |
There was a problem hiding this comment.
"log line" vs "raw log line" is ambiguous. are they the same thing?
can you structure this information more? that would make this clearer I think
maybe something like:
- log line: contains what exactly? only the output lines from the app?
- log entry: timestamp + labels + log line
query output:
- default: log entries + query metadata + result metadata
-o rawto show log lines rather than log entries--query(you probably meant--quiethere!) to surpress query metadata and result metadata
Dieterbe
reviewed
Feb 19, 2020
|
Sorry for the delay @Dieterbe, PTAL at the changes. I didn't sync logcli.md with the flag changes yet, but I'll do that once you think the changes look good. |
|
looks good robert! |
Codecov Report
@@ Coverage Diff @@
## master #1712 +/- ##
==========================================
+ Coverage 64.07% 64.09% +0.02%
==========================================
Files 121 121
Lines 9027 9027
==========================================
+ Hits 5784 5786 +2
+ Misses 2841 2840 -1
+ Partials 402 401 -1
|
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 grafana#1676.
This commit leaves logcli.md unmodified; that will be done in a later commit if the changes are approved.
rfratto
force-pushed
the
logcli-clarification
branch
from
6c44f68 to
bda0510
Compare
|
@Dieterbe I've synced logcli.md with the go file. Can you approve this so we can merge it? |
Dieterbe
approved these changes
Mar 30, 2020
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1712 +/- ##
==========================================
+ Coverage 64.60% 64.62% +0.02%
==========================================
Files 125 125
Lines 9462 9462
==========================================
+ Hits 6113 6115 +2
+ Misses 2923 2922 -1
+ Partials 426 425 -1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR attempts to do two things:
-oraw.logcli queryandlogcli instant-query.Fixes #1676.
/cc @Dieterbe PTAL and let me know if this would've been helpful for you earlier on 🙂