SEARCH-8100 Make query timeout configurable #29
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
dcheckoway
commented
Dec 8, 2024
| // If there's a configured timeout, ensure we don't let the query run longer than that | ||
| if maxQueryDuration > 0 && elapsed >= maxQueryDuration { | ||
| // TODO: cancel the query | ||
| return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("Job %s still not finished after %v (status=%v)", jobId, maxQueryDuration, status)) |
There was a problem hiding this comment.
NOTE: The change to displaying maxQueryDuration instead of elapsed here just makes the error message cleaner. If the timeout is 42s, but we determine this at 43.020007 seconds, it was displaying all weird. This feels a bit more intuitive to show the configured timeout, a nice clean value.
itsalvinho
reviewed
Dec 10, 2024
| ...options, | ||
| jsonData: { | ||
| ...options.jsonData, | ||
| queryTimeoutSec: event.target.value?.length > 0 ? +event.target.value : undefined, |
There was a problem hiding this comment.
nit: do we need this event.target.value?.length > 0 check if validateQueryTimeout already performs the check?
There was a problem hiding this comment.
oh wait ignore me, it's still valid if it's empty, nvm!!
itsalvinho
approved these changes
Dec 10, 2024
dcheckoway
deleted the
dc/SEARCH-8100-grafana-plugin-make-query-timeout-configurable
branch
dcheckoway
added a commit
that referenced
this pull request
Dec 12, 2024
* go get -u github.com/grafana/grafana-plugin-sdk-go * npx -y @grafana/create-plugin@latest update * SEARCH-8100 Make query timeout configurable (#29) * SEARCH-8103 Include info about scheduled queries in the timeout error (#30) * SEARCH-8309 Allow savedSearchId to be composed using variable(s) (#27) * SEARCH-8309 Allow savedSearchId to be composed using variable(s) * SEARCH-8309 Update QueryEditor to allow typing savedSearchId with ${variable} * SEARCH-8101 Cancel the query upon timeout (#31) * ran "npx -y @grafana/create-plugin@latest update" again * Bumps for v1.1.2
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.
This moves away from the hardcoded 60-second timeout and enables the timeout to be configured on the dataset.
It can be left blank to mean no timeout, which can be useful if for some reason you really want long-running searches in your Grafana dashboard panels. But hey, you do you.
And users for whom 60 seconds was too restrictive can now tweak it to something more appropriate for their needs.
There's some basic validation in the UI, allowing only a positive integer value.
And just as before, you get an error message if the query takes longer than the configured timeout.
Future Work
We'll be following up soon with an enhancement that will cancel the query when the timeout kicks in (instead of leaving it running).