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.

Sign up for GitHub

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

Jump to bottom

Update Loki configuration doc querier.query_timeout -> limits_config.query_timeout #8090

Closed
leveyjam opened this issue Jan 11, 2023 · 3 comments · Fixed by #8206
Closed

Update Loki configuration doc querier.query_timeout -> limits_config.query_timeout #8090

leveyjam opened this issue Jan 11, 2023 · 3 comments · Fixed by #8206
Labels
type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories

Comments

@leveyjam
Copy link

Describe the bug
Since (version to be confirmed) https://grafana.com/docs/loki/latest/configuration/ is no longer correct.
To increase query_timeout from the 1m default, the option has to be added to limits_config.
The current documentation still references the querier config block.

To Reproduce
Steps to reproduce the behavior:

  1. Configuration migration PR indicates the new configuration property to use.

Expected behavior
Docs need to update references to querier``query_timeout to limits_config``query_timeout.

Environment:

  • All

Screenshots, Promtail config, or terminal output
see https://grafana.com/docs/loki/latest/configuration/#querier
@leveyjam leveyjam added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jan 11, 2023
@leveyjam
Copy link
Author

CC: @periklis

@jphx
Copy link

jphx commented Jan 11, 2023

It would be good to update the section in the Troubleshooting documentation also.

Also, the referenced PR is against operator code, but I think the PR that made this change is #6835.

The first release with that PR in it appears to be v2.7.0.

@jphx
Copy link

jphx commented Jan 11, 2023

I think the Upgrading documentation could also use a change. First, I think it's an error that it says

we're deprecating it in favor of relying on engine.query-timeout only.

I think it was trying to reference querier.query_timeout, but it doesn't mention limits_config.query_timeout at all.

@yashsoni369 yashsoni369 mentioned this issue Jan 19, 2023
Merged
5 tasks
owen-d pushed a commit that referenced this issue Jan 19, 2023
@yashsoni369 @chaudum
updating troubleshooting and upgrade changelog (#8206)
c648968 
**What this PR does / why we need it**:
Updating docs which mentions `querier.query_timeout` to
`limits_request.query_timeout`

**Which issue(s) this PR fixes**:
Fixes #8090 

**Special notes for your reviewer**:

**Checklist**
- [x] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [x] Documentation added
- [ ] Tests updated
- [x] `CHANGELOG.md` updated
- [x] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/upgrading/_index.md`

Co-authored-by: Christian Haudum <christian.haudum@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

updating troubleshooting and upgrade changelog yashsoni369/loki
2 participants
@jphx @leveyjam