1yambar-modules-disk-io(5)     File Formats Manual    yambar-modules-disk-io(5)
2
3
4

NAME

6       disk-io - This module keeps track of the amount of bytes being
7       read/written from/to disk. It can distinguish between all partitions
8       currently present in the machine.
9

TAGS

11       ┌────────────────┬─────────┬───────────────────────────────────────────┐
12Name            Type    Description                               
13       ├────────────────┼─────────┼───────────────────────────────────────────┤
14       │device          │ string  │ Name of the device being tracked (use the │
15       │                │         │ command lsblk to see these). There is a   │
16       │                │         │ special device, "Total", that reports the │
17       │                │         │ total stats for the machine               │
18       ├────────────────┼─────────┼───────────────────────────────────────────┤
19       │is_disk         │ boolean │ whether or not the device is a disk (e.g. │
20       │                │         │ sda, sdb) or a partition (e.g. sda1,      │
21       │                │         │ sda2, ...). "Total" is advertised as a    │
22       │                │         │ disk.                                     │
23       ├────────────────┼─────────┼───────────────────────────────────────────┤
24       │read_speed      │ int     │ bytes read, in bytes/s                    │
25       ├────────────────┼─────────┼───────────────────────────────────────────┤
26       │write_speed     │ int     │ bytes written, in bytes/s                 │
27       ├────────────────┼─────────┼───────────────────────────────────────────┤
28       │ios_in_progress │ int     │ number of ios that are happening at the   │
29       │                │         │ time of polling                           │
30       └────────────────┴─────────┴───────────────────────────────────────────┘
31

CONFIGURATION

33       ┌──────────────┬──────┬─────┬──────────────────────────────────────────┐
34Name          Type Req Description                              
35       ├──────────────┼──────┼─────┼──────────────────────────────────────────┤
36       │poll-interval │ int  │ no  │ Refresh interval of disk's stats in mil‐ │
37       │              │      │     │ liseconds (default=500). Cannot be less  │
38       │              │      │     │ then 250ms.                              │
39       └──────────────┴──────┴─────┴──────────────────────────────────────────┘
40

EXAMPLES

42       This reports the total amount of bytes being read and written every
43       second, formatting in b/s, kb/s, mb/s, or gb/s, as appropriate.
44
45           bar:
46             left:
47               - disk-io:
48                   poll-interval: 1000
49                   content:
50                     map:
51                       conditions:
52                         device == Total:
53                           list:
54                             items:
55                               - string: {text: "Total read: "}
56                               - map:
57                                   default: {string: {text: "{read_speed} B/s"}}
58                                   conditions:
59                                     read_speed > 1073741824:
60                                       string: {text: "{read_speed:gib} GB/s"}
61                                     read_speed > 1048576:
62                                       string: {text: "{read_speed:mib} MB/s"}
63                                     read_speed > 1024:
64                                       string: {text: "{read_speed:kib} KB/s"}
65                               - string: {text: " | "}
66                               - string: {text: "Total written: "}
67                               - map:
68                                   default: {string: {text: "{write_speed} B/s"}}
69                                   conditions:
70                                     write_speed > 1073741824:
71                                       string: {text: "{write_speed:gib} GB/s"}
72                                     write_speed > 1048576:
73                                       string: {text: "{write_speed:mib} MB/s"}
74                                     write_speed > 1024:
75                                       string: {text: "{write_speed:kib} KB/s"}
76

SEE ALSO

78       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
79       tions(5)
80
81
82
83                                  2023-07-22         yambar-modules-disk-io(5)
Impressum