tarantool / tarantool/doc

New `box.runtime.info().tuple` metric

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

Nobody has claimed this yet.

2.10 feature reference
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/commit/b56e012bc9f827b8cecdcf78ec3f8bf0860a335b.

Product: Tarantool
Since: 2.10.0-rc1
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_slab/runtime_info/
SME: @ Totktonada

Details

It allows to track memory allocated for tuples on runtime arena. It does
not count tuples owned by memtx and vinyl, but tracks so called runtime
tuples. The most common example is a tuple created by the
box.tuple.new(<...>) function.

Example:

tarantool> box.runtime.info().tuple -- 0
tarantool> box.tuple.new({})
tarantool> box.runtime.info().tuple -- 160
tarantool> box.tuple.new({})
tarantool> box.runtime.info().tuple -- 320
tarantool> collectgarbage()
tarantool> box.runtime.info().tuple -- 160

Definition of done

  • You have agreed with @Totktonada on the best way to describe the parameter.
  • The parameter is added in the documentation.

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 root document for box.slab.runtime_info and review the existing description of box.runtime.info().tuple. Confirm the parameter wording with @Totktonada, then add the tuple metric documentation and verify that the example and definition-of-done requirements are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.