add some documentation for some counters (#1726)

add some documentation for some counters
This commit is contained in:
Arvid Norberg 2017-02-18 12:55:20 -05:00 committed by GitHub
parent 7b61313b99
commit 6e65851b2d
1 changed files with 20 additions and 3 deletions

View File

@ -316,6 +316,10 @@ namespace libtorrent
METRIC(picker, interesting_piece_picks)
METRIC(picker, hash_fail_piece_picks)
// These gauges indicate how many blocks are currently in use as dirty
// disk blocks (``write_cache_blocks``) and read cache blocks,
// respectively. deprecates ``cache_status::read_cache_size``.
// The sum of these gauges deprecates ``cache_status::cache_size``.
METRIC(disk, write_cache_blocks)
METRIC(disk, read_cache_blocks)
@ -323,16 +327,25 @@ namespace libtorrent
// peer until we're sending the response back on the socket.
METRIC(disk, request_latency)
// ``disk_blocks_in_use`` indicates how many disk blocks are currently in
// use, either as dirty blocks waiting to be written or blocks kept around
// in the hope that a peer will request it or in a peer send buffer. This
// gauge deprecates ``cache_status::total_used_buffers``.
METRIC(disk, pinned_blocks)
METRIC(disk, disk_blocks_in_use)
// ``queued_disk_jobs`` is the number of disk jobs currently queued,
// waiting to be executed by a disk thread. Deprecates
// ``cache_status::job_queue_length``.
METRIC(disk, queued_disk_jobs)
METRIC(disk, num_running_disk_jobs)
METRIC(disk, num_read_jobs)
METRIC(disk, num_write_jobs)
METRIC(disk, num_jobs)
METRIC(disk, blocked_disk_jobs)
METRIC(disk, num_writing_threads)
METRIC(disk, num_running_threads)
METRIC(disk, blocked_disk_jobs)
// the number of bytes we have sent to the disk I/O
// thread for writing. Every time we hear back from
@ -348,8 +361,9 @@ namespace libtorrent
METRIC(disk, arc_write_size)
METRIC(disk, arc_volatile_size)
// the number of blocks written and read from disk in total. A block is
// 16 kiB.
// the number of blocks written and read from disk in total. A block is 16
// kiB. ``num_blocks_written`` and ``num_blocks_read`` deprecates
// ``cache_status::blocks_written`` and ``cache_status::blocks_read`` respectively.
METRIC(disk, num_blocks_written)
METRIC(disk, num_blocks_read)
@ -357,10 +371,13 @@ namespace libtorrent
METRIC(disk, num_blocks_hashed)
// the number of blocks read from the disk cache
// Deprecates ``cache_info::blocks_read_hit``.
METRIC(disk, num_blocks_cache_hits)
// the number of disk I/O operation for reads and writes. One disk
// operation may transfer more then one block.
// These counters deprecates ``cache_status::writes`` and
// ``cache_status::reads``.
METRIC(disk, num_write_ops)
METRIC(disk, num_read_ops)