usr.bin/ctlstat/ctlstat.8

   1 .\"
   2 .\" Copyright (c) 2010 Silicon Graphics International Corp.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions, and the following disclaimer,
  10 .\"    without modification.
  11 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12 .\"    substantially similar to the "NO WARRANTY" disclaimer below
  13 .\"    ("Disclaimer") and any redistribution must be conditioned upon
  14 .\"    including a substantially similar Disclaimer requirement for further
  15 .\"    binary redistribution.
  16 .\"
  17 .\" NO WARRANTY
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  21 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  27 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGES.
  29 .\"
  30 .\" ctlstat utility man page.
  31 .\"
  32 .\" Author: Ken Merry <ken@FreeBSD.org>
  33 .\"
  34 .\" $Id: //depot/users/kenm/FreeBSD-test2/usr.bin/ctlstat/ctlstat.8#2 $
  35 .\"
  36 .Dd April 22, 2021
  37 .Dt CTLSTAT 8
  38 .Os
  39 .Sh NAME
  40 .Nm ctlstat
  41 .Nd CAM Target Layer statistics utility
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl t
  45 .Op Fl c Ar count
  46 .Op Fl C
  47 .Op Fl d
  48 .Op Fl D
  49 .Op Fl j
  50 .Op Fl P
  51 .Op Fl l Ar lun
  52 .Op Fl n Ar numdevs
  53 .Op Fl p Ar port
  54 .Op Fl w Ar wait
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 utility provides statistics information for the CAM Target Layer.
  59 The first display (except for dump and JSON modes) shows average statistics
  60 since system startup.
  61 Subsequent displays show average statistics during the measurement
  62 interval.
  63 .Pp
  64 The options are as follows:
  65 .Bl -tag -width 10n
  66 .It Fl t
  67 Total mode.
  68 This displays separate columns with the total read and write output,
  69 and a combined total column that also includes non I/O operations.
  70 .It Fl c Ar count
  71 Display statistics this many times.
  72 .It Fl C
  73 Disable CPU statistics display.
  74 .It Fl d
  75 Display DMA operation time (latency) instead of overall I/O time (latency).
  76 .It Fl D
  77 Text dump mode.
  78 Dump statistics every 30 seconds in a text format suitable for parsing.
  79 No statistics are computed in this mode, only raw numbers are displayed.
  80 .It Fl h
  81 Suppress display of the header.
  82 .It Fl j
  83 JSON dump mode.
  84 Dump statistics every 30 seconds in JavaScript Object Notation (JSON) format.
  85 No statistics are computed in this mode, only raw numbers are displayed.
  86 .It Fl P
  87 Prometheus dump mode.
  88 Dump statistics in a format suitable for ingestion into Prometheus.
  89 When invoked with this option,
  90 .Nm
  91 dumps once, regardless of the
  92 .Fl t
  93 option.
  94 This option is especially useful when invoked by
  95 .Xr inetd 8 .
  96 See the comments in
  97 .Pa /etc/inetd.conf
  98 for an example configuration.
  99 .It Fl l Ar lun
 100 Request statistics for the specified LUN.
 101 .It Fl n Ar numdevs
 102 Display statistics for this many devices.
 103 .It Fl p Ar port
 104 Request statistics for the specified port.
 105 .It Fl w Ar wait
 106 Wait this many seconds in between displays.
 107 If this option is not specified,
 108 .Nm
 109 defaults to a 1 second interval.
 110 .El
 111 .Sh EXAMPLES
 112 .Dl ctlstat -t
 113 .Pp
 114 Display total statistics for the system with a one second interval.
 115 .Pp
 116 .Dl ctlstat -d -l 5 -C
 117 .Pp
 118 Display average DMA time for LUN 5 and omit CPU utilization.
 119 .Pp
 120 .Dl ctlstat -n 7 -w 10
 121 .Pp
 122 Display statistics for the first 7 LUNs, and display average statistics
 123 every 10 seconds.
 124 .Sh SEE ALSO
 125 .Xr cam 3 ,
 126 .Xr cam 4 ,
 127 .Xr ctl 4 ,
 128 .Xr xpt 4 ,
 129 .Xr camcontrol 8 ,
 130 .Xr ctladm 8 ,
 131 .Xr ctld 8 ,
 132 .Xr iostat 8 ,
 133 .Lk
 134 Prometheus project:
 135 .Pa https://prometheus.io/ .
 136 .Pp
 137 Prometheus exposition formats:
 138 .Lk https://prometheus.io/docs/instrumenting/exposition_formats/ .
 139 .Sh AUTHORS
 140 .An Ken Merry Aq Mt ken@FreeBSD.org
 141 .An Will Andrews Aq Mt will@FreeBSD.org
 142 .An Alexander Motin Aq Mt mav@FreeBSD.org