Trace-SM
Download the latest release: Trace-SM.ps1
Description
Trace-SM.ps1 can be used to collect trace files which will be used by Microsoft Support in troubleshooting. Usually, instructions will be provided by the Microsoft support engineer.
Purpose
To easily collect (start/stop) and format SCSM specific traces.
How to run
- Download/Save the script Trace-SM.ps1 to a machine where any SCSM component is installed.
- Open a Windows PowerShell window as an Administrator (PowerShell ISE can also be used).
- Navigate to the folder where you saved the script.
- Run the script as below and provide at least the mandatory parameter:
.\Trace-SM.ps1
Parameters
-TraceOperation (mandatory)
- Start -> starts traces. Stops them if already running and moves them to a subfolder.
- Stop -> stops traces.
- StopAndFormat -> stops traces and then starts formatting them. Pre-existing formatted log files will be moved to a subfolder beforehand.
- ShowStatus -> shows only the current trace status.
-Areas (optional)
- If not set, the default is to trace all “areas” which are Default, SDK, ConsoleUI, Connectors, DataWarehouse, Workflows, PortalSSP, Performance.
To deal with only specific areas provide their names as comma delimited, see example below.
Note that during formatting the specified Areas are ignored and all ETL files are formatted into LOG files.
-MaxFileSizeMB (optional, only effective with the Start operation, ignored with other operations)
- Can be set to a numeric value in MBytes. Default is 100 MB.
-NewFileWhenMaxsizeReached (optional, only effective with the Start operation, ignored with other operations)
- Default is circular file tracing where oldest trace info is overridden when max file size is reached.
When this switch is provided then a new trace file will be created everytime when max file size is reached.
Note:
Trace files are always located in %windir%\temp\SMTrace which is usually C:\Windows\temp\SMTrace.
Examples
-
To start all SCSM traces
.\Trace-SM.ps1 Startor
.\Trace-SM.ps1 -TraceOperation Start
Sample Output (note that existing traces are retained by moving them into a sub folder)
Stopping all SCSM traces:
Stopping Default ...
Stopping SDK ...
Stopping ConsoleUI ...
Stopping Connectors ...
Stopping DataWarehouse ...
Stopping Workflows ...
Stopping PortalSSP ...
Stopping Performance ...
Note: ETL files already exist in C:\Windows\temp\SMTrace. Moving them into OldTracesStoppedAtUtc_2023-11-08__15.14.32.343
Starting all SCSM traces:
Starting Default ...
Starting SDK ...
Starting ConsoleUI ...
Starting Connectors ...
Starting DataWarehouse ...
Starting Workflows ...
Starting PortalSSP ...
Starting Performance ...
SCSM Trace Status ETL Max File size (MB) Is ETL Circular? Etl file Location
---------- ------ ---------------------- ---------------- -----------------
Default Running 100 True C:\Windows\temp\SMTrace\Default.etl
SDK Running 100 True C:\Windows\temp\SMTrace\SDK.etl
ConsoleUI Running 100 True C:\Windows\temp\SMTrace\ConsoleUI.etl
Connectors Running 100 True C:\Windows\temp\SMTrace\Connectors.etl
DataWarehouse Running 100 True C:\Windows\temp\SMTrace\DataWarehouse.etl
Workflows Running 100 True C:\Windows\temp\SMTrace\Workflows.etl
PortalSSP Running 100 True C:\Windows\temp\SMTrace\PortalSSP.etl
Performance Running 100 True C:\Windows\temp\SMTrace\Performance.etl
-
To stop all SCSM traces
.\Trace-SM.ps1 Stopor
.\Trace-SM.ps1 -TraceOperation Stop
Sample Output
Stopping all SCSM traces:
Stopping Default ...
Stopping SDK ...
Stopping ConsoleUI ...
Stopping Connectors ...
Stopping DataWarehouse ...
Stopping Workflows ...
Stopping PortalSSP ...
Stopping Performance ...
SCSM Trace Status ETL Max File size (MB) Is ETL Circular? Etl file Location
---------- ------ ---------------------- ---------------- -----------------
Default Stopped
SDK Stopped
ConsoleUI Stopped
Connectors Stopped
DataWarehouse Stopped
Workflows Stopped
PortalSSP Stopped
Performance Stopped
-
To stop all SCSM traces and then start formatting
.\Trace-SM.ps1 StopAndFormator
.\Trace-SM.ps1 -TraceOperation StopAndFormat
Sample Output (note that while formatting is running in a separate command window, this command is blocked)
Stopping all SCSM traces:
Stopping Default ...
Stopping SDK ...
Stopping ConsoleUI ...
Stopping Connectors ...
Stopping DataWarehouse ...
Stopping Workflows ...
Stopping PortalSSP ...
Stopping Performance ...
Formatting all ETL files in C:\Windows\temp\SMTrace, this can take a few minutes, please wait ...
Formatting completed. Press ENTER to navigate to the SCSM Trace folder ...
-
To start only a specific trace in non-circular mode and with max size of 250MB
.\Trace-SM.ps1 Start Connectors 250 -NewFileWhenMaxsizeReachedor
.\Trace-SM.ps1 -TraceOperation Start -Areas Connectors -MaxFileSizeMB 250 -NewFileWhenMaxsizeReached
Sample Output (note that the ETL file name has a number which will increase when max file is reached)
Stopping Connectors ...
Starting Connectors ...
SCSM Trace Status ETL Max File size (MB) Is ETL Circular? Etl file Location
---------- ------ ---------------------- ---------------- -----------------
Connectors Running 250 False C:\Windows\temp\SMTrace\Connectors.1.etl
-
To only show the current status of all SCSM traces
.\Trace-SM.ps1 ShowStatusor
.\Trace-SM.ps1 -TraceOperation ShowStatus
Sample Output
SCSM Trace Status ETL Max File size (MB) Is ETL Circular? Etl file Location
---------- ------ ---------------------- ---------------- -----------------
Default Running 100 True C:\Windows\temp\SMTrace\Default.etl
SDK Running 100 True C:\Windows\temp\SMTrace\SDK.etl
ConsoleUI Running 100 True C:\Windows\temp\SMTrace\ConsoleUI.etl
Connectors Running 100 True C:\Windows\temp\SMTrace\Connectors.etl
DataWarehouse Running 100 True C:\Windows\temp\SMTrace\DataWarehouse.etl
Workflows Running 100 True C:\Windows\temp\SMTrace\Workflows.etl
PortalSSP Running 100 True C:\Windows\temp\SMTrace\PortalSSP.etl
Performance Running 100 True C:\Windows\temp\SMTrace\Performance.etl
Do you want to contribute to this script?
Here is the GitHub repo.