Logging and log files
Published 21 January 2014
Log files collect information about SQL Source Control while you use it. These files are useful if you're working with Redgate support to fix a problem.
By default, SQL Source Control logs all error information (see the table below). This produces large log files. If you're troubleshooting a specific problem, you may want to reduce the amount of logging to make the logs easier to read.
Example log file using the default log level, "Serious"
10:20:01.983|Info |er.StartOfDayLogging|1 |#1:Power Mode Changed, mode is Resume 10:20:03.087|Info |er.StartOfDayLogging|1 |#1:Time Changed 10:20:03.429|Debug |VsCommandUsageLogger|1 |#1:Execute for VS command Edit.GoToFindCombo 10:20:09.707|Info |er.StartOfDayLogging|1 |#1:Time Changed 10:20:19.449|Info |Performance Testing |9 |#9:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:StartTimeTicks=635265876008030745:Name=ServerPollEvent 10:20:19.552|Info |Performance Testing |9 |#9:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:Step=1:Seconds=3.77532491619145E-05:After=Get Lock 10:20:19.552|Info |Performance Testing |9 |#9:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:Step=2:Seconds=0.000117291647881676:After=Copied database names 10:20:19.552|Info |Performance Testing |9 |#9:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:Step=3:Seconds=0.000157610651841002:After=Calculated work 10:20:19.552|Info |Performance Testing |9 |#9:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:Step=4:Seconds=18.6582575885863:After=Get New Entries 10:20:19.552|Info |Pollers.ServerPoller|13 |#13:Got 0 new default trace entries for AdventureWorks 10:20:19.552|Info |Performance Testing |33 |#33:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:Step=5:Seconds=18.7612858390128:After=Invoke New Entries 10:20:19.552|Info |Performance Testing |33 |#33:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:Step=6:Seconds=18.7613045323692:After=Make AboutToBeActive Active 10:20:19.552|Info |Performance Testing |33 |#33:Guid=58317ab7-0627-4261-9f33-fb2c5c01696a:NumberOfSteps=6 10:20:19.552|Info |Performance Testing |33 |#33:Guid=b3e1aae0-9c1a-46f3-abda-e1e96a90fd1f:StartTimeTicks=635265876008030745:Name=PollStrategyCallBack 10:20:19.552|Info |Performance Testing |33 |#33:Guid=b3e1aae0-9c1a-46f3-abda-e1e96a90fd1f:NumberOfSteps=0
Changing the log level
You can only change the log level in SQL Source Control 3.3 and later.
- Close Management Studio.
- Go to the SQL Source Control config files folder. By default, this is %localappdata%\Red Gate\SQL Source Control 3
Open RedGate_SQLSourceControl_Engine_EngineOptions.xml in a text editor.
Inside the
<EngineOptions>tags, add:<LogLevel>your specified log level</LogLevel>
You can specify:
Log level Effect None Disables all logging. Debug Logs additional debug information. Trace Logs stack trace after an exception. Information Logs information collected when getting changes in the Get latest tab. Warning Logs information collected when minor errors occur. Error Logs information collected when mid-level errors occur. Fatal Logs information collected when fatal errors (ie crashes) occur. Serious Combines the warning, error and fatal log levels (ie logs information from all error types). This is used by default if no log level is set. Default Combines the debug, trace, information and serious log levels. Note: despite its name, this is not the default log level. All Logs all messages. The file is case sensitive. Don't change the capitalization of the text.
- Save and close the file.
SQL Source Control saves log files with the setting you specified.
Locating the log files
By default, log files for all Red Gate tools are located in: %LOCALAPPDATA%\Red Gate\Logs
