quickwit-oss / quickwit-oss/quickwit

Incorrect metric mentioned in documentation

Open
#6,017 2 comments 0 reactions 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

The metric leaf_searches_splits_total mentioned in Metrics in Search Metrics does not exists in /metrics endpoint of quickwit version v0.8.2 and v0.8.0. I would love to see the correct metric for this equivalent metric.

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

Thank you for your request!

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 with the Metrics documentation at https://quickwit.io/docs/reference/metrics and compare the listed leaf_searches_splits_total metric with the /metrics endpoint in Quickwit v0.8.0 and v0.8.2. Confirm the equivalent Search Metrics name, update the documentation, and verify that the published metric matches the endpoint.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, observability
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.