.png)
hpctrace
Updated: December 10, 2012
Applies To: Microsoft HPC Pack 2008, Microsoft HPC Pack 2008 R2, Microsoft HPC Pack 2012
This command was introduced in HPC Pack 2008 R2. Starts, stops, queries, collects, and formats the Event Tracing for Windows (ETW)-based trace logs generated by the HPC Management Service, HPC SDM Store Service, and the HPC management tools that use the HPC management API. Starting in HPC Pack 2012, hpctrace also extracts the binary log files generated by Windows Azure nodes, and by the HPC Monitoring Server Service and the HPC Monitoring Client Service.
hpctrace start <provider> [file size]
hpctrace {stop|query} <provider>
hpctrace getlog <provider> <TXT file> [level]
hpctrace fmtlog <ETL file> <TXT file> [level]
hpctrace parselog <BIN file> [-s] [level]
hpctrace {/? | /help}
| Subcommand | Description | ||
|---|---|---|---|
|
hpctrace fmtlog |
Extracts the information from an existing ETL file (.etl), and writes it to the specified text file (.txt). When used with the optional [level] parameter, filters the log output based on the severity of each log entry. |
||
|
hpctrace getlog |
Collects the trace log of the specified provider (trace source) and writes it to the specified text file (.txt). When used with the optional [level] parameter, filters the log output based on the severity of each log entry.
|
||
|
hpctrace parselog |
This parameter was added in HPC Pack 2012 and is not supported in previous versions. Extracts the information from one or more binary log files (.bin), and writes it to a text file (.txt) with tab-separated values, which can be imported into a table-based tool for analysis. The output file has the same name as the binary log file, with a .log file extension, and is stored in the same folder as the .bin file. When used with the optional [level] parameter, filters the log output based on the severity of each log entry. The optional [–s] parameter processes binary files in all subfolders.
|
||
|
hpctrace query |
Displays session information for the specified provider (trace source).
|
||
|
hpctrace start |
Starts a new tracing session for the specified provider (trace source). The ETL file that is generated will be stored in %CCP_DATA%LogFiles. The optional [file size] argument specifies the maximum size of the ETL file, in MB. |
||
|
hpctrace stop |
Stops an existing trace session for the specified provider (trace source).
|
||
|
hpctrace /? |
Displays Help at the command prompt. |
||
|
hpctrace /help |
Displays Help at the command prompt. |
Note 
Warning | Parameter | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
<BIN file> |
Specifies the name of the binary log file or files to extract. Applies only to the parselog subcommand. Accepts the * and ? wildcards. |
||||||||||
|
<ETL file> |
Specifies the name of the ETL file to extract. Applies only to the fmtlog subcommand. |
||||||||||
|
[file size] |
Optionally specifies the maximum size of the ETL file, in MB. Applies only to the start subcommand. Generally, the text file that is extracted from the ETL file will be half the size of the ETL file. For example, a 1 GB ETL file will generate 500 MB of formatted text output. You must stop the current logging session and restart it in order to change the file size. The default size is 400 MB. |
||||||||||
|
[level] |
Optionally filters the log output based on the maximum severity of each log entry. Applies to the getlog, fmtlog, and parselog subcommands. The default level for the getlog and fmtlog subcommands is 4. The default level for parselog is 5. The available levels are:
|
||||||||||
|
<provider> |
Specifies the provider (source) of the trace logs. Applies only to the query and getlog subcommands. The available providers are:
|
||||||||||
|
[-s] |
Optionally extracts binary files in all existing subfolders. Applies only to the parselog subcommand |
||||||||||
|
<TXT file> |
Specifies the name of the output text file. Applies only to the getlog and fmtlog subcommands. |
To retrieve the hpctrace log file named mgmttxt that contains warning, error, and critical messages, use the following command:
hpctrace getlog mgmt mgmttxt 3
To stop a tracing session for the HPC Management Service, and then restart it with a maximum file size of 100 MB:
hpctrace stop mgmthpctrace start mgmt 100
To extract only the binary file named HpcLog_01.bin, in the C:\logs folder:
hpctrace parselog C:\logs\HpcLog_01.bin
To extract all binary files that start with "HpcLog_0", followed by one number, in the current folder (for example, HpcLog_00.bin, HpcLog_01.bin, HpcLog_02.bin, and so on):
hpctrace parselog HpcLog_0?.bin
To extract all binary files in the current folder, and in all existingsubfolders:
hpctrace parselog *.bin -s
