ziomon/ziorep_traffic.8

   1 .TH ZIOMON_MGR 8 "Jul 2008" "s390-tools"
   2
   3 .SH NAME
   4 ziorep_traffic \- I/O traffic report for FCP adapters.
   5
   6 .SH SYNOPSIS
   7 .B ziorep_traffic [-V] [-v] [-h] [-b <begin>] [-e <end>] [-i <time>] [-s] [-c <chpid>] [-u <id>] [-t <num>] [-p <port>] [-l <lun>] [-d <fdev> ] [-m <mdev> ] [-x] [-D] [-C a|u|p|m|A] <filename>
   8
   9
  10
  11 .SH DESCRIPTION
  12 .B ziorep_traffic
  13 Prints a report from the specified data.
  14
  15 .SH OPTIONS
  16 .TP
  17 .BR "\-h" " or " "\-\-help"
  18 Print help information, then exit.
  19
  20 .TP
  21 .BR "\-v" " or " "\-\-version"
  22 Print version information, then exit.
  23
  24 .TP
  25 .BR "\-V" " or " "\-\-verbose"
  26 Be verbose.
  27
  28 .TP
  29 .BR "\-b" " or " "\-\-begin"
  30 Limit the timeframe to consider to data beginning with the specified date.
  31 .br
  32 Dates must be specified in the following format: YYYY-MM-DD HH:MM[:SS].
  33 .br
  34 E.g. 2008-03-21 09:08 is 9:08 on March 21, 2008.
  35
  36 .TP
  37 .BR "\-e" " or " "\-\-end"
  38 Limit the timeframe to consider to data ending with the specified date.
  39 .br
  40 Dates must be specified in the following format: YYYY-MM-DD HH:MM[:SS].
  41 .br
  42 E.g. 2008-03-21 09:08 is 9:08 on March 21, 2008.
  43
  44 .TP
  45 .BR "\-i" " or " "\-\-interval"
  46 Specify an aggregation interval. The interval is given in seconds, and must be a multiple
  47 of the interval as found in the source data.
  48
  49 .TP
  50 .BR "\-s" " or " "\-\-summary"
  51 Print a summary of the data, then exit.
  52
  53 .TP
  54 .BR "\-c" " or " "\-\-chpid"
  55 Consider the specified physical adapter. Adapters must be specified in hex.
  56 .br
  57 If multiple adapters should be specified, specify each one separately.
  58 .br
  59 E.g. '-c 7a'.
  60
  61 .TP
  62 .BR "\-u" " or " "\-\-bus-id"
  63 Consider the specified bus-IDs. bus-IDs must be specified in hex.
  64 .br
  65 If multiple bus-IDs should be specified, specify each one separately.
  66 .br
  67 E.g. '-u 0.0.4c78'.
  68
  69 .TP
  70 .BR "\-p" " or " "\-\-port"
  71 Consider the specified target port. Target ports must be specified in hex.
  72 .br
  73 If multiple ports should be specified, specify each one separately.
  74 .br
  75 E.g. '-p 0x500507630040710b'.
  76
  77 .TP
  78 .BR "\-l" " or " "\-\-lun"
  79 Consider the specified lun. luns must be specified in hex.
  80 .br
  81 If multiple luns should be specified, specify each one separately.
  82 .br
  83 E.g. '-l 0x4021402d00000000'.
  84
  85 .TP
  86 .BR "\-d" " or " "\-\-device"
  87 Consider the specified device.
  88 .br
  89 If multiple devices should be specified, specify each one separately.
  90 .br
  91 E.g. '-d sda'.
  92
  93 .TP
  94 .BR "\-m" " or " "\-\-mdev"
  95 Consider the specified multipath device.
  96 .br
  97 If multiple devices should be specified, specify each one separately.
  98 .br
  99 E.g. '-m 36005076303ffc1040002120'.
 100
 101 .TP
 102 .BR "\-x" " or " "\-\-export-csv"
 103 Write data to file(s) in CSV format. Output filenames will be based on the data filename.
 104
 105 .TP
 106 .BR "\-t" " or " "\-\-topline"
 107 Repeat topline after specified number of frames.
 108 .br
 109 0 for no repeat (default).
 110
 111 .TP
 112 .BR "\-D" " or " "\-\-detailed"
 113 Print histograms.
 114
 115 .TP
 116 .BR "\-C" " or " "\-\-collapse"
 117 Collapse the data by the specified criterion:
 118 .br
 119 .BR "a"
 120 collapse by physical adapter.
 121 .br
 122 .BR "u"
 123 collapse by bus-ID.
 124 .br
 125 .BR "p"
 126 collapse by target port.
 127 .br
 128 .BR "m"
 129 collapse by multipath device.
 130 .br
 131 .BR "A"
 132 collapse all data into a single dataset.
 133
 134
 135 .SH OUTPUT
 136 Here is a list of the columns and their descriptions.
 137 Timestamps of the frames printed depict the ending of the respective timeframe.
 138
 139 .TP
 140 .BR "I/O rt MB/s"
 141 I/O rate of the respective device in megabytes per second, considering individual requests and their total processing time, including channel latency, etc.
 142 .br
 143 .IR "min" " and " "max"
 144 give the minimum and maximum respectively.
 145
 146 .TP
 147 .BR "thrp in MB/s"
 148 Throughput of the respective device in megabytes per second, considering times of activity only.
 149 .br
 150 .IR "avg" " and " "stdev"
 151 give the average utilization as well as its standard deviation respectively.
 152
 153 .TP
 154 .BR "I/O requests"
 155 Statistics on the numbers and kinds of I/O requests seen.
 156 .br
 157 .IR "#reqs"
 158 is the total number of requests,
 159 .br
 160 .IR "rd"
 161 is the number of read requests,
 162 .br
 163 .IR "wrt"
 164 is the number of write requests and
 165 .br
 166 .IR "bidi"
 167 is the number of bi-directional requests.
 168
 169 .TP
 170 .BR "I/O subs. lat. in us"
 171 Latency of the I/O subsystem in microseconds. This is the time needed to execute a request, from the I/O stack down to the hardware and back up again.
 172 .br
 173 .IR "min" ", " "max" ", " "avg" " and " "stdev"
 174 give the minimum, maximum and average latency as well as its standard deviation respectively.
 175
 176 .TP
 177 .BR "channel lat. in us"
 178 Channel latency in microseconds. This is the time needed to execute a request on the FCP adapter.
 179 .br
 180 .IR "min" ", " "max" ", " "avg" " and " "stdev"
 181 give the minimum, maximum and average latency as well as its standard deviation respectively.
 182
 183 .TP
 184 .BR "fabric lat. in us"
 185 Fabric latency in microseconds. This is the time needed for the requests within the fabric, from the FCP adapter to the target device and back again.
 186 .br
 187 .IR "min" ", " "max" ", " "avg" " and " "stdev"
 188 give the minimum, maximum and average latency as well as its standard deviation respectively.
 189
 190
 191 .SH EXAMPLES
 192 .B Example
 193 .br
 194 Print a traffic report for all devices.
 195 Only data after 8:57 April 5, 2008 should be considered.
 196 Data should be aggregated to 60 second intervals.
 197
 198 ziorep_traffic -i 60 -b "2008-04-05 08:57" sample.log
 199
 200 .B Example
 201 .br
 202 Print a detailed traffic report for all devices connected to target port 0x500507630313c562.
 203 Data should be aggregated over the whole data range.
 204
 205 ziorep_traffic -i 0 -p 0x500507630313c562 sample.log
 206
 207 .B Example
 208 .br
 209 Print a detailed traffic report for all devices that are either connected to target port 0x500507630313c562 or part of multipath device 36005076303ffc5620000000000001314.
 210 The result should be collapsed on the bus-ID level.
 211
 212 ziorep_traffic -C u -p 0x500507630313c562 -m 36005076303ffc5620000000000001314 sample.log
 213
 214 .SH "SEE ALSO"
 215 .BR ziorep_config (8),
 216 .BR ziorep_utilization (8)