Update logql.md #2125
Merged
Update logql.md #2125
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
Edited grammar, syntax, typos and added a few lists to make the document easier to read.
|
|
Codecov Report
@@ Coverage Diff @@
## master #2125 +/- ##
==========================================
- Coverage 61.25% 61.17% -0.09%
==========================================
Files 146 146
Lines 11196 11196
==========================================
- Hits 6858 6849 -9
- Misses 3793 3798 +5
- Partials 545 549 +4
|
cyriltovena
approved these changes
May 26, 2020
|
I'll leave some time for @oddlittlebird before merging. |
oddlittlebird
suggested changes
May 27, 2020
|
I think that both should be capitalized.
As for the bolds and italics, the docs were written by professional coders,
not professional writers. I suggest choosing a rule set and then starting
to apply it. MSG is good, and feel free to lean on the Grafana style guide
docs. The guys would probably be delighted if you gave them a style guide,
even if it just said "Bold UI terms, follow the Grafana style guide and
Microsoft style guide."
The fun thing about being the first writer on a project is that you get to,
for the most part, declare the rules. :)
…On Fri, May 29, 2020 at 2:15 AM Mercedes Arias-Duval < ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/logql.md
<#2125 (comment)>:
>
-A basic log query consists of two parts: the **log stream selector** and a
-**filter expression**. Due to Loki's design, all LogQL queries are required to
-contain a log stream selector.
+-*log queries* return the contents of log lines.
+-*metric queries* extend log queries and calculate values based on the counts of logs from a log query.
@oddlittlebird <https://github.com/oddlittlebird> I checked out the
master doc to understand my choices and saw that the bolds and itallics
that I was using are the same that were in already there. Capitalizing
"-Metric queries looks good, but then we'd have to do the same for "-Log
queries" that appears right before it. What do you think?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#2125 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMNF6KL2WLNPNIVOYMFWDKTRT54L7ANCNFSM4NJTOSAQ>
.
--
Diana Payton (She/Her)
Sr. Technical Writer at Grafana Labs
|
owen-d
approved these changes
Jun 2, 2020
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
oddlittlebird
approved these changes
Jun 8, 2020
| @@ -1,26 +1,28 @@ | |||
| # LogQL: Log Query Language | |||
|
|
|||
| Loki comes with its own PromQL-inspired language for queries called *LogQL*. | |||
| LogQL can be considered a distributed `grep` that aggregates log sources and | |||
| LogQL can be considered a distributed `grep` that aggregates log sources, | |||
There was a problem hiding this comment.
Suggested change
| LogQL can be considered a distributed `grep` that aggregates log sources, | |
| LogQL can be considered a distributed `grep` that aggregates log sources. |
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
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.
Edited grammar, syntax, typos and added a few lists to make the document easier to read.
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Checklist