Documentation: Refine LogQL documentation #2279
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
|
|
Fra-nk
commented
Jun 30, 2020
docs/logql.md
Outdated
Comment on lines
254
to
268
| Between two scalars, the bool modifier must be provided and these operators result in another scalar that is either 0 (false) or 1 (true), depending on the comparison result. | ||
| Between two scalars, these operators result in another scalar that is either 0 (false) or 1 (true), depending on the comparison result. | ||
| The `bool` modifier must **not** be provided. |
There was a problem hiding this comment.
Not sure about these sentences: The original
the bool modifier must be provided
seemed wrong, so I suggest this wording.
There was a problem hiding this comment.
Thanks! I just checked and this should actually state that between two scalars, the bool modifier is ignored.
Codecov Report
@@ Coverage Diff @@
## master #2279 +/- ##
==========================================
+ Coverage 62.44% 62.45% +0.01%
==========================================
Files 158 158
Lines 12762 12762
==========================================
+ Hits 7969 7971 +2
Misses 4177 4177
+ Partials 616 614 -2
|
owen-d
reviewed
Jun 30, 2020
docs/logql.md
Outdated
|
|
||
| `1 + 2 / 3` will still be `1 + ( 2 / 3 )`. | ||
|
|
||
| Precedence order is identically to [mathematical convention](https://en.wikipedia.org/wiki/Order_of_operations). |
There was a problem hiding this comment.
Suggested change
| Precedence order is identically to [mathematical convention](https://en.wikipedia.org/wiki/Order_of_operations). | |
| Precedence order is identical to [mathematical convention](https://en.wikipedia.org/wiki/Order_of_operations). |
owen-d
approved these changes
Jun 30, 2020
|
I realised operator precedence isn't restricted to arithmetic operators, so I moved it to a dedicated section (under binary operators). |
cyriltovena
pushed a commit
to cyriltovena/loki
that referenced
this pull request
Jun 11, 2021
…c users data (grafana#2279) * cache invalidation using cache gen numbers to invalidate only specific users data using a middleware, all cache keys are prefixed with a gen number. gen numbers are specific to users and are incremented whenever a new request comes in or request is processed i.e requested data got deleted. Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * not caching results in querier frontend when there is inconsistency in cache generation numbers Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * use delete requests table for storing cache gen numbers and other changes suggested from PR review Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * check results cache gen numbers directly from delete requests store in frontend. compares gen numbers from response headers and store to decide whether we need to cache results or not. results cache would eliminate headers before encoding values to cache. query sharding to pass back all the headers for sharded queries. Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * avoid throwing error while failing to load cache gen numbers Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * fix merge conflicts Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * changes suggested from PR review Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * changes suggested from PR review Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com> * changes suggested from PR review Signed-off-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.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.
What this PR does / why we need it:
Documentation on LogQL had a very "all over the place" formatting:
Vastly different line lengths, inconsistent style(s), minor errors, etc.
Previously some parts had 60 or 80 line length + brakes, while others had much longer lines.
I'm also happy to preserve the old format (and consistently have that) if that's what you prefer.
Independent of a few re-formatting things, I think the rest of the changes are worth it:
boolstatement in conjunction with comparison operators was hard to grasp without that formatting.Which issue(s) this PR fixes:
Special notes for your reviewer:
Have a look at the Markdown rendered version(s), i.e. https://github.com/Fra-nk/loki/blob/logql-documentation-update/docs/logql.md and https://github.com/grafana/loki/blob/master/docs/logql.md
Checklist