1
0
mirror of git://sourceware.org/git/lvm2.git synced 2024-12-21 13:34:40 +03:00

doc: update dmstats.8.in for --filemap and --nogroup

This commit is contained in:
Bryn M. Reeves 2016-07-01 21:41:25 +01:00
parent 7ebe630b69
commit d901468a27

View File

@ -87,6 +87,9 @@ dmstats \(em device-mapper statistics management
. IR area_size ]
. RB [ \-\-bounds
. IR \%histogram_boundaries ]
. RB [ \-\-filemap
. IR path ]
. RB [ \-\-nogroup ]
. RB [ \-\-precise ]
. RB [ \-\-start
. IR start_sector
@ -299,6 +302,14 @@ When peforming a list or report, include objects of type group in the
results.
.
.HP
.BR \-\-filemap
.IR path
.br
Instead of creating regions specified by command line options, open
the file found at \fBpath\fP, and create regions corresponding to the
locations of the on-disk extents allocated to the file.
.
.HP
.BR \-\-groupid
.IR id
.br
@ -356,6 +367,12 @@ Specify the major number.
Specify the minor number.
.
.HP
.BR \-\-nogroup
.br
When creating regions mapping the extents of a file in the file
system, do not create a group or set an alias.
.
.HP
.BR \-\-nosuffix
.br
Suppress the suffix on output sizes. Use with \fB\-\-units\fP
@ -538,8 +555,27 @@ device-mapper kernel statistics subsystem.
By default dmstats creates regions with a \fBprogram_id\fP of
"dmstats".
On success the \fBregion_id\fP of the newly created region is printed to
stdout.
On success the \fBregion_id\fP of the newly created region is printed
to stdout.
If the \fB\-\-filemap\fP option is given with a regular file as the
\fBpath\fP argument, instead of creating regions with parameters
specified on the command line, \fBdmstats\fP will open the file located
at \fBpath\fP and create regions corresponding to the physical extents
allocated to the file. This can be used to monitor statistics for
individual files in the file system, for example, virtual machine
images, swap areas, or large database files.
To work with the \fB\-\-filemap\fP option, files must be located on a
local file system, backed by a device-mapper device, that supports
physical extent data using the FIEMAP ioctl (Ext4 and XFS for e.g.).
By default regions that map a file are placed into a group and the
group alias is set to the basename of the file. This behaviour can be
overridden with the \fB\-\-alias\fP and \fB\-\-nogroup\fP options.
To display only group information when listing and reporting, use the
\fB\-\-statstype\fP option with the 'group' type.
.
.HP
.CMD_DELETE
@ -1019,6 +1055,14 @@ vg00-lvol1: Created new region with 1 area(s) as region ID 1
.br
vg00-lvol1: Created new region with 1 area(s) as region ID 2
.P
Create regions mapping the file vm.img and place them into a group with
the alias set to the same name as the file.
.br
#
.B dmstats create --filemap vm.img
.br
vm.img: Created new group with 112 region(s) as group ID 3.
.P
Print raw counters for region 4 on device d0
.br
#