Skip to content

[5pt] Document feedback_daemon report contents #1749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sergepetrenko opened this issue Jan 14, 2021 · 2 comments
Open

[5pt] Document feedback_daemon report contents #1749

sergepetrenko opened this issue Jan 14, 2021 · 2 comments
Labels
add details [nature] More details needed, some info missing. Documentation is incomplete. reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality

Comments

@sergepetrenko
Copy link
Contributor

sergepetrenko commented Jan 14, 2021

Document feedback_daemon report contents

Product: Tarantool
Since: all versions (except Various network statistics which is since 2.7.1 only)
Audience/target:
Root document: new page about report format, add link from https://www.tarantool.io/en/doc/latest/reference/configuration/#feedback
SME: @sergepetrenko
Peer reviewer: @

Details

The doc contains a reference to feedback daemon here, but only lists 3 fields as part of its report.
Actually, feedback daemon's report contains much more info. We need to document all these fields.
Here's a feedback daemon report:

---
- arch: x64

^^^ Architecture tarantool was built for.

  features:
    schema:
      local_spaces: 0
      functional_indices: 0
      memtx_spaces: 0
      rtree_indices: 0
      tree_indices: 0
      temporary_spaces: 0
      jsonpath_indices: 0
      hash_indices: 0
      functional_multikey_indices: 0
      sync_spaces: 0
      vinyl_spaces: 0
      bitset_indices: 0
      jsonpath_multikey_indices: 0

^^^ Various index type counters, space type counters

    on_reload_configuration_used: false

^^^ Whether function box.on_reload_configuration is specified or not.

  cluster_id: 8b6692f1-5367-4232-8cf6-6a1a7f20303f

^^^ box.info.cluster.uuid

  tarantool_version: 2.8.0-0-gefc30ccf8

^^^ tarantool version

  stats:
    net:
      SENT:
        total: 0
      CONNECTIONS:
        current: 0
        total: 0
      REQUESTS:
        current: 0
        total: 0
      RECEIVED:
        total: 0
    box:
      DELETE:
        total: 0
      SELECT:
        total: 2
      INSERT:
        total: 0
      EVAL:
        total: 0
      CALL:
        total: 0
      PREPARE:
        total: 0
      EXECUTE:
        total: 0
      REPLACE:
        total: 0
      UPSERT:
        total: 0
      AUTH:
        total: 0
      ERROR:
        total: 0
      UPDATE:
        total: 0
    time: 1610608668528804

^^^ Since version 2.7.1 only Various network statistics and total count of performed operations together with system time of report generation (implemented in tarantool/tarantool#5589)

  os: OSX

^^^ Host os.

  options:
    replication_synchro_quorum: 1
    election_mode: off
    memtx_use_mvcc_engine: false

^^^ Various configuration options used. Currently covers box.cfg.replication_synchro_quorum,
box.cfg.election_mode, box.cfg.memtx_use_mvcc_engine

  cgroup: 

^^^ process cgroup

  server_id: b35c01d5-3587-44e4-bb90-d7ae82dd64c2

^^^ box.info.uuid

  feedback_version: 5
...
@NickVolynkin
Copy link
Contributor

@sergepetrenko thanks for adding a lot of details and examples. Who can we ask for more information and fact-checking?

Note about implementation: the whole configuration page is huge, we probably need to extract at least the feedback deamon configs into a separate page.

@NickVolynkin NickVolynkin added the reference [location] Tarantool manual, Reference part label Feb 3, 2021
@sergepetrenko
Copy link
Contributor Author

@NickVolynkin feel free to ask me for any additional details.

@Onvember Onvember added add details [nature] More details needed, some info missing. Documentation is incomplete. S (small) labels Feb 12, 2021
@Onvember Onvember changed the title Document feedback_daemon report contents [10pt] Document feedback_daemon report contents Feb 12, 2021
@NickVolynkin NickVolynkin removed S (small) add details [nature] More details needed, some info missing. Documentation is incomplete. labels Mar 10, 2021
@NickVolynkin NickVolynkin changed the title [10pt] Document feedback_daemon report contents [5pt] Document feedback_daemon report contents Mar 10, 2021
@veod32 veod32 added 2.7.1 server [area] Task relates to Tarantool's server (core) functionality and removed 2.7.1 labels Mar 18, 2021
@veod32 veod32 added this to the Tarantool releases of Dec 2020 milestone Mar 22, 2021
@veod32 veod32 removed this from the Tarantool Releases: 2020 Q4 milestone Mar 1, 2023
@veod32 veod32 added add details [nature] More details needed, some info missing. Documentation is incomplete. and removed 5sp labels Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add details [nature] More details needed, some info missing. Documentation is incomplete. reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality
Projects
None yet
Development

No branches or pull requests

5 participants