CTLSTAT(8)

💅 ctlstat(8) 💅

okay so this is ctlstat(8), and it lives in the System Manager's Manual — very ✨system manager core✨ of it. bestie, it's the CAM Target Layer statistics utility, and it's here to give you the numbers you crave. 🫶

---

🎀 NAME 🎀

ctlstat — CAM Target Layer statistics utility

---

🌈 SYNOPSIS 🌈

ctlstat [-t] [-c count] [-C] [-d] [-D] [-j] [-P] [-l lun] [-n numdevs]
        [-p port] [-w wait]

---

✨ DESCRIPTION ✨

ctlstat gives you statistics information for the CAM Target Layer. slay.

The first display — except when you're in dump or JSON mode — shows average statistics since system startup. Every display after that shows average statistics during the measurement interval. periodt. 💅

The options are as follows, bestie:

---

🔥 OPTIONS 🔥

• -t — Total mode. This displays separate columns with the total read and write output, and a combined total column that also includes non I/O operations. iconic behavior, honestly.
• -c count — Display statistics this many times. like, a little stats snack pack. 🍓
• -C — Disable CPU statistics display. no CPU noise, just vibes.
• -d — Display DMA operation time (latency) instead of overall I/O time (latency). it's giving latency-specific.
• -D — Text dump mode. Dump statistics every 30 seconds in a text format suitable for parsing. No statistics are computed in this mode, only raw numbers are displayed. raw numbers only, no glow-up. 💀
• -h — Suppress display of the header. bye, header. 🙈
• -j — JSON dump mode. Dump statistics every 30 seconds in JavaScript Object Notation (JSON) format. No statistics are computed in this mode, only raw numbers are displayed. JSON girlies stay winning. 🦋
• -P — Prometheus dump mode. Dump statistics in a format suitable for ingestion into Prometheus. When invoked with this option, ctlstat dumps once, regardless of the -t option. This option is especially useful when invoked by inetd(8). See the comments in /etc/inetd.conf for an example configuration. Prometheus moment. 👑
• -l lun — Request statistics for the specified LUN. give me that exact LUN, bestie.
• -n numdevs — Display statistics for this many devices. a whole little device lineup. 🌸
• -p port — Request statistics for the specified port. port-specific, no cap.
• -w wait — Wait this many seconds in between displays. If this option is not specified, ctlstat defaults to a 1 second interval. so if you don't say anything, it's literally 1 second. 💖

---

🌟 EXAMPLES 🌟

ctlstat -t

Display total statistics for the system with a one second interval.

ctlstat -d -l 5 -C

Display average DMA time for LUN 5 and omit CPU utilization.

ctlstat -n 7 -w 10

Display statistics for the first 7 LUNs, and display average statistics every 10 seconds.

---

🦋 SEE ALSO 🦋

• cam(3)
• cam(4)
• ctl(4)
• xpt(4)
• camcontrol(8)
• ctladm(8)
• ctld(8)
• iostat(8)
• Prometheus project: https://prometheus.io/.
• Prometheus exposition formats: https://prometheus.io/docs/instrumenting/exposition_formats/.

---

👑 AUTHORS 👑

• Ken Merry <ken@FreeBSD.org>
• Will Andrews <will@FreeBSD.org>
• Alexander Motin <mav@FreeBSD.org>

---

xoxo, your Debian bestie — this page is dated April 22, 2021, and it's CTLSTAT(8). bye bestie 💅🎀