quickwit-oss / quickwit-oss/quickwit

Add docs to explain how to monitor a quickwit cluster

Open
#2,569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The docs should:

  • explain the key metrics
  • provide grafana dashboards screenshots

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 the monitoring setup to identify the key cluster metrics and the Grafana dashboards to cover. The work is done when the docs explain those metrics and include screenshots of the relevant Grafana dashboards.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.