docs: observability.md: clarify lines vs. entries #1738
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
2623989 to
df71722
Compare
Codecov Report
@@ Coverage Diff @@
## master #1738 +/- ##
==========================================
+ Coverage 64.2% 64.23% +0.03%
==========================================
Files 121 121
Lines 9085 9085
==========================================
+ Hits 5833 5836 +3
+ Misses 2848 2846 -2
+ Partials 404 403 -1
|
cyriltovena
reviewed
Feb 26, 2020
docs/operations/observability.md
Outdated
| | `loki_distributor_ingester_appends_total` | Counter | The total number of batch appends sent to ingesters. | | ||
| | `loki_distributor_ingester_append_failures_total` | Counter | The total number of failed batch appends sent to ingesters. | | ||
| | `loki_distributor_bytes_received_total` | Counter | The total number of uncompressed bytes received per tenant. | | ||
| | `loki_distributor_lines_received_total` | Counter | The total number of log entries received per tenant (misleading name, as an entry can have more than one line of text). | |
There was a problem hiding this comment.
Instead of misleading I would just explain that an entry can contains multiple line.
There was a problem hiding this comment.
Thanks for the feedback @cyriltovena -- I force-pushed with updated wording. Would appreciate if you could have another look. Thanks!
Signed-off-by: Dr. Jan-Philip Gehrcke <jp@opstrace.com>
df71722 to
48f9f59
Compare
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:
I was reading https://github.com/grafana/loki/blob/master/docs/operations/observability.md#observing-loki (much appreciated, thank you!) and came across the metric
loki_distributor_lines_received_total. I know a little bit about the anatomy of the underlying protobuf structures where a log entry can have more or less arbitrary text, including newline-separated lines of text.I wondered: does this metric count entries or lines?
The code tells us that it is actually counting entries, not lines.
I understand that changing the metric name is not low-friction, but very much thought it's worth clarifying that in the docs so that we don't confuse readers that pay attention to this level of detail.
What do you think?
Which issue(s) this PR fixes:
no issue number
Special notes for your reviewer:
I have used VSCode to edit the Markdown here, and it is auto-formatting tables in quite a meaningful way. I'd understand though if that's not wanted. Let me know.
Checklist