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.\" $FreeBSD$ 36.\" 37.Dd April 22, 2021 38.Dt CTLSTAT 8 39.Os 40.Sh NAME 41.Nm ctlstat 42.Nd CAM Target Layer statistics utility 43.Sh SYNOPSIS 44.Nm 45.Op Fl t 46.Op Fl c Ar count 47.Op Fl C 48.Op Fl d 49.Op Fl D 50.Op Fl j 51.Op Fl P 52.Op Fl l Ar lun 53.Op Fl n Ar numdevs 54.Op Fl p Ar port 55.Op Fl w Ar wait 56.Sh DESCRIPTION 57The 58.Nm 59utility provides statistics information for the CAM Target Layer. 60The first display (except for dump and JSON modes) shows average statistics 61since system startup. 62Subsequent displays show average statistics during the measurement 63interval. 64.Pp 65The options are as follows: 66.Bl -tag -width 10n 67.It Fl t 68Total mode. 69This displays separate columns with the total read and write output, 70and a combined total column that also includes non I/O operations. 71.It Fl c Ar count 72Display statistics this many times. 73.It Fl C 74Disable CPU statistics display. 75.It Fl d 76Display DMA operation time (latency) instead of overall I/O time (latency). 77.It Fl D 78Text dump mode. 79Dump statistics every 30 seconds in a text format suitable for parsing. 80No statistics are computed in this mode, only raw numbers are displayed. 81.It Fl h 82Suppress display of the header. 83.It Fl j 84JSON dump mode. 85Dump statistics every 30 seconds in JavaScript Object Notation (JSON) format. 86No statistics are computed in this mode, only raw numbers are displayed. 87.It Fl P 88Prometheus dump mode. 89Dump statistics in a format suitable for ingestion into Prometheus. 90When invoked with this option, 91.Nm 92dumps once, regardless of the 93.Fl t 94option. 95This option is especially useful when invoked by 96.Xr inetd 8 . 97See the comments in 98.Pa /etc/inetd.conf 99for an example configuration. 100.It Fl l Ar lun 101Request statistics for the specified LUN. 102.It Fl n Ar numdevs 103Display statistics for this many devices. 104.It Fl p Ar port 105Request statistics for the specified port. 106.It Fl w Ar wait 107Wait this many seconds in between displays. 108If this option is not specified, 109.Nm 110defaults to a 1 second interval. 111.El 112.Sh EXAMPLES 113.Dl ctlstat -t 114.Pp 115Display total statistics for the system with a one second interval. 116.Pp 117.Dl ctlstat -d -l 5 -C 118.Pp 119Display average DMA time for LUN 5 and omit CPU utilization. 120.Pp 121.Dl ctlstat -n 7 -w 10 122.Pp 123Display statistics for the first 7 LUNs, and display average statistics 124every 10 seconds. 125.Sh SEE ALSO 126.Xr cam 3 , 127.Xr cam 4 , 128.Xr ctl 4 , 129.Xr xpt 4 , 130.Xr camcontrol 8 , 131.Xr ctladm 8 , 132.Xr ctld 8 , 133.Xr iostat 8 , 134.Lk 135Prometheus project: 136.Pa https://prometheus.io/ . 137.Pp 138Prometheus exposition formats: 139.Lk https://prometheus.io/docs/instrumenting/exposition_formats/ . 140.Sh AUTHORS 141.An Ken Merry Aq Mt ken@FreeBSD.org 142.An Will Andrews Aq Mt will@FreeBSD.org 143.An Alexander Motin Aq Mt mav@FreeBSD.org 144