vdostats - Display configuration and statistics of VDO volumes

Description

vdostats  displays  configuration and statistics information for the given VDO devices. If no devices are
       given, it displays information about all VDO devices.

       The VDO devices must be running in order for configuration and statistics
              information to be reported.

Examples

       The following example shows sample output if no options are provided:

       Device             1K-blocks  Used       Available   Use% Space Saving%
       /dev/mapper/my_vdo 1932562432 427698104  1504864328  22%  21%

       With the --human-readable option, block counts are converted to conventional units (1 KB = 1024 bytes):

       Device             Size   Used    Available   Use%   Space Saving%
       /dev/mapper/my_vdo 1.8T   407.9G  1.4T        22%    21%

       With the --si option as well, the block counts are reported using SI units (1 KB = 1000 bytes):

       Device             Size   Used    Available   Use%    Space Saving%
       /dev/mapper/my_vdo 2.0T   438G    1.5T        22%     21%

Name

       vdostats - Display configuration and statistics of VDO volumes

Notes

       The output may be incomplete when the command is run by an unprivileged user.

Options

-h, --help
              Show help message and exit.

       -a, --all
              This option is only for backwards compatibility. It is now equivalent to --verbose.

       --human-readable
              Display block values in readable form (Base 2: 1 KB = 2^10 bytes = 1024 bytes).

       --si   Modifies the output of the --human-readable option to use SI units (Base 10: 1 KB = 10^3  bytes  =
              1000 bytes). If the --human-readable option is not supplied, this option has no effect.

       -v, --verbose
              Displays the utilization and block I/O (bios) statistics for the selected VDO devices.

       -V, --version
              Prints the vdostats version number and exits

Output

       The default output format is a table with the following columns, similar to that of the Linux df utility:

       Device The path to the VDO volume

       1K-blocks
              The  total  number  of 1K blocks allocated for a VDO volume (= physical volume size * block size /
              1024)

       Used   The total number of 1K blocks used on a VDO volume (= physical blocks used * block size / 1024)

       Available
              The total number of 1K blocks available on a VDO volume (= physical blocks free  *  block  size  /
              1024)

       Use%   The percentage of physical blocks used on a VDO volume (= used blocks / allocated blocks * 100)

       SpaceSaving%
              The  percentage of physical blocks saved on a VDO volume (= [logical blocks used - physical blocks
              used] / logical blocks used)

Synopsis

vdostats [options...] [device[device...]]

Verbose Output

The --verbose option displays VDO device statistics in YAML format for the specified VDO devices. The
following fields will continue to be reported in future releases. Management tools should not rely upon
the order in which any of the statistics are reported.

version
The version of these statistics.

releaseversion
The release version of the VDO.

datablocksused
The number of physical blocks currently in use by a VDO volume to store data.

overheadblocksused
The number of physical blocks currently in use by a VDO volume to store VDO metadata.

logicalblocksused
The number of logical blocks currently mapped.

physicalblocks
The total number of physical blocks allocated for a VDO volume.

logicalblocks
The maximum number of logical blocks that can be mapped by a VDO volume.

1K-blocks
The total number of 1K blocks allocated for a VDO volume (= physical volume size * block size /
1024)

1K-blocksused
The total number of 1K blocks used on a VDO volume (= physical blocks used * block size / 1024)

1K-blocksavailable
The total number of 1K blocks available on a VDO volume (= physical blocks free * block size /
1024)

usedpercent
The percentage of physical blocks used on a VDO volume (= used blocks / allocated blocks * 100)

savingpercent
The percentage of physical blocks saved on a VDO volume (= [logical blocks used - physical blocks
used] / logical blocks used)

blockmapcachesize
The size of the block map cache, in bytes.

writepolicy
The write policy (sync, async, or async-unsafe). This is configured via vdomodify--writePolicy=policy.

blocksize
The block size of a VDO volume, in bytes.

completedrecoverycount
The number of times a VDO volume has recovered from an unclean shutdown.

read-onlyrecoverycount
The number of times a VDO volume has been recovered from read-only mode (via vdostart--forceRebuild).

operatingmode
Indicates whether a VDO volume is operating normally, is in recovery mode, or is in read-only
mode.

recoveryprogress(%)
Indicates online recovery progress, or N/A if the volume is not in recovery mode.

compressedfragmentswritten
The number of compressed fragments that have been written since the VDO volume was last restarted.

compressedblockswritten
The number of physical blocks of compressed data that have been written since the VDO volume was
last restarted.

The remaining fields are primarily intended for software support and are subject to change in future
releases; management tools should not rely upon them.

compressedfragmentsinpacker
The number of compressed fragments being processed that have not yet been written.

slabcount
The total number of slabs.

slabsopened
The total number of slabs from which blocks have ever been allocated.

slabsreopened
The number of times slabs have been re-opened since the VDO was started.

journaldiskfullcount
The number of times a request could not make a recovery journal entry because the recovery journal
was full.

journalcommitsrequestedcount
The number of times the recovery journal requested slab journal commits.

journalentriesbatching
The number of journal entry writes started minus the number of journal entries written.

journalentriesstarted
The number of journal entries which have been made in memory.

journalentrieswriting
The number of journal entries in submitted writes minus the number of journal entries committed to
storage.

journalentrieswritten
The total number of journal entries for which a write has been issued.

journalentriescommitted
The number of journal entries written to storage.

journalblocksbatching
The number of journal block writes started minus the number of journal blocks written.

journalblocksstarted
The number of journal blocks which have been touched in memory.

journalblockswriting
The number of journal blocks written (with metadatata in active memory) minus the number of
journal blocks committed.

journalblockswritten
The total number of journal blocks for which a write has been issued.

journalblockscommitted
The number of journal blocks written to storage.

slabjournaldiskfullcount
The number of times an on-disk slab journal was full.

slabjournalflushcount
The number of times an entry was added to a slab journal that was over the flush threshold.

slabjournalblockedcount
The number of times an entry was added to a slab journal that was over the blocking threshold.

slabjournalblockswritten
The number of slab journal block writes issued.

slabjournaltailbusycount
The number of times write requests blocked waiting for a slab journal write.

slabsummaryblockswritten
The number of slab summary block writes issued.

referenceblockswritten
The number of reference block writes issued.

blockmapdirtypages
The number of dirty pages in the block map cache.

blockmapcleanpages
The number of clean pages in the block map cache.

blockmapfreepages
The number of free pages in the block map cache.

blockmapfailedpages
The number of block map cache pages that have write errors.

blockmapincomingpages
The number of block map cache pages that are being read into the cache.

blockmapoutgoingpages
The number of block map cache pages that are being written.

blockmapcachepressure
The number of times a free page was not available when needed.

blockmapreadcount
The total number of block map page reads.

blockmapwritecount
The total number of block map page writes.

blockmapfailedreads
The total number of block map read errors.

blockmapfailedwrites
The total number of block map write errors.

blockmapreclaimed
The total number of block map pages that were reclaimed.

blockmapreadoutgoing
The total number of block map reads for pages that were being written.

blockmapfoundincache
The total number of block map cache hits.

blockmapdiscardrequired
The total number of block map requests that required a page to be discarded.

blockmapwaitforpage
The total number of requests that had to wait for a page.

blockmapfetchrequired
The total number of requests that required a page fetch.

blockmappagesloaded
The total number of page fetches.

blockmappagessaved
The total number of page saves.

blockmapflushcount
The total number of flushes issued by the block map.

invalidadvicePBNcount
The number of times the index returned invalid advice

nospaceerrorcount
The number of write requests which failed due to the VDO volume being out of space.

readonlyerrorcount
The number of write requests which failed due to the VDO volume being in read-only mode.

instance
The VDO instance.

512byteemulation
Indicates whether 512 byte emulation is on or off for the volume.

currentVDOIOrequestsinprogress
The number of I/O requests the VDO is current processing.

maximumVDOIOrequestsinprogress
The maximum number of simultaneous I/O requests the VDO has processed.

currentdedupequeries
The number of deduplication queries currently in flight.

maximumdedupequeries
The maximum number of in-flight deduplication queries.

dedupeadvicevalid
The number of times deduplication advice was correct.

dedupeadvicestale
The number of times deduplication advice was incorrect.

dedupeadvicetimeouts
The number of times deduplication queries timed out.

concurrentdatamatches
The number of writes with the same data as another in-flight write.

concurrenthashcollisions
The number of writes whose hash collided with an in-flight write.

flushout
The number of flush requests submitted by VDO to the underlying storage.

writeamplificationratio
The average number of block writes to the underlying storage per block written to the VDO device.

biosin...biosinpartial...biosout...biosmeta...biosjournal...biospagecache...biosoutcompleted...biosmetacompleted...biosjournalcompleted...biospagecachecompleted...biosacknowledged...biosacknowledgedpartial...biosinprogress...
These statistics count the number of bios in each category with a given flag. The categories are:

biosin
The number of block I/O requests received by VDO.

biosinpartial
The number of partial block I/O requests received by VDO. Applies only to 512-byte
emulation mode.

biosout
The number of non-metadata block I/O requests submitted by VDO to the storage device.

biosmeta
The number of metadata block I/O requests submitted by VDO to the storage device.

biosjournal
The number of recovery journal block I/O requests submitted by VDO to the storage device.

biospagecache
The number of block map I/O requests submitted by VDO to the storage device.

biosoutcompleted
The number of non-metadata block I/O requests completed by the storage device.

biosmetacompleted
The number of metadata block I/O requests completed by the storage device.

biosjournalcompleted
The number of recovery journal block I/O requests completed by the storage device.

biospagecachecompleted
The number of block map I/O requests completed by the storage device.

biosacknowledged
The number of block I/O requests acknowledged by VDO.

biosacknowledgedpartial
The number of partial block I/O requests acknowledged by VDO. Applies only to 512-byte
emulation mode.

biosinprogress
The number of bios submitted to the VDO which have not yet been acknowledged.

There are five types of flags:

read The number of non-write bios (bios without the REQ_WRITE flag set)

write The number of write bios (bios with the REQ_WRITE flag set)

discard
The number of bios with a REQ_DISCARD flag set

flush The number of flush bios (bios with the REQ_FLUSH flag set)

fua The number of "force unit access" bios (bios with the REQ_FUA flag set)

Note that all bios will be counted as either read or write bios, depending on the REQ_WRITE flag
setting, regardless of whether any of the other flags are set.

KVDOmodulebytesused
The current count of bytes allocated by the kernel VDO module.

KVDOmodulepeakbytesused
The peak count of bytes allocated by the kernel VDO module, since the module was loaded.