-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Ruler docs + single binary inclusion #2637
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2637 +/- ##
=======================================
Coverage 61.22% 61.22%
=======================================
Files 172 172
Lines 13360 13360
=======================================
Hits 8180 8180
Misses 4431 4431
Partials 749 749
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't get all the way through this PR before my day ended, but this should give you a good start. A few things:
- Capitalize Loki. It's the name of a product, so a proper noun.
- All headings should be sentence case.
- Do not use an ampersand to abbreviate "and."
- I strongly recommend breaking up the larger files into smaller subtopics. This makes them a lot easier to navigate and read.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, got through the remainder of this PR.
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor edit, then good to go!
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple nits but otherwise looks good to me! nice!
- Recording rules. | ||
- Backend metric stores adapters for generated alert and recording rule data. The first will likely be Cortex, as Loki is built atop it. | ||
- The first will likely be Cortex, as Loki is built atop it. | ||
- Introduce LogQL v2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will this naming be evergreen?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know -- this doc will probably need some updates as things progress.
Co-authored-by: Ed Welch <ed@oqqer.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
In addition to docs, this PR adds
make docs
command (it still orphans processes but haven't had the time to dig into that). It's now interactive & can be SIGINT'd to return control to your terminal. However you'll accrue orphaned docker containers.