feat(api)!: Fail log queries when executed on instant query endpoint #13421
+55
−13
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
A log selector expression is a LogQL expression for returning logs, in
contrast to sample expressions, which return metrics. The simplest form
of log selector expressions are label matchers, e.g. `{env="prod"}`.
This PR changes the behaviour of Loki so it does not allow using a log
selector expression when the instant query endpoint `/api/v1/query` is
queried.
Previously this endpoint allowed these types of log queries, but returns
inconsistent results, which where a major cause for confusion. Returning
a concise error helps the user understand that they likely selected the
wrong query type in Grafana when executing the query.
Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
…tant query Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
… as instant query Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
chaudum
changed the title
Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
chaudum
changed the title
Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
github-actions
bot
added
the
type/docs
na--
approved these changes
Jul 5, 2024
slim-bean
approved these changes
Jul 5, 2024
Ok, will do that in a follow up PR. My reason for not putting anything into the UPGRADE guide was, that I thought the upgrade notes were for operational changes. But I agree, it note would be helpful. |
chaudum
added a commit
that referenced
this pull request
Jul 8, 2024
Follow up to #13421 Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
This was referenced Jul 9, 2024
This was referenced Aug 15, 2024
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
Background
A log selector expression is a LogQL expression that returns logs, in contrast to a sample expressions, which returns metrics (samples). The simplest form of log selector expressions are label matchers, e.g.
{env="prod"}.Change
This PR changes the behaviour of Loki so that the instant query endpoint
/api/v1/querydoes not allow sending a log selector expression as query any more. Instead, it returns a status code 400 (Bad Request) with the error message "log queries are not supported as an instant query type, please change you query to a range query type".Why
Previously this API endpoint allowed these types of log queries, but returned inconsistent results, which where a major cause for confusion. Returning a concise error helps the user understand that they likely selected the wrong query type in Grafana when executing the query.
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/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. Example PR