monitoring: metrics to "how to enable" mapping
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool/tools (metrics)
Since: product version
Audience/target: developers/support
Root document: Monitoring section
SME: @DifferentialOrange @yngvar-antonsson
Details
We already have a Metrics reference section which covers available metrics, as well as Metrics API reference, which covers thing like "how to enable/disable general metrics" and "how to enable psutils CPU metrics". It would be nice to have a note/link for each Metrics reference metric to a documentation section which covers how one should enable it.
Inspired by this Community chat discussion
Planning checklist
- Pick product label:
- Pick type label:
- reference,
- getting started,
- user_guide, etc.
- Estimate complexity in storypoints in the title
- Add to Documentation board → Backlog
Note: issue templates are in beta. Give your feedback in #1869.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Monitoring section, especially the Metrics reference and Metrics API reference linked in the issue. Review each metric entry and identify the documentation section covering how to enable it, then add a note or link for every metric. Done means the Metrics reference consistently points readers to the relevant enablement guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100