Skip to content

Commit fe11f85

Browse files
authored
Document 'size' label (#81)
1 parent 964dcfe commit fe11f85

15 files changed

+105
-105
lines changed

lustrefs-exporter/src/brw_stats.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,43 +18,43 @@ use crate::{
1818

1919
static DISK_IO_TOTAL: Metric = Metric {
2020
name: "lustre_disk_io_total",
21-
help: "Total number of operations the filesystem has performed for the given size.",
21+
help: "Total number of operations the filesystem has performed for the given size. 'size' label represents 'Disk I/O size', the size of each I/O operation",
2222
r#type: MetricType::Counter,
2323
};
2424

2525
static DISK_IO_FRAGS: Metric = Metric {
2626
name: "lustre_dio_frags",
27-
help: "Current disk IO fragmentation for the given size.",
27+
help: "Current disk IO fragmentation for the given size. 'size' label represents 'Disk fragmented I/Os', the number of I/Os that were not written entirely sequentially.",
2828
r#type: MetricType::Gauge,
2929
};
3030

3131
static DISK_IO: Metric = Metric {
3232
name: "lustre_disk_io",
33-
help: "Current number of I/O operations that are processing during the snapshot.",
33+
help: "Current number of I/O operations that are processing during the snapshot. 'size' label represents 'Disk I/Os in flight', the number of disk I/Os currently pending.",
3434
r#type: MetricType::Gauge,
3535
};
3636

3737
static DISCONTIGUOUS_PAGES_TOTAL: Metric = Metric {
3838
name: "lustre_discontiguous_pages_total",
39-
help: "Total number of logical discontinuities per RPC.",
39+
help: "Total number of logical discontinuities per RPC. 'size' label represents 'Discontiguous pages', the number of discontinuities in the logical file offset of each page in a single RPC.",
4040
r#type: MetricType::Counter,
4141
};
4242

4343
static DISCONTIGUOUS_BLOCKS_TOTAL: Metric = Metric {
4444
name: "lustre_discontiguous_blocks_total",
45-
help: "",
45+
help: "'size' label represents 'Discontiguous blocks', the number of discontinuities in the physical block allocation in the file system for a single RPC",
4646
r#type: MetricType::Counter,
4747
};
4848

4949
static IO_TIME_MILLISECONDS_TOTAL: Metric = Metric {
5050
name: "lustre_io_time_milliseconds_total",
51-
help: "Total time in milliseconds the filesystem has spent processing various object sizes.",
51+
help: "Total time in milliseconds the filesystem has spent processing various object sizes. 'size' label represents 'I/O time (1/1000s)', the amount of time for each I/O operation to complete.",
5252
r#type: MetricType::Counter,
5353
};
5454

5555
static PAGES_PER_BULK_RW_TOTAL: Metric = Metric {
5656
name: "lustre_pages_per_bulk_rw_total",
57-
help: "Total number of pages per block RPC.",
57+
help: "Total number of pages per block RPC. 'size' label represents 'Pages per bulk r/w', the number of pages per RPC request",
5858
r#type: MetricType::Counter,
5959
};
6060

lustrefs-exporter/src/snapshots/lustrefs_exporter__tests__host_stats_non_healthy.snap

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ lustre_capacity_kilobytes{component="ost",target="ai400x2-OST0001"} 34750424936
2121
lustre_connected_clients{component="mdt",target="ai400x2-MDT0000"} 1
2222
lustre_connected_clients{component="mdt",target="ai400x2-MDT0000"} 1
2323

24-
# HELP lustre_dio_frags Current disk IO fragmentation for the given size.
24+
# HELP lustre_dio_frags Current disk IO fragmentation for the given size. 'size' label represents 'Disk fragmented I/Os', the number of I/Os that were not written entirely sequentially.
2525
# TYPE lustre_dio_frags gauge
2626
lustre_dio_frags{component="ost",operation="read",target="ai400x2-OST0000",size="1"} 9292607
2727
lustre_dio_frags{component="ost",operation="write",target="ai400x2-OST0000",size="1"} 4076945
@@ -56,7 +56,7 @@ lustre_dio_frags{component="ost",operation="write",target="ai400x2-OST0001",size
5656
lustre_dio_frags{component="ost",operation="read",target="ai400x2-OST0001",size="8"} 57294
5757
lustre_dio_frags{component="ost",operation="write",target="ai400x2-OST0001",size="8"} 39039
5858

59-
# HELP lustre_discontiguous_blocks_total
59+
# HELP lustre_discontiguous_blocks_total 'size' label represents 'Discontiguous blocks', the number of discontinuities in the physical block allocation in the file system for a single RPC
6060
# TYPE lustre_discontiguous_blocks_total counter
6161
lustre_discontiguous_blocks_total{component="ost",operation="read",target="ai400x2-OST0000",size="0"} 9292664
6262
lustre_discontiguous_blocks_total{component="ost",operation="write",target="ai400x2-OST0000",size="0"} 4072612
@@ -141,7 +141,7 @@ lustre_discontiguous_blocks_total{component="ost",operation="write",target="ai40
141141
lustre_discontiguous_blocks_total{component="ost",operation="read",target="ai400x2-OST0001",size="31"} 0
142142
lustre_discontiguous_blocks_total{component="ost",operation="write",target="ai400x2-OST0001",size="31"} 1
143143

144-
# HELP lustre_discontiguous_pages_total Total number of logical discontinuities per RPC.
144+
# HELP lustre_discontiguous_pages_total Total number of logical discontinuities per RPC. 'size' label represents 'Discontiguous pages', the number of discontinuities in the logical file offset of each page in a single RPC.
145145
# TYPE lustre_discontiguous_pages_total counter
146146
lustre_discontiguous_pages_total{component="ost",operation="read",target="ai400x2-OST0000",size="0"} 9351652
147147
lustre_discontiguous_pages_total{component="ost",operation="write",target="ai400x2-OST0000",size="0"} 4114231
@@ -156,7 +156,7 @@ lustre_discontiguous_pages_total{component="ost",operation="write",target="ai400
156156
lustre_discontiguous_pages_total{component="ost",operation="read",target="ai400x2-OST0001",size="2"} 0
157157
lustre_discontiguous_pages_total{component="ost",operation="write",target="ai400x2-OST0001",size="2"} 2
158158

159-
# HELP lustre_disk_io Current number of I/O operations that are processing during the snapshot.
159+
# HELP lustre_disk_io Current number of I/O operations that are processing during the snapshot. 'size' label represents 'Disk I/Os in flight', the number of disk I/Os currently pending.
160160
# TYPE lustre_disk_io gauge
161161
lustre_disk_io{component="ost",operation="read",target="ai400x2-OST0000",size="1"} 2499387
162162
lustre_disk_io{component="ost",operation="write",target="ai400x2-OST0000",size="1"} 1187036
@@ -283,7 +283,7 @@ lustre_disk_io{component="ost",operation="write",target="ai400x2-OST0001",size="
283283
lustre_disk_io{component="ost",operation="read",target="ai400x2-OST0001",size="31"} 168860
284284
lustre_disk_io{component="ost",operation="write",target="ai400x2-OST0001",size="31"} 377811
285285

286-
# HELP lustre_disk_io_total Total number of operations the filesystem has performed for the given size.
286+
# HELP lustre_disk_io_total Total number of operations the filesystem has performed for the given size. 'size' label represents 'Disk I/O size', the size of each I/O operation
287287
# TYPE lustre_disk_io_total counter
288288
lustre_disk_io_total{component="ost",operation="read",target="ai400x2-OST0000",size="4096"} 48747
289289
lustre_disk_io_total{component="ost",operation="write",target="ai400x2-OST0000",size="4096"} 9253
@@ -386,7 +386,7 @@ lustre_inodes_maximum{component="mdt",target="ai400x2-MDT0000"} 289887952
386386
lustre_inodes_maximum{component="ost",target="ai400x2-OST0000"} 274726912
387387
lustre_inodes_maximum{component="ost",target="ai400x2-OST0001"} 274726912
388388

389-
# HELP lustre_io_time_milliseconds_total Total time in milliseconds the filesystem has spent processing various object sizes.
389+
# HELP lustre_io_time_milliseconds_total Total time in milliseconds the filesystem has spent processing various object sizes. 'size' label represents 'I/O time (1/1000s)', the amount of time for each I/O operation to complete.
390390
# TYPE lustre_io_time_milliseconds_total counter
391391
lustre_io_time_milliseconds_total{component="ost",operation="read",target="ai400x2-OST0000",size="1"} 9244557
392392
lustre_io_time_milliseconds_total{component="ost",operation="write",target="ai400x2-OST0000",size="1"} 3616861
@@ -511,7 +511,7 @@ lustre_oss_ost_stats{operation="ost_sync",units="usec"} 56
511511
lustre_oss_ost_stats{operation="ost_set_info",units="usec"} 20
512512
lustre_oss_ost_stats{operation="obd_ping",units="usec"} 1050
513513

514-
# HELP lustre_pages_per_bulk_rw_total Total number of pages per block RPC.
514+
# HELP lustre_pages_per_bulk_rw_total Total number of pages per block RPC. 'size' label represents 'Pages per bulk r/w', the number of pages per RPC request
515515
# TYPE lustre_pages_per_bulk_rw_total counter
516516
lustre_pages_per_bulk_rw_total{component="ost",operation="read",target="ai400x2-OST0000",size="1"} 45221
517517
lustre_pages_per_bulk_rw_total{component="ost",operation="write",target="ai400x2-OST0000",size="1"} 192

lustrefs-exporter/src/snapshots/lustrefs_exporter__tests__lnetctl_stats.snap

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ lustre_capacity_kilobytes{component="ost",target="ai400x2-OST0001"} 355844351344
2121
lustre_connected_clients{component="mdt",target="ai400x2-MDT0000"} 17
2222
lustre_connected_clients{component="mdt",target="ai400x2-MDT0000"} 17
2323

24-
# HELP lustre_dio_frags Current disk IO fragmentation for the given size.
24+
# HELP lustre_dio_frags Current disk IO fragmentation for the given size. 'size' label represents 'Disk fragmented I/Os', the number of I/Os that were not written entirely sequentially.
2525
# TYPE lustre_dio_frags gauge
2626
lustre_dio_frags{component="ost",operation="read",target="ai400x2-OST0000",size="1"} 51611589
2727
lustre_dio_frags{component="ost",operation="write",target="ai400x2-OST0000",size="1"} 7603209
@@ -30,7 +30,7 @@ lustre_dio_frags{component="ost",operation="write",target="ai400x2-OST0001",size
3030
lustre_dio_frags{component="ost",operation="read",target="ai400x2-OST0001",size="2"} 0
3131
lustre_dio_frags{component="ost",operation="write",target="ai400x2-OST0001",size="2"} 1
3232

33-
# HELP lustre_discontiguous_blocks_total
33+
# HELP lustre_discontiguous_blocks_total 'size' label represents 'Discontiguous blocks', the number of discontinuities in the physical block allocation in the file system for a single RPC
3434
# TYPE lustre_discontiguous_blocks_total counter
3535
lustre_discontiguous_blocks_total{component="ost",operation="read",target="ai400x2-OST0000",size="0"} 51611589
3636
lustre_discontiguous_blocks_total{component="ost",operation="write",target="ai400x2-OST0000",size="0"} 7603209
@@ -39,7 +39,7 @@ lustre_discontiguous_blocks_total{component="ost",operation="write",target="ai40
3939
lustre_discontiguous_blocks_total{component="ost",operation="read",target="ai400x2-OST0001",size="1"} 0
4040
lustre_discontiguous_blocks_total{component="ost",operation="write",target="ai400x2-OST0001",size="1"} 2
4141

42-
# HELP lustre_discontiguous_pages_total Total number of logical discontinuities per RPC.
42+
# HELP lustre_discontiguous_pages_total Total number of logical discontinuities per RPC. 'size' label represents 'Discontiguous pages', the number of discontinuities in the logical file offset of each page in a single RPC.
4343
# TYPE lustre_discontiguous_pages_total counter
4444
lustre_discontiguous_pages_total{component="ost",operation="read",target="ai400x2-OST0000",size="0"} 51611589
4545
lustre_discontiguous_pages_total{component="ost",operation="write",target="ai400x2-OST0000",size="0"} 7603209
@@ -48,7 +48,7 @@ lustre_discontiguous_pages_total{component="ost",operation="write",target="ai400
4848
lustre_discontiguous_pages_total{component="ost",operation="read",target="ai400x2-OST0001",size="1"} 0
4949
lustre_discontiguous_pages_total{component="ost",operation="write",target="ai400x2-OST0001",size="1"} 1
5050

51-
# HELP lustre_disk_io Current number of I/O operations that are processing during the snapshot.
51+
# HELP lustre_disk_io Current number of I/O operations that are processing during the snapshot. 'size' label represents 'Disk I/Os in flight', the number of disk I/Os currently pending.
5252
# TYPE lustre_disk_io gauge
5353
lustre_disk_io{component="ost",operation="read",target="ai400x2-OST0000",size="1"} 4492529
5454
lustre_disk_io{component="ost",operation="write",target="ai400x2-OST0000",size="1"} 894259
@@ -175,7 +175,7 @@ lustre_disk_io{component="ost",operation="write",target="ai400x2-OST0001",size="
175175
lustre_disk_io{component="ost",operation="read",target="ai400x2-OST0001",size="31"} 237804
176176
lustre_disk_io{component="ost",operation="write",target="ai400x2-OST0001",size="31"} 2973447
177177

178-
# HELP lustre_disk_io_total Total number of operations the filesystem has performed for the given size.
178+
# HELP lustre_disk_io_total Total number of operations the filesystem has performed for the given size. 'size' label represents 'Disk I/O size', the size of each I/O operation
179179
# TYPE lustre_disk_io_total counter
180180
lustre_disk_io_total{component="ost",operation="read",target="ai400x2-OST0000",size="65536"} 0
181181
lustre_disk_io_total{component="ost",operation="write",target="ai400x2-OST0000",size="65536"} 1
@@ -262,7 +262,7 @@ lustre_inodes_maximum{component="mdt",target="ai400x2-MDT0000"} 289887952
262262
lustre_inodes_maximum{component="ost",target="ai400x2-OST0000"} 274726912
263263
lustre_inodes_maximum{component="ost",target="ai400x2-OST0001"} 274726912
264264

265-
# HELP lustre_io_time_milliseconds_total Total time in milliseconds the filesystem has spent processing various object sizes.
265+
# HELP lustre_io_time_milliseconds_total Total time in milliseconds the filesystem has spent processing various object sizes. 'size' label represents 'I/O time (1/1000s)', the amount of time for each I/O operation to complete.
266266
# TYPE lustre_io_time_milliseconds_total counter
267267
lustre_io_time_milliseconds_total{component="ost",operation="read",target="ai400x2-OST0000",size="1"} 50373687
268268
lustre_io_time_milliseconds_total{component="ost",operation="write",target="ai400x2-OST0000",size="1"} 4280167
@@ -341,7 +341,7 @@ lustre_mem_used 3642490860
341341
# TYPE lustre_mem_used_max gauge
342342
lustre_mem_used_max 5683347385
343343

344-
# HELP lustre_pages_per_bulk_rw_total Total number of pages per block RPC.
344+
# HELP lustre_pages_per_bulk_rw_total Total number of pages per block RPC. 'size' label represents 'Pages per bulk r/w', the number of pages per RPC request
345345
# TYPE lustre_pages_per_bulk_rw_total counter
346346
lustre_pages_per_bulk_rw_total{component="ost",operation="read",target="ai400x2-OST0000",size="16"} 0
347347
lustre_pages_per_bulk_rw_total{component="ost",operation="write",target="ai400x2-OST0000",size="16"} 1

lustrefs-exporter/src/snapshots/lustrefs_exporter__tests__lnetctl_stats_mds.snap

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ lustre_client_stats{operation="openclosetime",target="fs-ffff9f7daee63800"} 2
8989
# TYPE lustre_connected_clients gauge
9090
lustre_connected_clients{component="mdt",target="fs-MDT0000"} 1
9191

92-
# HELP lustre_dio_frags Current disk IO fragmentation for the given size.
92+
# HELP lustre_dio_frags Current disk IO fragmentation for the given size. 'size' label represents 'Disk fragmented I/Os', the number of I/Os that were not written entirely sequentially.
9393
# TYPE lustre_dio_frags gauge
9494
lustre_dio_frags{component="mdt",operation="read",target="fs-MDT0000",size="1"} 1
9595
lustre_dio_frags{component="mdt",operation="write",target="fs-MDT0000",size="1"} 0
@@ -112,7 +112,7 @@ lustre_dio_frags{component="ost",operation="write",target="fs-OST0000",size="2"}
112112
lustre_dio_frags{component="ost",operation="read",target="fs-OST0000",size="3"} 0
113113
lustre_dio_frags{component="ost",operation="write",target="fs-OST0000",size="3"} 7
114114

115-
# HELP lustre_discontiguous_blocks_total
115+
# HELP lustre_discontiguous_blocks_total 'size' label represents 'Discontiguous blocks', the number of discontinuities in the physical block allocation in the file system for a single RPC
116116
# TYPE lustre_discontiguous_blocks_total counter
117117
lustre_discontiguous_blocks_total{component="mdt",operation="read",target="fs-MDT0000",size="0"} 1
118118
lustre_discontiguous_blocks_total{component="mdt",operation="write",target="fs-MDT0000",size="0"} 0
@@ -131,7 +131,7 @@ lustre_discontiguous_blocks_total{component="ost",operation="write",target="fs-O
131131
lustre_discontiguous_blocks_total{component="ost",operation="read",target="fs-OST0000",size="1"} 0
132132
lustre_discontiguous_blocks_total{component="ost",operation="write",target="fs-OST0000",size="1"} 7
133133

134-
# HELP lustre_discontiguous_pages_total Total number of logical discontinuities per RPC.
134+
# HELP lustre_discontiguous_pages_total Total number of logical discontinuities per RPC. 'size' label represents 'Discontiguous pages', the number of discontinuities in the logical file offset of each page in a single RPC.
135135
# TYPE lustre_discontiguous_pages_total counter
136136
lustre_discontiguous_pages_total{component="mdt",operation="read",target="fs-MDT0000",size="0"} 2
137137
lustre_discontiguous_pages_total{component="mdt",operation="write",target="fs-MDT0000",size="0"} 1
@@ -146,7 +146,7 @@ lustre_discontiguous_pages_total{component="ost",operation="write",target="fs-OS
146146
lustre_discontiguous_pages_total{component="ost",operation="read",target="fs-OST0000",size="1"} 0
147147
lustre_discontiguous_pages_total{component="ost",operation="write",target="fs-OST0000",size="1"} 7
148148

149-
# HELP lustre_disk_io Current number of I/O operations that are processing during the snapshot.
149+
# HELP lustre_disk_io Current number of I/O operations that are processing during the snapshot. 'size' label represents 'Disk I/Os in flight', the number of disk I/Os currently pending.
150150
# TYPE lustre_disk_io gauge
151151
lustre_disk_io{component="mdt",operation="read",target="fs-MDT0000",size="1"} 2
152152
lustre_disk_io{component="mdt",operation="write",target="fs-MDT0000",size="1"} 1
@@ -209,7 +209,7 @@ lustre_disk_io{component="ost",operation="write",target="fs-OST0000",size="12"}
209209
lustre_disk_io{component="ost",operation="read",target="fs-OST0000",size="13"} 0
210210
lustre_disk_io{component="ost",operation="write",target="fs-OST0000",size="13"} 2
211211

212-
# HELP lustre_disk_io_total Total number of operations the filesystem has performed for the given size.
212+
# HELP lustre_disk_io_total Total number of operations the filesystem has performed for the given size. 'size' label represents 'Disk I/O size', the size of each I/O operation
213213
# TYPE lustre_disk_io_total counter
214214
lustre_disk_io_total{component="mdt",operation="read",target="fs-MDT0000",size="4096"} 1
215215
lustre_disk_io_total{component="mdt",operation="write",target="fs-MDT0000",size="4096"} 0
@@ -328,7 +328,7 @@ lustre_inodes_maximum{component="mdt",target="fs-MDT0000"} 1885696
328328
lustre_inodes_maximum{component="ost",target="fs-OST0000"} 40960
329329
lustre_inodes_maximum{component="ost",target="fs-OST0001"} 40960
330330

331-
# HELP lustre_io_time_milliseconds_total Total time in milliseconds the filesystem has spent processing various object sizes.
331+
# HELP lustre_io_time_milliseconds_total Total time in milliseconds the filesystem has spent processing various object sizes. 'size' label represents 'I/O time (1/1000s)', the amount of time for each I/O operation to complete.
332332
# TYPE lustre_io_time_milliseconds_total counter
333333
lustre_io_time_milliseconds_total{component="mdt",operation="read",target="fs-MDT0000",size="4"} 1
334334
lustre_io_time_milliseconds_total{component="mdt",operation="write",target="fs-MDT0000",size="4"} 0
@@ -562,7 +562,7 @@ lustre_oss_ost_stats{operation="ost_disconnect",units="usecs"} 2
562562
lustre_oss_ost_stats{operation="ost_set_info",units="usecs"} 5
563563
lustre_oss_ost_stats{operation="obd_ping",units="usecs"} 269
564564

565-
# HELP lustre_pages_per_bulk_rw_total Total number of pages per block RPC.
565+
# HELP lustre_pages_per_bulk_rw_total Total number of pages per block RPC. 'size' label represents 'Pages per bulk r/w', the number of pages per RPC request
566566
# TYPE lustre_pages_per_bulk_rw_total counter
567567
lustre_pages_per_bulk_rw_total{component="mdt",operation="read",target="fs-MDT0000",size="1"} 1
568568
lustre_pages_per_bulk_rw_total{component="mdt",operation="write",target="fs-MDT0000",size="1"} 0

0 commit comments

Comments
 (0)