tarantool / tarantool/doc

embedded metrics configuration

Open
#3,418 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.0 config metrics
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Related dev. issue(s): https://github.com/tarantool/tarantool/issues/7725

Product: Tarantool
Since: 3.0
Root document:

SME: @ DifferentialOrange

Details

This patch add new box.cfg dynamic parameter: metrics. It is a table
with the same effect as in metrics.cfg. metrics.cfg has its own
documentation, see [1].

  1. https://www.tarantool.io/en/doc/latest/book/monitoring/api_reference/#lua-function.metrics.cfg
    Requested by @ DifferentialOrange in https://github.com/tarantool/tarantool/commit/8f95eaa5d7fb3818e9819aa1b1aafcbf80bab841.

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 configuration reference and the metrics.cfg API reference linked in the issue, then compare the related development issue #7725. Document the new box.cfg metrics parameter and its relationship to metrics.cfg, keeping the existing metrics configuration behavior and wording consistent.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.