.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar\-modules\-disk\-io" "5" "2026\-10\-30"
.PP
.SH NAME
disk\-io \- This module keeps track of the amount of bytes being
read/written from/to disk.\& It can distinguish between all partitions
currently present in the machine.\&
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx
l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
device
T}	T{
string
T}	T{
Name of the device being tracked (use the command \fBlsblk\fR to see these).\& There is a special device, "Total", that reports the total stats for the machine
T}
T{
is_disk
T}	T{
boolean
T}	T{
whether or not the device is a disk (e.\&g.\& sda, sdb) or a partition (e.\&g.\& sda1, sda2, .\&.\&.\&).\& "Total" is advertised as a disk.\&
T}
T{
read_speed
T}	T{
int
T}	T{
bytes read, in bytes/s
T}
T{
write_speed
T}	T{
int
T}	T{
bytes written, in bytes/s
T}
T{
ios_in_progress
T}	T{
int
T}	T{
number of ios that are happening at the time of polling
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
poll\-interval
T}	T{
int
T}	T{
no
T}	T{
Refresh interval of disk'\&s stats in milliseconds (default=500).\& Cannot be less then 250ms.\&
T}
.TE
.sp 1
.SH EXAMPLES
.PP
This reports the total amount of bytes being read and written every second,
formatting in b/s, kb/s, mb/s, or gb/s, as appropriate.\&
.PP
.nf
.RS 4
bar:
  left:
    \- disk\-io:
        poll\-interval: 1000
        content:
          map:
            conditions:
              device == Total:
                list:
                  items:
                    \- string: {text: "Total read: "}
                    \- map:
                        default: {string: {text: "{read_speed} B/s"}}
                        conditions:
                          read_speed > 1073741824:
                            string: {text: "{read_speed:gib} GB/s"}
                          read_speed > 1048576:
                            string: {text: "{read_speed:mib} MB/s"}
                          read_speed > 1024:
                            string: {text: "{read_speed:kib} KB/s"}
                    \- string: {text: " | "}
                    \- string: {text: "Total written: "}
                    \- map:
                        default: {string: {text: "{write_speed} B/s"}}
                        conditions:
                          write_speed > 1073741824:
                            string: {text: "{write_speed:gib} GB/s"}
                          write_speed > 1048576:
                            string: {text: "{write_speed:mib} MB/s"}
                          write_speed > 1024:
                            string: {text: "{write_speed:kib} KB/s"}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar\-modules\fR(5), \fByambar\-particles\fR(5), \fByambar\-tags\fR(5), \fByambar\-decorations\fR(5)