quickwit-oss / quickwit-oss/quickwit

[Documentation topic] Searcher config advice

Open
#5,873 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Rust
Stars
11.7k
Forks
597
Avg merge
2d 22h
Merged PRs (30d)
37

Description

My documentation idea

I currently have a large Quickwit cluster for traces, and I'm experiencing slowdowns on large queries in version 0. I've tried changing the searcher configuration, but it's not easy.

I would like to see a best practices section in the documentation with a page on configuring searchers according to specific needs.

Examples:

I have a cluster with a single huge index. How do I configure the searchers?

I have a cluster with lots of small indexes. What are the best practices?

I have a cluster that is only for tracing with Jaeger. What is the best solution?

What do you all think?
👍 I would love to see it!
🚀 I would love to help!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Quickwit documentation and searcher configuration guidance, then compare the needs described for large single indexes, many small indexes, and Jaeger tracing clusters. Done means a best-practices section and dedicated page explain configuration choices for these scenarios, with enough guidance to address large-query slowdowns.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.