[TCM] Metrics reference
Open
Nobody has claimed this yet.
TCM
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool Cluster Manager
Since: TCM 1.0.0, Tarantool 3.0
Audience/target: admins
Root document: new page in the TCM section
SME: @ filonenko-mikhail
Details
Write the TCM metrics reference.
All descriptions are available in <tcm_uri>/metrics.
Consider writing monitoring how-to (check TDG2 docs for reference).
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 new page in the Tarantool Cluster Manager section and use <tcm_uri>/metrics as the source for the metrics descriptions. Review the TDG2 docs for a monitoring how-to reference if that scope is included. Done means the TCM metrics reference is written and the optional monitoring guidance is covered or explicitly scoped out.
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
- 48/100