share/man/man8/poolstat.8

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH POOLSTAT 8 "Jun 16, 2009"
   7 .SH NAME
   8 poolstat \- report active pool statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBpoolstat\fR [\fB-p\fR \fIpool-list\fR] [\fB-r\fR \fIrset-list\fR] [\fB-T\fR u | d ] [\fIinterval\fR [\fIcount\fR]]
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBpoolstat\fR [\fB-p\fR \fIpool-list\fR] [\fB-o\fR \fIformat\fR \fB-r\fR \fIrset-list\fR]
  18      [\fB-T\fR u | d ] [\fIinterval\fR [\fIcount\fR]]
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBpoolstat\fR utility iteratively examines all active pools on the system.
  25 It reports statistics based on the selected output mode. \fBpoolstat\fR
  26 provides options to examine only specified pools and report resource
  27 set-specific statistics.
  28 .sp
  29 .LP
  30 Without options, \fBpoolstat\fR examines all pools, reports basic statistics
  31 for their resource sets, and exits.
  32 .SS "DISPLAY FORMATS"
  33 .sp
  34 .LP
  35 In default output format, \fBpoolstat\fR outputs a header line and a line for
  36 each pool. The line begins with the pool ID and its name, followed by a column
  37 of statistical data for the processor set attached to the pool.
  38 .sp
  39 .LP
  40 The columns are defined as follows:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBid\fR\fR
  45 .ad
  46 .RS 8n
  47 Pool ID.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBpool\fR\fR
  54 .ad
  55 .RS 8n
  56 Pool name.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBrid\fR\fR
  63 .ad
  64 .RS 8n
  65 Resource set id.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBrset\fR\fR
  72 .ad
  73 .RS 8n
  74 Resource set name.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBtype\fR\fR
  81 .ad
  82 .RS 8n
  83 Resource set type.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBmin\fR\fR
  90 .ad
  91 .RS 8n
  92 Minimum resource set size.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBmax\fR\fR
  99 .ad
 100 .RS 8n
 101 Maximum resource set size.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBsize\fR\fR
 108 .ad
 109 .RS 8n
 110 Current resource set size.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBused\fR\fR
 117 .ad
 118 .RS 8n
 119 The measure of how much of the resource set is currently is use. This is
 120 calculated as the percentage utilization of the resource set multiplied by its
 121 size. If resource set has been reconfigured during last sampling interval, this
 122 value might be not reported (\fB-\fR).
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBload\fR\fR
 129 .ad
 130 .RS 8n
 131 The absolute representation of the load that is put on the resource set. For
 132 the definition of this property see \fBlibpool\fR(3LIB).
 133 .RE
 134
 135 .SH OPTIONS
 136 .sp
 137 .LP
 138 The following options are supported:
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fB-o\fR \fIformat\fR\fR
 143 .ad
 144 .RS 16n
 145 Report statistics according to the format specification given in format. See
 146 \fBDISPLAY FORMATS\fR.
 147 .sp
 148 The \fB-o\fR option accepts lists as arguments. Items in a list can be either
 149 separated by commas or enclosed in quotes and separated by commas or spaces.
 150 .sp
 151 You can specify multiple \fB-o\fR options. The format specification is
 152 interpreted as the whitespace separated concatenation of all the format option
 153 arguments.
 154 .sp
 155 The \fB-o\fR option must be used in conjunction with the \fB-r\fR option.
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fB-p\fR \fIpool-list\fR\fR
 162 .ad
 163 .RS 16n
 164 Report only pools whose names are in the given list. If the -r option is also
 165 used, this option selects only resource sets which belong to pools in the given
 166 list. Statistics for pools or resource sets are reported in the same order in
 167 which pool names are listed on the pool-list. Pool can be specified by name or
 168 by ID.
 169 .sp
 170 The \fB-p\fR option accepts lists as arguments. Items in a \fIpool-list\fR can
 171 only be separated by spaces.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB-r\fR \fIrset-list\fR\fR
 178 .ad
 179 .RS 16n
 180 Report resource set statistics. If the \fIrset-list\fR argument is "\fBall\fR",
 181 then all possible resource set types are selected.
 182 .sp
 183 The \fB-r\fR option accepts lists as arguments. Items in a list can be either
 184 separated by commas or enclosed in quotes and separated by commas or spaces.
 185 .sp
 186 The following resource set types are supported:
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fBall\fR\fR
 191 .ad
 192 .RS 8n
 193 All resource set types
 194 .RE
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fBpset\fR\fR
 200 .ad
 201 .RS 8n
 202 Processor set
 203 .RE
 204
 205 .RE
 206
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fB-T\fR \fBu\fR | \fBd\fR\fR
 211 .ad
 212 .RS 16n
 213 Display a time stamp.
 214 .sp
 215 Specify \fBu\fR for a printed representation of the internal representation of
 216 time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See
 217 \fBdate\fR(1).
 218 .RE
 219
 220 .SH OPERANDS
 221 .sp
 222 .LP
 223 The following operands are supported:
 224 .sp
 225 .ne 2
 226 .na
 227 \fB\fIcount\fR\fR
 228 .ad
 229 .RS 12n
 230 The number of times that the statistics are repeated. By default, poolstat
 231 reports statistics only once.
 232 .sp
 233 If neither interval nor count are specified, statistics are reported once. If
 234 interval is specified and count is not, statistics are reported indefinitely.
 235 .RE
 236
 237 .sp
 238 .ne 2
 239 .na
 240 \fB\fIinterval\fR\fR
 241 .ad
 242 .RS 12n
 243 The sampling interval in seconds.
 244 .sp
 245 If neither interval nor count are specified, statistics are reported once. If
 246 interval is specified and count is not, statistics are reported indefinitely.
 247 .RE
 248
 249 .SH EXAMPLES
 250 .LP
 251 \fBExample 1 \fRUsing \fBpoolstat\fR
 252 .sp
 253 .LP
 254 The following example shows the default output from the \fBpoolstat\fR utility:
 255
 256 .sp
 257 .in +2
 258 .nf
 259 % poolstat
 260                          pset
 261   id pool           size used load
 262    0 pool_default      4  3.6  6.2
 263    1 pool_admin        4  3.3  8.4
 264 .fi
 265 .in -2
 266 .sp
 267
 268 .LP
 269 \fBExample 2 \fRReporting Resource Set Statistics
 270 .sp
 271 .LP
 272 The following example reports resource set statistics.
 273
 274 .sp
 275 .in +2
 276 .nf
 277
 278 % poolstat -r pset
 279   id pool           type rid rset          min  max size used load
 280   0 pool_default    pset  -1 pset_default    1  65K    2  1.2  8.3
 281   1 pool_admin      pset   1 pset_admin      1    1    1  0.4  5.2
 282   2 pool_other      pset  -1 pset_default    1  65K    2  1.2  8.3
 283 .fi
 284 .in -2
 285 .sp
 286
 287 .sp
 288 .LP
 289 Resource sets attached to multiple pools, as \fBpset_default\fR in the example
 290 above, are listed multiple times, once for each pool.
 291
 292 .LP
 293 \fBExample 3 \fRRestricting the Output to the List of Pools
 294 .sp
 295 .LP
 296 The following example restricts the output to the list of pools
 297
 298 .sp
 299 .in +2
 300 .nf
 301 % poolstat -p pool_default
 302                      pset
 303  id pool         size used load
 304  0 pool_default    8  5.3 10.3
 305
 306 % poolstat -p 'pool_admin pool_default'
 307                        pset
 308   id pool         size used load
 309   1 pool_admin      6  4.3  5.3
 310   0 pool_default    2  1.9  2.0
 311
 312 % poolstat -r all -p 'pool_admin pool_default'
 313   id pool            type rid rset          min  max size used load
 314   1 pool_admin      pset   1 pset_admin      1    1    1  0.9  2.3
 315   2 pool_default    pset  -1 pset_default    1  65K    2  2.0  2.0
 316 .fi
 317 .in -2
 318 .sp
 319
 320 .LP
 321 \fBExample 4 \fRCustomizing Output
 322 .sp
 323 .LP
 324 The following example customizes output:
 325
 326 .sp
 327 .in +2
 328 .nf
 329 % poolstat -r -o pool,rset,size,load
 330   pool            rset          size load
 331   pool_default    pset_default     4  4.5
 332   pool_admin      pset_admin       4  2.1
 333 .fi
 334 .in -2
 335 .sp
 336
 337 .SH EXIT STATUS
 338 .sp
 339 .LP
 340 The following exit values are returned:
 341 .sp
 342 .ne 2
 343 .na
 344 \fB\fB0\fR\fR
 345 .ad
 346 .RS 5n
 347 Successful completion.
 348 .RE
 349
 350 .sp
 351 .ne 2
 352 .na
 353 \fB\fB1\fR\fR
 354 .ad
 355 .RS 5n
 356 An error occurred.
 357 .RE
 358
 359 .sp
 360 .ne 2
 361 .na
 362 \fB\fB2\fR\fR
 363 .ad
 364 .RS 5n
 365 Invalid command line options were specified.
 366 .RE
 367
 368 .SH ATTRIBUTES
 369 .sp
 370 .LP
 371 See \fBattributes\fR(5) for descriptions of the following attributes:
 372 .sp
 373
 374 .sp
 375 .TS
 376 box;
 377 c | c
 378 l | l .
 379 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 380 _
 381 Stability       Evolving
 382 .TE
 383
 384 .SH SEE ALSO
 385 .sp
 386 .LP
 387 \fBlibpool\fR(3LIB), \fBattributes\fR(5)
 388 .sp
 389 .LP
 390 \fI\fR
 391 .SH NOTES
 392 .sp
 393 .LP
 394 The system ids associated with resources can change after the system reboots or
 395 the resource configuration is altered.