nvme-cli/Documentation/nvme-solidigm-latency-tracking-log.1

'\" t
.\"     Title: nvme-solidigm-latency-tracking-log
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/17/2025
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-SOLIDIGM\-LATE" "1" "03/17/2025" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-solidigm-latency-tracking-log \- Enable/Retrieve Latency tracking Log
.SH "SYNOPSIS"
.sp
.nf
\fInvme solidigm latency\-tracking\-log\fR <device> [\-\-enable | \-e] [\-\-disable | \-d]
                                              [\-\-read | \-r] [\-\-write | \-w]
                                              [\-\-type <value> | \-t <value>]
                                              [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Enables, disables, or retrieves the Solidigm latency tracking log for the given NVMe device\&. This log provides detailed information about I/O latencies\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
.PP
\-e, \-\-enable
.RS 4
Enable latency tracking before retrieving the log\&.
.RE
.PP
\-d, \-\-disable
.RS 4
Disable latency tracking after retrieving the log\&.
.RE
.PP
\-r, \-\-read
.RS 4
Retrieve read latency statistics (default if neither \-\-read nor \-\-write is specified)\&.
.RE
.PP
\-w, \-\-write
.RS 4
Retrieve write latency statistics\&.
.RE
.PP
\-t <value>, \-\-type <value>
.RS 4
Specify the log type to retrieve\&. Valid values depend on the device\(cqs capabilities\&.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR, or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Enable latency tracking and retrieve the read latency log:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-enable \-\-read
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Retrieve the write latency log in JSON format:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-write \-o json
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Disable latency tracking after retrieving the log:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-disable
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Specify a log type when retrieving latency statistics:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-type 1 \-\-read
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite