Skip to main content

Options

To start profiling NVMe/TCP, you need to configure the profiling specifications in the ntprof_config.ini file. The configuration file is divided into several sections, each of which contains a set of options. The following table lists the available options and their default values.

Profiling Specifications

Option NameValue TypeDescriptionDefault Value
[Workload]Configuration related to IO workload characteristics
SESSION_NAMEstringName of the profiling session"default_session"
IO_TYPEstringType of IO to collect (read, write, or both)"both"
IO_SIZEstringFixed size of IO to collect"all"
[Execution]Configuration for execution constraints or limits
NETWORK_BANDWIDTH_LIMITstringNetwork bandwidth limit in MB/s"INF" (no limit)
NVME_DRIVE_BANDWIDTH_LIMITstringNVMe drive bandwidth limit in MB/s"INF" (no limit)
[Profiling]Configuration for profiling mode and sampling
IS_ONLINEbooleanProfiling mode: true for online, false for offlinetrue
DATA_DIRstringDirectory to store profiling data (only for offline mode)"./ntprof.data"
TIME_INTERVALintegerTime interval in seconds to print results (only for online mode)1
FREQUENCYintegerSampling rate: every <FREQUENCY>IOs1000
BUFFER_SIZEintegerSize of the profiling buffer in MB1024
AGGREGATIONstringAggregation function: min, max, avg, or dist"avg"
[Report]Configuration for enabling or disabling specific reporting features
ENABLE_LATENCY_DISTRIBUTIONbooleanEnable latency distribution reportingtrue
ENABLE_THROUGHPUTbooleanEnable throughput reportingtrue
ENABLE_LATENCY_BREAKDOWNbooleanEnable latency breakdown reportingtrue
ENABLE_QUEUE_LENGTHbooleanEnable queue length reportingtrue
ENABLE_GROUP_BY_SIZEbooleanEnable grouping by IO size in reportstrue
ENABLE_GROUP_BY_TYPEbooleanEnable grouping by IO type in reportstrue
ENABLE_GROUP_BY_SESSIONbooleanEnable grouping by session in reportstrue