Программа SQLdiag

Синтаксис

sqldiag 
     { [/?] }
     |
     { [/I configuration_file]
       [/O output_folder_path]
       [/P support_folder_path]
       [/N output_folder_management_option]
              [/M machine1 [ machine2 machineN]| @machinelistfile]
       [/C file_compression_type]
              [/B [+]start_time]
       [/E [+]stop_time]
       [/A SQLdiag_application_name]
       [/T { tcp [ ,port ] | np | lpc | via } ]
       [/Q] [/G] [/R] [/U] [/L] [/X] }
     |
     { [START | STOP | STOP_ABORT] }
     |
     { [START | STOP | STOP_ABORT] /A SQLdiag_application_name }

Аргументы

• /?
  Отображает сведения об использовании.

• /Iconfiguration_file
  Задает файл конфигурации, используемый программой SQLdiag. По умолчанию /I задает SQLDiag.Xml.

• /Ooutput_folder_path
  Перенаправляет выходной поток программы SQLdiag в указанную папку. Если параметр /O не указан, выходной поток SQLdiag направляется во вложенную папку с именем SQLDIAG, расположенную в папке запуска SQLdiag. Если папка SQLDIAG не существует, программа SQLdiag попытается создать ее.

  Примечание
  Расположение выходной папки задается относительно расположения папки поддержки, которое может быть определено параметром /P. Для установки абсолютного другого пути к выходной папке укажите полный путь каталога в параметре /O.

• /Psupport_folder_path
  Устанавливает путь к папке поддержки. По умолчанию параметр /P задает папку, в которой находится исполняемый файл SQLdiag. Папка поддержки содержит файлы поддержки SQLdiag, такие как XML-файл конфигурации, сценарии Transact-SQL и другие файлы, используемые программой во время сбора диагностических сведений. Если этот параметр будет использован для указания дополнительного пути к файлам поддержки, программа SQLdiag автоматически скопирует необходимые файлы поддержки в указанную папку, если они еще не существуют.

  Примечание
  Чтобы установить текущую папку в качестве пути к файлам поддержки, укажите %cd% в командной строке следующим образом: SQLDIAG /P %cd%

• /Noutput_folder_management_option
  Определяет, должна ли программа SQLdiag при запуске перезаписывать или переименовывать выходную папку. Возможные параметры:

  1 = Перезаписывает выходную папку (по умолчанию)

  2 = При запуске программа SQLdiag переименовывает выходную папку в SQLDIAG_00001, SQLDIAG_00002 и так далее. После переименования текущей выходной папки программа SQLdiag выводит данные в папку по умолчанию SQLDIAG.

  Примечание
  Программа SQLdiag при запуске не добавляет данные в текущую выходную папку. Она может только перезаписать выходную папку по умолчанию (параметр 1) или переименовать папку (параметр 2), после чего производит вывод в новую выходную папку по умолчанию, имеющую имя SQLDIAG.

• /Mmachine1 [ machine2machineN] | @machinelistfile
  Переопределяет параметр machines, указанный в файле конфигурации. По умолчанию файлом конфигурации является SQLDiag.Xml либо файл, заданный параметром /I. При определении более одного компьютера, разделяйте имена компьютеров пробелами.

  Использование параметра @machinelistfile позволяет указать имя файла со списком компьютеров, который необходимо сохранить в файле конфигурации.

• /Cfile_compression_type
  Устанавливает тип сжатия файлов, используемый в файлах выходной папки программы SQLdiag. Возможные параметры:

  0 = без сжатия (по умолчанию)

  1 = использование сжатия NTFS

• /B [+]start_time
  Указывает дату и время начала сбора диагностических данных в следующем формате:

  ГГГГММДД_ЧЧ:ММ:СС

  Время указывается в 24-часовом формате. Например, время 2 часа после полудня должно указываться как 14:00:00.

  Используйте + без даты (только ЧЧ:ММ:СС) для указания времени относительно текущей даты и времени. Например, если указать /B +02:00:00, программа SQLdiag будет ждать 2 часа перед тем, как начать сбор сведений.

  Не вставляйте символ пробела между + и указанным значением start_time.

  Если указать время запуска, которое уже прошло, программа SQLdiag принудительно изменит дату запуска таким образом, что дата и время запуска будут находиться в будущем. Например, если указать /B 01:00:00 а текущее время — 08:00:00, программа SQLdiag принудительно изменит дату запуска на следующий день.

  Обратите внимание, что SQLdiag использует локальное время компьютера, где запущена программа.

• /E [+]stop_time
  Указывает дату и время остановки сбора диагностических данных в следующем формате:

  ГГГГММДД_ЧЧ:ММ:СС

  Время указывается в 24-часовом формате. Например, время 2 часа после полудня должно указываться как 14:00:00.

  Используйте + без даты (только ЧЧ:ММ:СС) для указания времени относительно текущей даты и времени. Например, если время запуска и остановки указывается как /B +02:00:00 /E +03:00:00, то SQLdiag будет ждать 2 часа перед тем, как начать сбор сведений, затем будет собирать сведения в течение 3 часов, прежде чем остановится и завершит работу. Если параметр /B не указан, программа SQLdiag начнет сбор диагностических сведений немедленно и закончит в момент, соответствующий дате и времени, указанным в параметре /E.

  Не вставляйте символ пробела между + и указанным значением start_time или end_time.

  Обратите внимание, что SQLdiag использует локальное время компьютера, где запущена программа.

• /A SQLdiag_application_name
  Допускает запуск нескольких экземпляров программы SQLdiag для работы с одним экземпляром SQL Server.

  Каждый параметр SQLdiag_application_name определяет уникальный экземпляр программы SQLdiag. Между экземпляром SQLdiag_application_name и именем экземпляра SQL Server никакой связи не существует.

  Параметр SQLdiag_application_name может использоваться для запуска или остановки указанного экземпляра службы SQLdiag.

  Например:

  SQLDIAG START /A SQLdiag_application_name

  Он также может использоваться с параметром /R для регистрации указанного экземпляра SQLdiag в качестве службы. Например:

  SQLDIAG /R /ASQLdiag_application_name

  Примечание
  Программа SQLdiag автоматически добавляет префикс DIAG$ к имени экземпляра, указанному для SQLdiag_application_name. Это позволяет получить понятное имя службы при регистрации SQLdiag в качестве службы.

• /T { tcp [ ,port ] | np | lpc | via }
  Подключение к экземпляру SQL Server с использованием определенного протокола.

  • tcp [, port]
    Протокол TCP/IP. Можно дополнительно определить порт для соединения.

  • np
    Именованные каналы. По умолчанию экземпляр SQL Server прослушивает именованные каналы \\.\pipe\sql\query и \\.\pipe\MSSQL$<instancename>\sql\query для именованных экземпляров. Нельзя соединиться с экземпляром SQL Server с помощью другого имени канала.

  • lpc
    Вызов локальной процедуры. Может использовать протокол общей памяти, если клиент соединяется с экземпляром компонента SQL Server на том же компьютере.

  • via
    Протокол VIA. Используйте оборудование, поддерживающее протокол VIA. Для получения дополнительных сведений о том, как использовать VIA, свяжитесь с поставщиком оборудования.

    Примечание
    Протокол VIA является устаревшим. В будущей версии Microsoft SQL Server эта возможность будет удалена. Избегайте использования этой возможности в новых разработках и запланируйте изменение существующих приложений, в которых она применяется.

  Дополнительные сведения о протоколах см. в разделе Выбор сетевого протокола.

• /Q
  Запускает программу SQLdiag в тихом режиме. Параметр /Q блокирует все запросы, например запросы на ввод пароля.

• /G
  Запускает программу SQLdiag в обычном режиме. Если указан параметр /G, при запуске SQLdiag не осуществляется принудительная проверка подключения SQL Server или проверка членства пользователя в предопределенной роли сервера sysadmin. Вместо этого SQLdiag запрашивает у Windows определение наличия у пользователя соответствующих прав для сбора каждого из запрашиваемых диагностических сведений.

  Если параметр /G не указан, программа SQLdiag выполнит проверку, чтобы определить, является ли пользователь членом группы Администраторы Windows, и не будет собирать диагностические сведения SQL Server, если пользователь не является членом группы Администраторы.

• /R
  Регистрирует SQLdiag в качестве службы. Все аргументы командной строки, указанные при регистрации SQLdiag в качестве службы, сохраняются при последующих запусках службы.

  При регистрации SQLdiag в качестве службы имя службы по умолчанию — SQLDIAG. Изменить имя службы можно с помощью аргумента /A.

  Для запуска службы используйте аргумент командной строки START:

  SQLDIAG START

  Также для запуска службы можно использовать команду net start:

  net start SQLDIAG

• /U
  Отменяет регистрацию службы SQLdiag.

  Если нужно отменить регистрацию именованного экземпляра SQLdiag, используйте также аргумент /A.

• /L
  Запускает программу SQLdiag в непрерывном режиме, когда также указано время запуска или время остановки аргументами /B или /E соответственно. Программа SQLdiag автоматически перезапускается после того, как сбор диагностических сведений останавливается из-за запланированного завершения работы. Например, при использовании аргументов /E или /X.

  Примечание
  Программа SQLdiag не учитывает аргумент /L, если время запуска или остановки не указано с помощью аргументов командной строки /B и /E.

  Параметр /L не подразумевает запуск в качестве службы. Чтобы использовать параметр /L при запуске SQLdiag в качестве службы, укажите его в командной строке при регистрации службы.

• /X
  Запускает программу SQLdiag в режиме моментального снимка. SQLdiag создает моментальный снимок всех настроенных диагностических сведений и автоматически завершает работу.

• START | STOP | STOP_ABORT
  Запускает или останавливает службу SQLdiag. Параметр STOP_ABORT вызывает максимально быстрое завершение работы службы, не дожидаясь окончания выполняемого в настоящий момент сбора диагностических сведений.

  Если используются эти аргументы управления службой, они должны быть первыми аргументами в командной строке. Например:

  SQLDIAG START

  Только аргумент /A, указывающий именованный экземпляр SQLdiag, может быть использован вместе со START, STOP или STOP_ABORT для управления определенным экземпляром службы SQLdiag. Например:

  SQLDIAG START /ASQLdiag_application_name

Требования безопасности

Кроме случая, когда SQLdiag выполняется в обычном режиме (с помощью аргумента командной строки /G), пользователь, запускающий SQLdiag, должен быть членом группы Администраторы Windows и членом предопределенной роли сервера SQL Serversysadmin. По умолчанию программа SQLdiag подключается к SQL Server, используя проверку подлинности Windows, но поддерживает и проверку подлинности SQL Server.

Вопросы производительности

Влияние выполнения SQLdiag на производительность зависит от типа собираемых диагностических данных. Например, если программа SQLdiag настроена на сбор трассировочных сведений Приложение SQL Server Profiler, то количество классов событий, выбранных для отслеживания, будет влиять на производительность сервера.

Воздействие выполнения программы SQLdiag на производительность приблизительно равно сумме затрат на сбор диагностических сведений по отдельности. Например, сбор трассировочных сведений с помощью SQLdiag влияет на производительность так же, как их сбор с помощью Приложение SQL Server Profiler. Влияние программы SQLdiag на производительность незначительно.

Необходимое место на диске

Поскольку программа SQLdiag может собирать различные типы диагностических сведений, количество свободного места на диске, необходимого для выполнения SQLdiag, может различаться. Объем собранных диагностических сведений зависит от характера и объема рабочей нагрузки, которую обрабатывает сервер, и может меняться от нескольких мегабайтов до нескольких гигабайтов.

Файлы конфигурации

При запуске программа SQLdiag считывает файл конфигурации и указанные аргументы командной строки. Типы диагностических сведений, которые собирает программа SQLdiag, указываются в файле конфигурации. По умолчанию программа SQLdiag использует файл конфигурации SQLDiag.Xml, который извлекается каждый раз при запуске программы и расположен в папке запуска SQLdiag. Файл конфигурации использует схему XML SQLDiag_schema.xsd, которая также извлекается в каталог запуска программы из исполняемого файла каждый раз при выполнении SQLdiag.

Изменение файлов конфигурации

Выходная папка

Если выходная папка не была указана с помощью аргумента /O, программа SQLdiag создаст вложенную папку с именем SQLDIAG в папке запуска SQLdiag. Для сбора диагностических сведений, сопряженного с трассировкой больших объемов данных, например сведений Приложение SQL Server Profiler, убедитесь, что выходная папка находится на локальном диске, имеющем достаточное количество свободного места для хранения этих данных.

После перезапуска программы SQLdiag она перезаписывает содержимое выходной папки. Чтобы избежать этого, укажите в командной строке /N 2.

Процесс сбора данных

При запуске программа SQLdiag выполняет начальные проверки, необходимые для сбора диагностических данных, указанных в файле SQLDiag.Xml. Этот процесс может занять несколько секунд. После того, как программа SQLdiag начала сбор диагностических данных в режиме приложения командной строки, выводимые сообщения информируют о том, что SQLdiag начала сбор данных, и остановить процесс можно, нажав CTRL+C. Если программа SQLdiag работает как служба, похожее сообщение будет записано в журнал событий Windows.

Если программа SQLdiag используется для диагностики проблемы, которую можно воспроизвести, дождитесь этого сообщения прежде, чем воспроизводить проблему на сервере.

Программа SQLdiag собирает большую часть диагностических данных параллельно. Все диагностические сведения собираются с помощью соединения со средствами, таким как программа SQL Serversqlcmd или интерпретатор командной строки Windows, кроме тех случаев, когда сведения собираются из журналов производительности Windows и журналов событий. Для наблюдения за сбором диагностических данных с помощью таких средств программа SQLdiag использует один рабочий поток на компьютере, при этом часто несколько средств работают одновременно. В процессе сбора данных программа SQLdiag направляет выходной поток каждого средства диагностики в выходную папку.

Остановка сбора данных

После начала сбора диагностических данных программа SQLdiag продолжает этот процесс, пока не будет остановлена пользователем или остановится в указанное время. Настроить программу SQLdiag для остановки в указанное время можно с помощью аргумента /E, который позволяет указать время остановки, или с помощью параметра /X, который запускает SQLdiag в режиме моментального снимка.

При остановке программы SQLdiag останавливаются и все запущенные ею средства диагностики. Например, останавливается сбор трассировок Приложение SQL Server Profiler, прекращается выполнение запущенных сценариев Transact-SQL, и останавливаются любые процессы, порожденные программой во время сбора данных. После того, как сбор диагностических данных закончен, программа SQLdiag завершает работу.

Примечание
Приостановка службы SQLdiag не поддерживается. Если совершена попытка приостановить службу SQLdiag, она остановится после того, как закончит сбор диагностических сведений, выполняемый в момент приостановки. Если программу SQLdiag запустить повторно после ее остановки, она запустится и перезапишет выходную папку. Чтобы избежать перезаписи выходной папки, укажите в командной строке /N 2.

Остановка программы SQLdiag, выполняющейся в режиме приложения командной строки

Если программа SQLdiag запущена в виде приложения командной строки, для ее остановки нажмите CTRL+C в окне консоли, в котором выполняется SQLdiag. После нажатия CTRL+C в окне консоли отобразится сообщение о том, что программа SQLDiag заканчивает сбор данных, и нужно подождать, пока процесс завершится, что может занять несколько минут.

Нажмите Ctrl+C дважды, чтобы принудительно завершить все дочерние диагностические процессы и немедленно завершить приложение.

Остановка программы SQLdiag, выполняющейся в режиме службы

Если SQLdiag запущена как служба, выполните SQLDiag STOP в папке запуска SQLdiag, чтобы остановить программу.

Если на одном компьютере выполняется несколько экземпляров SQLdiag, для остановки службы в командной строке можно также передать имя экземпляра SQLdiag. Например, чтобы остановить экземпляр SQLdiag с именем Instance1, используйте следующий синтаксис:

SQLDIAG STOP /A Instance1

Примечание

/A — единственный параметр командной строки, который может использоваться вместе со START, STOP или STOP_ABORT. Если нужно указать именованный экземпляр SQLdiag вместе с одной из команд управления службой, укажите /A в командной строке после команды управления, как показано в предыдущем примере синтаксиса. Если используются команды управления, они должны быть первыми аргументами в командной строке.

Чтобы остановить службу как можно быстрее, выполните в папке запуска программы команду SQLDIAG STOP_ABORT. Эта команда прерывает любой сбор диагностических данных, выполняемый в настоящее время, не ожидая его завершения.

Примечание
Используйте SQLDiag STOP или SQLDIAG STOP_ABORT для остановки службы SQLdiag. Не используйте консоль служб Windows, чтобы остановить SQLdiag или другие службы SQL Server.

Автоматический запуск и остановка SQLdiag

Чтобы автоматически запускать и останавливать сбор диагностических данных в указанное время, используйте аргументы /Bstart_time и /Estop_time в 24-часовом формате времени. Например, если нужно устранить неполадку, которая регулярно происходит приблизительно в 02:00:00, то можно настроить программу SQLdiag таким образом, чтобы она автоматически начинала собирать диагностические данные в 01:00 и останавливалась в 03:00:00. Укажите аргументы /B и /E, чтобы указать время запуска и остановки. Используйте 24-часовой формат времени, чтобы указать точную дату и время запуска и остановки в формате ГГГГММДД_ЧЧ:ММ:СС. Чтобы указать относительное время запуска или остановки, поставьте в начале времени запуска и остановки + и не указывайте составляющую даты (ГГГГММДД_), как показано в следующем примере, где программа SQLdiag ждет 1 час перед началом сбора сведений, затем собирает сведения в течение 3 часов и завершает работу:

sqldiag /B +01:00:00 /E +03:00:00

Если указано относительное start_time, программа SQLdiag запустится в момент времени, вычисляемый относительно текущей даты и времени. Если указано относительное end_time, программа SQLdiag завершит работу в момент времени, вычисляемый относительно указанного start_time. Если указать время запуска или окончания, которое уже прошло, программа SQLdiag принудительно изменит дату запуска таким образом, что дата и время запуска будут находиться в будущем.

В силу этой особенности выбираемые даты запуска и завершения работы имеют большое значение. Рассмотрим следующий пример:

sqldiag /B +01:00:00 /E 08:30:00

Если текущее время — 08:00, время завершения работы наступит прежде, чем начнется сбор диагностических данных. Поскольку SQLDiag автоматически прибавляет к дате запуска и завершения работы один день в случае, если время уже просрочено, в этом примере сбор диагностических сведений начнется в 09:00 текущего дня (относительное время запуска было указано с помощью префикса +) и продолжится до 08:30 следующего утра.

Остановка и перезапуск SQLdiag для сбора ежедневных диагностических сведений

sqldiag /B 03:00:00 /E 05:00:00 /L

sqldiag /B 03:00:00 /X /L

Работа программы SQLdiag в качестве службы

Если программу SQLdiag планируется использовать для сбора диагностических данных в течение длительных промежутков времени, во время которых может понадобиться выходить из системы компьютера, на котором выполняется SQLdiag, можно запустить ее как службу.

SQLDIAG START /A Instance1

Работа нескольких экземпляров программы SQLdiag

Запустить несколько экземпляров программы SQLdiag на одном компьютере можно, указав в командной строке /ASQLdiag_application_name. Это полезно для одновременного сбора различных наборов диагностических сведений для одного экземпляра SQL Server. Например, именованный экземпляр SQLdiag можно настроить на непрерывное выполнение сбора небольшого количества данных. Тогда в случае возникновения определенной проблемы на SQL Server можно запустить экземпляр SQLdiag по умолчанию, чтобы собрать диагностические данные об этой проблеме или собрать набор диагностических данных, запрошенных службами поддержки пользователей Майкрософт для диагностики проблемы.

Сбор диагностических данных из кластеризованных экземпляров SQL Server

Программа SQLdiag поддерживает сбор диагностических данных из кластеризованных экземпляров SQL Server. Для сбора диагностических данных из кластеризованных экземпляров SQL Server убедитесь, что в качестве атрибута name элемента <Machine> в файле конфигурации SQLDiag.Xml указан символ ".", и не указывайте аргумент командной строки /G. По умолчанию для атрибута name в файле конфигурации указывается символ ".", а аргумент /G отключен. Как правило, при сборе данных из кластеризованных экземпляров SQL Server не нужно изменять файл конфигурации или аргументы командной строки.

Если в качестве имени компьютера указан символ ".", то программа SQLdiag определяет, что она выполняется на кластере, и одновременно получает диагностические сведения для всех виртуальных экземпляров SQL Server, установленных в этом кластере. Если нужно собрать диагностические сведения только для одного виртуального экземпляра SQL Server, выполняющегося на компьютере, укажите этот виртуальный экземпляр SQL Server в качестве атрибута name элемента <Machine> в файле SQLDiag.Xml.

Примечание
Для сбора сведений о трассировках приложения Приложение SQL Server Profiler от кластеризованных экземпляров SQL Server на кластере должны быть доступны административные общие папки (ADMIN$).

См. также

Основные понятия