Skip to content
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

Query-scheduler worker: don't treat cancel as an error #6767

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bboreham
Copy link
Contributor

What this PR does

This is the same as #4648 but for scheduler-processor.

When a query returns an error value, check whether that error is actually a cancellation before acting.
Two effects: the worker won't log "context canceled", and it will process the next request immediately.

Could be the user closed the tab, or it's a sharded query and some other shard errored. Whatever the cause, cancellation is not an error.

Checklist

  • NA Tests updated
  • NA Documentation added
  • CHANGELOG.md updated

Could be the user closed the tab, or it's a sharded query and some other
shard errored. Whatever the cause, cancellation is not an error.

Two effects: the worker won't log "context canceled", and it will
process the next request immediately.

Signed-off-by: Bryan Boreham <bjboreham@gmail.com>
@leizor
Copy link
Contributor

leizor commented Nov 28, 2023

The CHANGELOG has just been cut to prepare for the next Mimir release. Please rebase main and eventually move the CHANGELOG entry added / updated in this PR to the top of the CHANGELOG document. Thanks!

continue
backoff.Wait()
continue
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the intent of this change. However, we'll now not log anything if the query is cancelled because the scheduler told the querier to cancel the query, which might make debugging issues harder.

Perhaps we should add an info-level log statement around line 177 below if the query is explicitly cancelled by the scheduler? Even better would be to cancel the context created on line 146 with an error like "query cancelled by scheduler" and then make sure this is logged somewhere or attached to the query trace.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this happen if the user's client has a timeout shorter than Mimir takes?
This is the case I don't want to log for.
It should be visible as an event in the trace.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The querier won't know what caused the cancellation - it could be that the user cancelled the query, or it could be that something in the chain between the user and the querier timed out and cancelled the query, for example.

Copy link
Contributor Author

@bboreham bboreham Dec 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still sounds like I don't want to see the log here.
The component taking a decision about canceling can log it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's value in adding something to the querier's trace span to say "received cancellation from scheduler" - we've had a number of context cancellation-related issues in this part of the codebase lately, and being very explicit like this would have been helpful in debugging the issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants