tarantool / tarantool/doc

Не описаны все опции из index:stat

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

Nobody has claimed this yet.

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

Description

В index:stat описаны не все поля, которые отдаются в ответ
https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_index/stat/

Часть из них имеет смысл описать, например get и cache.get

tarantool> box.space.vinyl_space.index.pk:stat()
---
- latency:
    p99: 1e-06
    p95: 1e-06
    p90: 1e-06
    p75: 1e-06
    p50: 1e-06
  range_count: 1
  lookup: 0
  cache:
    invalidate:
      rows: 0
      bytes: 0
    index_size: 0
    rows: 0
    evict:
      rows: 0
      bytes: 0
    put:
      rows: 0
      bytes: 0
    lookup: 0
    bytes: 0
    get:
      rows: 0
      bytes: 0
  run_histogram: '[0]:1'
  disk:
    last_level:
      bytes_compressed: 0
      pages: 0
      rows: 0
      bytes: 0
    rows: 0
    statement:
      inserts: 0
      replaces: 0
      upserts: 0
      deletes: 0
    dump:
      input:
        rows: 0
        bytes: 0
      time: 0
      output:
        bytes_compressed: 0
        pages: 0
        rows: 0
        bytes: 0
      count: 0
    bloom_size: 0
    index_size: 0
    iterator:
      read:
        bytes_compressed: 0
        pages: 0
        rows: 0
        bytes: 0
      bloom:
        hit: 0
        miss: 0
      lookup: 0
      get:
        rows: 0
        bytes: 0
    compaction:
      input:
        bytes_compressed: 0
        pages: 0
        rows: 0
        bytes: 0
      queue:
        bytes_compressed: 0
        pages: 0
        rows: 0
        bytes: 0
      time: 0
      output:
        bytes_compressed: 0
        pages: 0
        rows: 0
        bytes: 0
      count: 0
    pages: 0
    bytes_compressed: 0
    bytes: 0
  range_size: 134217728
  rows: 0
  run_avg: 0
  dumps_per_compaction: 0
  upsert:
    squashed: 0
    applied: 0
  bytes: 0
  put:
    rows: 0
    bytes: 0
  skip:
    rows: 0
    bytes: 0
  run_count: 0
  txw:
    bytes: 0
    rows: 0
    iterator:
      lookup: 0
      get:
        rows: 0
        bytes: 0
  memory:
    bytes: 0
    index_size: 0
    rows: 0
    iterator:
      lookup: 0
      get:
        rows: 0
        bytes: 0
  get:
    rows: 0
    bytes: 0
...

Документация на них упростит их добавление в метрики: https://github.com/tarantool/metrics/issues/522

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 box.index:stat() reference page linked in the issue and compare its documented fields with the example response. Describe the relevant missing options, including fields such as get and cache.get, so the returned statistics are covered well enough to support the metrics work referenced in tarantool/metrics#522.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.