A newer version of this documentation is available.

View Latest

vbucket-details

    +
    Provides details for vBuckets.

    Syntax

    Request syntax:

    cbstats host:11210 [common options] vbucket-details [vbid]

    Description

    This command provides details for the specified vBucket, or for each vBucket if none is specified.

    The identifier for each vBucket statistic begins with the string vb_ followed by the vBucket ID and a colon. For example, for vBucket 1023, the identifier for the uuid statistic is vb_1023:uuid.

    Table 1. vBucket statistics
    Name Description

    num_items

    Number of items in this vBucket.

    num_tmp_items

    Number of temporary items in memory.

    num_non_resident

    Total number of items which are not resident in memory for this vBucket.

    'num_prepared_sync_writes'

    Number of durable writes currently in progress (and therefore not yet either committed or aborted) for this vBucket.

    vb_pending_perc_mem_resident

    % memory resident.

    vb_pending_eject

    Number of times item values got ejected.

    vb_pending_expired

    Number of times an item was expired.

    ht_memory

    Memory overhead of the hashtable.

    ht_item_memory

    Total item memory.

    ht_cache_size

    Total size of cache — includes non-resident items.

    num_ejects

    Number of times an item was ejected from memory.

    ops_create

    Number of create operations.

    ops_update

    Number of update operations.

    ops_delete

    Number of delete operations.

    ops_reject

    Number of rejected operations.

    queue_size

    Pending items in disk queue.

    backfill_queue_size

    Items in backfill queue.

    queue_memory

    Memory used for disk queue.

    queue_age

    Sum of disk queue item age in milliseconds.

    queue_fill

    Total enqueued items.

    queue_drain

    Total drained items.

    pending writes

    Total bytes of pending writes.

    db_data_size

    Total size of useful data in the database file on disk, measured in bytes.

    db_file_size

    Total size of the database file on disk (including uncompacted stale data), measured in bytes.

    high_seqno

    The last seqno assigned by this vBucket.

    purge_seqno

    The last seqno purged by the compactor.

    bloom_filter

    Status of the vBucket’s bloom filter.

    bloom_filter_size

    Size of the bloom filter bit array.

    bloom_filter_key_count

    Number of keys inserted into the bloom filter. Considers overlapped items as one, so this may not be accurate at times.

    uuid

    The current vBucket uuid.

    rollback_item_count

    Number of items rolled back.

    hp_vb_req_size

    Number of asynchronous high priority requests.

    max_cas

    Maximum CAS of all items in the vBucket. This is a hybrid logical clock value in nanoseconds.

    max_cas_str

    The vBucket’s current maximum hybrid logical clock (HLC) timestamp. In general, this statistic shows the value issued to the last mutation, or in certain cases the largest timestamp the vBucket has received, when the received timestamp is ahead of the local clock. Displayed as a human readable ISO-8601 timestamp (UTC).

    total_abs_drift

    The accumulated absolute drift for this vBucket’s hybrid logical clock in microseconds. Drift is always accumulated as an absolute value.

    total_abs_drift_count

    The number of updates applied to total_abs_drift, for the purpose of average or rate calculations.

    drift_ahead_threshold_exceeded

    How many mutations have been observed with a drift above the drift_ahead_threshold.

    drift_ahead_threshold

    Threshold at which positive drift will trigger an update to drift_ahead_exceeded, measured in nanoseconds.

    drift_behind_threshold_exceeded

    How many mutations have been observed with a drift below the drift_behind_threshold.

    drift_behind_threshold

    The threshold at which positive drift will trigger an update to drift_behind_exceeded. The value is displayed in nanoseconds as a positive value, but is converted to a negative value for actual exception checks.

    logical_clock_ticks

    How many times the hybrid logical clock (HLC) has had to increment the logical clock.

    might_contain_xattrs

    True if the vBucket might contain xattrs. True means that xattrs were stored to the vBucket. Note that the flag does not clear itself if all xattrs were removed.

    sync_write_accepted_count

    Number of synchronous-write requests in this vbucket’s sequence list.

    sync_write_committed_count

    Number of synchronous-write commits in this vbucket’s sequence list.

    sync_write_aborted_count

    Number of synchronous-write aborts in this vbucket’s sequence list.

    Note also that the cbstats all option provides summary statistics, which sum the totals across all active and replica buckets for sync_write_accepted_count, sync_write_committed_count, and sync_write_aborted_count. The names of these summary statistics are vb_active_sync_write_aborted_count, vb_relica_sync_write_aborted_count, and so forth.

    Table 2. Additional vBucket statistics for ephemeral buckets
    Name Description

    seqlist_count

    Number of documents in this vBucket’s sequence list.

    seqlist_deleted_count

    Count of deleted documents in this vBucket’s sequence list.

    seqlist_high_seqno

    High sequence number in sequence list for this vBucket.

    seqlist_highest_deduped_seqno

    Highest de-duplicated sequence number in sequence list for this vBucket.

    seqlist_read_range_begin

    Starting sequence number for this vBucket’s sequence list read range. Marks the lower bound of possible stale documents in the sequence list.

    seqlist_read_range_end

    Ending sequence number for this vBucket’s sequence list read range. Marks the upper bound of possible stale documents in the sequence list.

    seqlist_read_range_count

    Count of elements for this vBucket’s sequence list read range, i.e. end - begin.

    seqlist_stale_count

    Count of stale documents in this vBucket’s sequence list.

    seqlist_stale_value_bytes

    Number of bytes of stale values in this vBucket’s sequence list.

    seqlist_stale_metadata_bytes

    Number of bytes of stale metadata (key + fixed metadata) in this vBucket’s sequence list.

    Options

    Table 3. vbucket-details options
    Option Description

    vbid

    vBucket ID. In a standard system this will be between 0 and 1023. If not provided as part of the command then details for all vBuckets are shown.

    For common cbstats options, see cbstats.

    Example

    Request

    /opt/couchbase/bin/cbstats localhost:11210 -u Administrator -p password \
    -b travel-sample vbucket-details 1023

    Response

    vb_1023:                                 active
    vb_1023:bloom_filter:                    DOESN'T EXIST
    vb_1023:bloom_filter_key_count:          0
    vb_1023:bloom_filter_size:               0
    vb_1023:db_data_size:                    12978
    vb_1023:db_file_size:                    53339
    vb_1023:drift_ahead_threshold:           5000000000
    vb_1023:drift_ahead_threshold_exceeded:  0
    vb_1023:drift_behind_threshold:          5000000000
    vb_1023:drift_behind_threshold_exceeded: 0
    vb_1023:high_completed_seqno:            0
    vb_1023:high_prepared_seqno:             0
    vb_1023:high_seqno:                      20
    vb_1023:hp_vb_req_size:                  0
    vb_1023:ht_cache_size:                   12459
    vb_1023:ht_item_memory:                  12459
    vb_1023:ht_item_memory_uncompressed:     23221
    vb_1023:ht_memory:                       2584
    vb_1023:ht_size:                         47
    vb_1023:logical_clock_ticks:             0
    vb_1023:max_cas:                         1572448621032374272
    vb_1023:max_cas_str:                     2019-10-30T15:17:01.32374272
    vb_1023:max_deleted_revid:               0
    vb_1023:might_contain_xattrs:            false
    vb_1023:num_ejects:                      0
    vb_1023:num_items:                       20
    vb_1023:num_non_resident:                0
    vb_1023:num_prepared_sync_writes:        0
    vb_1023:num_temp_items:                  0
    vb_1023:ops_create:                      0
    vb_1023:ops_delete:                      0
    vb_1023:ops_get:                         0
    vb_1023:ops_reject:                      0
    vb_1023:ops_update:                      0
    vb_1023:pending_writes:                  0
    vb_1023:purge_seqno:                     0
    vb_1023:queue_age:                       0
    vb_1023:queue_drain:                     1
    vb_1023:queue_fill:                      1
    vb_1023:queue_memory:                    0
    vb_1023:queue_size:                      0
    vb_1023:rollback_item_count:             0
    vb_1023:sync_write_aborted_count:        0
    vb_1023:sync_write_accepted_count:       0
    vb_1023:sync_write_committed_count:      0
    vb_1023:topology:                        [["ns_1@127.0.0.1",null]]
    vb_1023:total_abs_drift:                 0
    vb_1023:total_abs_drift_count:           0
    vb_1023:uuid:                            6840736809150