mirrors/scylladb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: nodetool: toppartitions: document --samplers and --capacity

Browse Source 
In particular --capacity is critical for obtaining accurate measurements.

Closes scylladb/scylladb#20192
This commit is contained in:
Avi Kivity
2024-08-18 18:40:37 +03:00
committed by Botond Dénes
parent 9f9346fc59
commit bbcfd47bf5
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/operating-scylla/nodetool-commands/toppartitions.rst
View File

@@ -3,7 +3,7 @@ Nodetool toppartitions
**toppartitions** <keyspace> <table> <duration> - Samples cluster writes and reads and reports the most active partitions in a specified table and time frame.
**toppartitions** [<--ks-filters ks>] [<--cf-filters tables>] [<-d duration>]
**toppartitions** [<--ks-filters ks>] [<--cf-filters tables>] [<-d duration>] [<-s|--capacity capacity>] [<-a|--samplers samplers>]
.. note::
@@ -29,6 +29,10 @@ ks-filters List of keyspaces
cf-filters List of Tables (Column Families)
---------- -----------------------------------
duration The duration in milliseconds
---------- -----------------------------------
capacity The capacity of the sampler; higher values increase accuracy at the cost of memory (default 256 keys).
---------- -----------------------------------
samplers The samplers to use; ``WRITES``, ``READS``, or both (default).
========== ===================================
For example:
@@ -101,6 +105,9 @@ Write Latency The average read latency
To know which node hold the partition key use the nodetool :doc:`getendpoints </operating-scylla/nodetool-commands/getendpoints/>` command.
If the margin of error column (+/-) approaches the Count column, the measurement is inaccurate. You can increase accuracy by specifying
the ``--capacity`` option.
For example:
.. code-block:: shell