Improve observability of index queries #11064
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
added 5 commits
October 27, 2023 13:46
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
Signed-off-by: Danny Kopping <[email protected]>
dannykopping
force-pushed
the
dannykopping/index-o11y
branch
from
5abcd5d to
ba72587
Compare
slim-bean
reviewed
Oct 27, 2023
slim-bean
reviewed
Oct 27, 2023
slim-bean
reviewed
Oct 27, 2023
slim-bean
reviewed
Oct 27, 2023
slim-bean
reviewed
Oct 27, 2023
slim-bean
reviewed
Oct 27, 2023
slim-bean
reviewed
Oct 27, 2023
|
I love this PR!!! sorry it feels like I am nitting it to death 😬 |
Not at all! I appreciate the high level of scrutiny; much prefer it to a rubber stamp |
Signed-off-by: Danny Kopping <[email protected]>
kavirajk
reviewed
Oct 27, 2023
Signed-off-by: Danny Kopping <[email protected]>
kavirajk
approved these changes
Oct 27, 2023
Signed-off-by: Danny Kopping <[email protected]>
rhnasc
pushed a commit
to inloco/loki
that referenced
this pull request
Apr 12, 2024
**What this PR does / why we need it**: Requests to the following APIs previously had limited or incorrect logging, which made understanding their behaviour at runtime difficult. [GET /loki/api/v1/labels](https://grafana.com/docs/loki/latest/reference/api/#list-labels-within-a-range-of-time) [GET /loki/api/v1/label/<name>/values](https://grafana.com/docs/loki/latest/reference/api/#list-label-values-within-a-range-of-time) [GET /loki/api/v1/series](https://grafana.com/docs/loki/latest/reference/api/#list-series) [GET /loki/api/v1/index/stats](https://grafana.com/docs/loki/latest/reference/api/#index-stats) [GET /loki/api/v1/index/volume](https://grafana.com/docs/loki/latest/reference/api/#volume) [GET /loki/api/v1/index/volume_range](https://grafana.com/docs/loki/latest/reference/api/#volume) All of these APIs now have querier and query-frontend logs; sharding and time-based splitting are applied to these requests, and it's valuable to see all requests.
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:
Requests to the following APIs previously had limited or incorrect logging, which made understanding their behaviour at runtime difficult.
GET /loki/api/v1/labels
GET /loki/api/v1/label//values
GET /loki/api/v1/series
GET /loki/api/v1/index/stats
GET /loki/api/v1/index/volume
GET /loki/api/v1/index/volume_range
All of these APIs now have querier and query-frontend logs; sharding and time-based splitting are applied to these requests, and it's valuable to see all requests.
Which issue(s) this PR fixes:
N/A
Special notes for your reviewer:
Logs are produced by both queriers and query-frontends, but only the QFs produced logs which showed
caller=metrics.go. We regularly search on this substring to find our request log, but querier logs were shown as coming fromspanlogger.go. I've included a small hack infixLoggerwhich addscaller=metrics.goto the log line if aSpanLoggeris used. It's ugly, but I wanted to get this change in to help with our operational issues rather than refactoring the way we log on some occasions.We're also considering adding limits (and later pagination) to these endpoints. I propose that we let this change soak in production for a couple weeks so we can make some data-driven decisions about what limits are reasonable.
Checklist
CONTRIBUTING.mdguide (required)CHANGELOG.mdupdatedadd-to-release-noteslabeldocs/sources/setup/upgrade/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PRdeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory.