.nh
.TH "apptainer" "1" "Sep 2024" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
apptainer-instance-stats - Get stats for a named instance


.SH SYNOPSIS
.PP
\fBapptainer instance stats [stats options...] \fP


.SH DESCRIPTION
.PP
The instance stats command allows you to get statistics for a named instance,
  either printed to the terminal or in json. If you are root, you can optionally
  ask for statistics for a container instance belonging to a specific user. If
  you add --no-stream, you will only see one timepoint. Asking for json implies
  the same.


.SH OPTIONS
.PP
\fB-h\fP, \fB--help\fP[=false]
	help for stats

.PP
\fB-j\fP, \fB--json\fP[=false]
	output stats in json

.PP
\fB--no-stream\fP[=false]
	disable streaming (live update) of instance stats

.PP
\fB-u\fP, \fB--user\fP=""
	view stats for an instance belonging to a user (root only)


.SH EXAMPLE
.EX

  $ apptainer instance stats mysql
  $ apptainer instance stats --json mysql
  $ apptainer instance stats --no-stream mysql
  $ sudo apptainer instance stats --user <username> user-mysql

.EE


.SH SEE ALSO
.PP
\fBapptainer-instance(1)\fP


.SH HISTORY
.PP
23-Sep-2024 Auto generated by spf13/cobra