tarantool / tarantool/doc

MemCS index aggregates and scanner statistics

Open
#5,502 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Since: 3.6

MemCS indexes were populated with their aggregates and scanner statistics.
They can be found in index:stat(). The statistics are:

  • aggregates.total_size - memory occupied by the whole skip index.
  • aggregates.block_count - amount of blocks in skip index.
  • aggregates.minmax_size - total size of minmax aggregates in all blocks.
  • aggregates.bloom_size - total size of bloom aggregates in all blocks.
  • scanner.rows_skipped - amount of rows skipped with skip index.
  • scanner.rows_scanned - amount of rows scanned with ArrowStream.

Skipped and scannned statistics are cumulative and show amount of
scanned/skipped rows for the whole index lifetime.

NB: note that reads and skips that happened in read view will be accounted
only when that read view is closed.
Requested by @drewdzzz in https://github.com/tarantool/tarantool-ee/commit/9e03b5e42d4fb9648c52892115115e9306291351.

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 locating the MemCS index documentation and the index:stat() entry point. Document the listed aggregate and scanner statistics, including their cumulative behavior and the read-view closure note. Done means the statistics are explained in the appropriate documentation location and match the issue text.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.