Express Profiler Quick Start
Use the following sections to get started and running with ExpressProfiler quickly.
Quick ExpressProfiler Standalone Download Instructions
The ExpressProfiler executable is contained in a zip file. Although there is an msi installer in the zip file. The installer is not needed for standalone operation. To download and use the program use the following steps.
- Click on the Downloads tab above.
- Under the recommend download header, click on the ExpressProfiler20wAddinSigned.zip link to start the download. Save the file.
- Unzip the file to a desired location.
- Navigate to the extracted folder, /ExpressProfiler20wAddinSigned/Standalone.
- In the folder, double click on the ExpressProfiler.exe to start the program.
The program will start in its default configured mode, will be setup to connect to a local SqlServer Express connection, '.\SQLExpress' using windows authorization with the current user account. There is a toolbar with play, pause and stop buttons. If you
have a default local installation of SqlServer Express, you should now be able to press the play button and capture queries going to the local SqlServer express instance.
You can use the following pull down entries and keyboard short cuts to control trace recording:
- Start Trace Recording: File->Start trace or Alt-S
- Start Trace Recording with Filters: File->Start trace->Run with Filters. See more below regarding this option.
- Pause Trace Recording: File->Pause trace or Alt-P
- Stop Trace Recording: File->Stop trace or Alt-T
When capturing a trace, each entry is displayed in the data grid below the toolbar. As the trace recording session is active more entries will be placed in the data grid as they are received.
Start Trace Recording with Filters
Running the trace recording with filters allows you to filter the events before capturing them to keep out unwanted events. The filter tab on the 'Trace Properties' dialog is presented to you when you start trace recording. See the next section on using
the 'Trace Properties' dialog.
The 'Trace Properties' Dialog.
The 'Trace Properties' dialog allows you to fine tune both the filtering of captured events before capture, what data to display in the captured events grid, and most importantly, what events to capture. Use the following tabs on the dialog to configure
The Filter Tab
The following items can be configured on the 'Filter' tab:
- Application Name: Filter on 'like' or 'not like' the supplied string.
- CPU: Filter on 'Equal', 'Not Equal', 'Greater Than' or 'Less Than' a supplied value.
- DatabaseName: Filter on 'like' or 'not like' the supplied string.
- Duration: Filter on 'Equal', 'Not Equal', 'Greater Than' or 'Less Than' a supplied value.
- LoginName: Filter on 'like' or 'not like' the supplied string.
- Maximum events count: Capture a maximum number of events. The default is 5000.
- Reads: Filter on 'Equal', 'Not Equal', 'Greater Than' or 'Less Than' a supplied value.
- SPID: Filter on 'Equal', 'Not Equal', 'Greater Than' or 'Less Than' a supplied value.
- Text Data: Filter on 'like' or 'not like' the supplied string.
- Writes: Filter on 'Equal', 'Not Equal', 'Greater Than' or 'Less Than' a supplied value.
Note: A SPID in SQL Server is a Server Process ID. These process ID’s are essentially sessions in SQL Server.
Other options on this dialog allow you to reset to the defaults, save as the default, run with the existing settings and cancel the run.
The 'Columns and events' Tab
The following items can be configured on the 'Columns and events' tab:
Data Columns to capture and display in the event data grid:
- Application Name: The default is false.
- Database Name: The default is false.
- End time: The default is true.
- Object name: The default is false.
- Start time: The default is true.
Events to capture:
- Blocked process report: The default is false.
- ExistingConnection: The default is false.
- LoginLogout: The default is false.
- RPC:Completed: The default is true.
- RPC:Started: The default is false.
- SP:StmtCompleted: The default is false.
- SP:StmtStarting: The default is false.
- SQL:BatchCompleted: The default is true.
- SQL:BatchStarting: The default is false.
- SQL:StmtCompleted: The default is false.
- SQL:StmtStarting: The default is false.
- User Error Message: The default is false.
Managing Trace Data Viewing
There are several controls to manage the viewing of captured trace data. The following list describes each of the control options and how to access them.
- Clear the captured Trace: Use the clear trace window button or Edit->Clear Trace Window or Ctrl+Shift+Del
- Autoscroll Trace Window: Use the Autoscroll button on the toolbar to automatically scroll to the latest captured trace entry.
- Keep ExpressProfiler Window On Top: Keeping the ExpressProfiler on top of other windows is toggled using View->Stay on Top or Ctrl-T.
- Transparent Applicaton: Toggling the ExpressProfiler display as transparent is performed using View->Transparent or Ctrl-G.
- Find text in captured trace: To find text in the captured trace window use Edit->Find... or Ctrl+F. This brings up the find window.
Tip: Using both the Keep ExpressProfiler on top with the transparent toggles allows you to keep an eye on the trace recording while you exercise your application talking to your database.
Configuring ExpressProfiler For Different Servers
On the ExpressProfiler toolbar, there is a textbox labelled 'Server'. This normally starts with the default value of '.\SQLExpress', however you may type in any valid connection string before starting your trace recording session.
Configuring ExpressProfiler Login Credentials
The default login credentials that ExpressProfiler uses is the current user with windows authentication. When the windows authentication mode is active, the login user and password textboxes on the toolbar are disabled as they are not used. To change to
a specified login account, use the pulldown to the right of the server connection string textbox on the toolbar. Switch the login mode from 'Windows auth' to 'SQL Server auth'. This enables the User and Password textboxes to allow you to enter your specific
user and password.
Note that the settings are not persistent and reset to the default values on the next program startup.
Command-line Startup Parameters
When starting up the ExpressProfiler from a command line, or shortcut, the following command line switches can be used to set values for the application session.
- -server, -s <server name>: This sets the server connection string.
- -user, -u <user name>: This sets the startup user name to use.
- -password, -p <user password>: This sets the startup password to use.
- -maxevents, -m <value> : This set maximum events in event list (1000 by default).
- -duration, -d <min duration> : This sets filter on duration column.
- -start : Automatically start profiling once the ExpressProfiler has started up.