List of AF Get Trace utility parameters
- Last UpdatedJan 08, 2025
- 3 minute read
- PI System
- PI Server 2018
- PI Server
The following table lists the available parameters for the AFGetTrace utility.
|
Parameter |
Short form |
Description |
|---|---|---|
|
/Provider:string |
/P |
Specifies the name of the event tracing session. You only need to specify to use an existing event trace provider. The default value is AFGetTrace. |
|
/Level:{Critical|Error|Warning|Information|Verbose|Detail} |
/L |
Specifies the level of detail to be included in the events written by the AF SDK. Detail at or above severity of the level chosen is generated. The default value is Verbose. You can specify that only a particular level is written to the log file:
|
|
/Keywords:{None|Server|Connection|Cache|Events|Trace|Data|All} |
/K |
Specifies the keywords used to determine the category of events that you want the AF SDK to write. The default value is All. The AF SDK writes the event if any of the event's keywords match the keywords specified in this setting. You can specify to have one or more keywords written to the log file:
|
|
/EnableAF[-] |
/AF |
Enables messages from the AF SDK message provider. The default value is True. |
|
/EnablePI[-] |
/PI |
Enables messages relating to communication with the Data Archive from the MDA message provider. The default value is True. |
|
/LogFile:string |
/Log |
Specifies the name of the log file for trace output messages. Messages are still displayed on standard output unless you specify the Silent parameter. |
|
/LogFileMaxSize:double |
/FileMax |
Specifies the maximum size of the log file in megabytes. The trace ends once the size is reached. Enter 0 for no limit. The default value is 0. |
|
/Timeout:integer |
/TO |
Specifies the number of minutes before the trace ends. Enter 0 for no timeout. The default value is 0. |
|
/Mask:string |
/M |
Prevents any message containing the specified mask from being displayed. Enclose the mask in quotes if it contains spaces. This parameter can be specified more than once, but values must be unique. |
|
/MaskPID:UInt32 |
/MPID |
Prevents any message associated with the specified Process ID from being displayed. This parameter can be specified more than once. Note: This parameter is ignored if the ProcessID parameter is specified. |
|
/MaskTID:UInt32 |
/MTID |
Prevents any message associated with the specified Thread ID from being displayed. This parameter can be specified more than once. Note: This parameter is ignored if the ThreadID parameter is specified. |
|
/NoGui |
/NG |
Specifies that the AFGetTrace utility be launched in console mode. |
|
/NoHeader[-] |
/NH |
Disables header information on each message. Header information includes the time stamp, process identifier, and thread identifier. |
|
/ProcessID:UInt32 |
/PID |
Displays any message associated with the specified process ID. This parameter can be specified more than once. |
|
/ThreadID:UInt32 |
/TID |
Displays any message associated with the specified thread ID. This parameter can be specified more than once. |
|
/WordWrap |
/W |
Word wraps output messages to the width of the console. |
|
/Silent[-] |
/S |
Establishes silent mode, which prevents message display. |