Changeset View
Changeset View
Standalone View
Standalone View
usr.bin/ctlstat/ctlstat.8
Show All 28 Lines | |||||||||||
.\" | .\" | ||||||||||
.\" ctlstat utility man page. | .\" ctlstat utility man page. | ||||||||||
.\" | .\" | ||||||||||
.\" Author: Ken Merry <ken@FreeBSD.org> | .\" Author: Ken Merry <ken@FreeBSD.org> | ||||||||||
.\" | .\" | ||||||||||
.\" $Id: //depot/users/kenm/FreeBSD-test2/usr.bin/ctlstat/ctlstat.8#2 $ | .\" $Id: //depot/users/kenm/FreeBSD-test2/usr.bin/ctlstat/ctlstat.8#2 $ | ||||||||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||||||||
.\" | .\" | ||||||||||
.Dd January 9, 2017 | .Dd April 22, 2021 | ||||||||||
.Dt CTLSTAT 8 | .Dt CTLSTAT 8 | ||||||||||
.Os | .Os | ||||||||||
.Sh NAME | .Sh NAME | ||||||||||
.Nm ctlstat | .Nm ctlstat | ||||||||||
.Nd CAM Target Layer statistics utility | .Nd CAM Target Layer statistics utility | ||||||||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||||||||
.Nm | .Nm | ||||||||||
.Op Fl t | .Op Fl t | ||||||||||
.Op Fl c Ar count | .Op Fl c Ar count | ||||||||||
.Op Fl C | .Op Fl C | ||||||||||
.Op Fl d | .Op Fl d | ||||||||||
.Op Fl D | .Op Fl D | ||||||||||
.Op Fl j | .Op Fl j | ||||||||||
.Op Fl P | |||||||||||
.Op Fl l Ar lun | .Op Fl l Ar lun | ||||||||||
.Op Fl n Ar numdevs | .Op Fl n Ar numdevs | ||||||||||
.Op Fl p Ar port | .Op Fl p Ar port | ||||||||||
.Op Fl w Ar wait | .Op Fl w Ar wait | ||||||||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||||||||
The | The | ||||||||||
.Nm | .Nm | ||||||||||
utility provides statistics information for the CAM Target Layer. | utility provides statistics information for the CAM Target Layer. | ||||||||||
Show All 19 Lines | |||||||||||
Dump statistics every 30 seconds in a text format suitable for parsing. | Dump statistics every 30 seconds in a text format suitable for parsing. | ||||||||||
No statistics are computed in this mode, only raw numbers are displayed. | No statistics are computed in this mode, only raw numbers are displayed. | ||||||||||
.It Fl h | .It Fl h | ||||||||||
Suppress display of the header. | Suppress display of the header. | ||||||||||
.It Fl j | .It Fl j | ||||||||||
JSON dump mode. | JSON dump mode. | ||||||||||
Dump statistics every 30 seconds in JavaScript Object Notation (JSON) format. | Dump statistics every 30 seconds in JavaScript Object Notation (JSON) format. | ||||||||||
No statistics are computed in this mode, only raw numbers are displayed. | No statistics are computed in this mode, only raw numbers are displayed. | ||||||||||
.It Fl P | |||||||||||
Prometheus dump mode. | |||||||||||
Dump statistics in a format suitable for ingestion into Prometheus. | |||||||||||
When invoked with this option, | |||||||||||
0mpUnsubmitted Done Inline Actions
0mp: | |||||||||||
.Nm | |||||||||||
dumps once, regardless of the | |||||||||||
.Fl t | |||||||||||
option. | |||||||||||
This option is especially useful when invoked by | |||||||||||
.Xr inetd 8 . | |||||||||||
See the comments in | |||||||||||
.Pa /etc/inetd.conf | |||||||||||
for an example configuration. | |||||||||||
.It Fl l Ar lun | .It Fl l Ar lun | ||||||||||
Request statistics for the specified LUN. | Request statistics for the specified LUN. | ||||||||||
.It Fl n Ar numdevs | .It Fl n Ar numdevs | ||||||||||
Display statistics for this many devices. | Display statistics for this many devices. | ||||||||||
.It Fl p Ar port | .It Fl p Ar port | ||||||||||
Request statistics for the specified port. | Request statistics for the specified port. | ||||||||||
.It Fl w Ar wait | .It Fl w Ar wait | ||||||||||
Wait this many seconds in between displays. | Wait this many seconds in between displays. | ||||||||||
Show All 17 Lines | |||||||||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||||||||
.Xr cam 3 , | .Xr cam 3 , | ||||||||||
.Xr cam 4 , | .Xr cam 4 , | ||||||||||
.Xr ctl 4 , | .Xr ctl 4 , | ||||||||||
.Xr xpt 4 , | .Xr xpt 4 , | ||||||||||
.Xr camcontrol 8 , | .Xr camcontrol 8 , | ||||||||||
.Xr ctladm 8 , | .Xr ctladm 8 , | ||||||||||
.Xr ctld 8 , | .Xr ctld 8 , | ||||||||||
.Xr iostat 8 | .Xr iostat 8 , | ||||||||||
.Lk | |||||||||||
Prometheus project: | |||||||||||
.Pa https://prometheus.io/ . | |||||||||||
Done Inline Actions
0mp: | |||||||||||
.Pp | |||||||||||
Prometheus exposition formats: | |||||||||||
.Lk https://prometheus.io/docs/instrumenting/exposition_formats/ . | |||||||||||
Not Done Inline Actions
0mp: | |||||||||||
.Sh AUTHORS | .Sh AUTHORS | ||||||||||
.An Ken Merry Aq Mt ken@FreeBSD.org | .An Ken Merry Aq Mt ken@FreeBSD.org | ||||||||||
.An Will Andrews Aq Mt will@FreeBSD.org | .An Will Andrews Aq Mt will@FreeBSD.org | ||||||||||
.An Alexander Motin Aq Mt mav@FreeBSD.org | .An Alexander Motin Aq Mt mav@FreeBSD.org |