Журналирование сетевых взаимодействий
Внимание!
Настройки, приведенные в данном разделе, не могут быть выполнены в ОС СН Astra Linux Special Edition.
Сервис Проверки Подписи позволяет вести журналирование и протоколирование сообщений, которыми обмениваются веб-клиент и веб-служба Сервиса Проверки Подписи.
Журналирование используется для вывода информации о потоке выполнения и отдельных действий различных компонентов распределенного приложения. Механизм протоколирования сообщений, в свою очередь, предназначен для сохранения содержимого сообщений, которыми обмениваются веб-клиент и веб-служба.
В Сервисе Проверки Подписи возможности журналирования предоставляются технологией Windows Communication Foundation (WCF). Основными источниками журналирования WCF являются System.ServiceModel и System.ServiceModel.MessageLogging. Источник журналирования System.ServiceModel — наиболее общий источник журналирования WCF, записывающий основные этапы приложения по всему стеку связи WCF: от входа и выхода из транспорта до входа и выхода из пользовательского кода. Источник журналирования System.ServiceModel.MessageLogging записывает все сообщения, проходящие через систему.
Сервис Проверки Подписи позволяет настроить журналирование из вышеуказанных источников
отдельно для каждого из своих компонентов. Для каждого из источников журналирования можно
настроить уровень журналирования и путь к файлу, в который будет записываться журнал. Файлы
журналов имеют расширение .svclog, и для просмотра таких файлов используется программа
SvcTraceViewer.exe.
Настройка журналирования осуществляется с помощью командлетов, входящих в состав модуля CryptoPro.DSS.PowerShell.VS.
Командлеты журналирования
Список командлетов журналирования:
Командлет Get-VsTracing
Командлет Get-VsTracing позволяет вывести на экран значения параметров журналирования Сервиса Проверки Подписи.
Синтаксис:
Get-VsTracing [-DisplayName <string>]
Командлет Set-VsTracing
Командлет Set-VsTracing позволяет установить значения параметров журналирования Сервиса Проверки Подписи.
Синтаксис:
Set-VsTracing
[-ServiceModelListenerLogFile <string>]
[-ServiceModelListenerSourceLevel <SourceLevels> {Off | Critical | Error | Warning | Information | Verbose | ActivityTracing | All}]
[-ServiceModelListenerMaxLogFileSize <int>]
[-ServiceModelListenerCircularFilesCount <int>]
[-ServiceModelMessageLoggingListenerLogFile <string>]
[-ServiceModelMessageLoggingListenerSourceLevel <SourceLevels> {Off | Critical | Error | Warning | Information | Verbose | ActivityTracing | All}]
[-ServiceModelMessageLoggingListenerMaxLogFileSize <int>]
[-ServiceModelMessageLoggingListenerCircularFilesCount <int>]
[-DisplayName <string>]
| Параметр | Тип | Описание |
|---|---|---|
| DisplayName | string | Отображаемое имя экземпляра компонента Сервера Подписи. Если значение не указано, будет использован экземпляр, назначенный по умолчанию. |
| ServiceModelListenerLogFile | string | Путь к файлу журнала из источника ServiceModel. |
| ServiceModelListenerSourceLevel | SourceLevels | Уровень журналирования из источника ServiceModel. |
| ServiceModelListenerMaxLogFileSize | int | Максимальный размер файла журнала из источника ServiceModel (в байтах). Размер файла журнала может принимать значение от ~5Mb до ~50Mb. |
| ServiceModelMessageLoggingListenerCircularFilesCount | int | Максимальное количество создаваемых файлов журналов от источника ServiceModelMessageLogging. Если значение выставлено в 0, то количество создаваемых файлов журналов не ограничено. |
| ServiceModelListenerCircularFilesCount | int | Максимальное количество создаваемых файлов журналов от источника ServiceModel. Если значение выставлено в 0, то количество создаваемых файлов журналов не ограничено. |
| ServiceModelMessageLoggingListenerLogFile | string | Путь к файлу журнала из источника ServiceModelMessageLogging. |
| ServiceModelMessageLoggingListenerSourceLevel | SourceLevels | Уровень журналирования из источника ServiceModelMessageLogging. |
| ServiceModelMessageLoggingListenerMaxLogFileSize | int | Максимальный размер файла журнала из источника ServiceModelMessageLogging (в байтах). Размер файла журнала может принимать значение от ~5Mb до ~50Mb. |
SourceLevels — перечисление уровней журналирования, принимающее значения All, Off, Critical, Error, Warning, Information, Verbose, ActivityTracing. Более подробную информацию о данном перечислении можно узнать на сайте MSDN.
Параметры ServiceModelListenerCircularFilesCount и ServiceModelMessageLoggingListenerCircularFilesCount определяют количество создаваемых файлов журналов. Значение «0» данных параметров означает отсутствие ограничения на количество создаваемых файлов журналов. По достижению максимального размера файла (определяется параметрами ServiceModelMessageLoggingListenerMaxLogFileSize и ServiceModelListenerMaxLogFileSize) будет создан новый файл, в который в дальнейшем будет продолжаться запись журнала. При достижении максимального количества файлов журналов запись вновь начнется с первого файла.
Примечание
К моменту включения журналирования каталог для записи файлов журналов должен существовать. В противном случае при запуске Сервиса Проверки Подписи произойдет критическая ошибка.
Учетной записи Сервиса Проверки Подписи требуется выдать права на запись в указанный каталог.
Командлет Enable-VsTracing
Командлет Enable-VsTracing активирует журналирование Сервиса Проверки Подписи.
Синтаксис:
Enable-VsTracing [-DisplayName <string>]
Командлет Disable-VsTracing
Командлет Enable-VsTracing деактивирует журналирование Сервиса Проверки Подписи.
Синтаксис:
Disable-VsTracing [-DisplayName <string>]
Пример настройки журналирования SVS
Данный сценарий задает настройки журналирования Сервиса Проверки Подписи.
# Настройка параметров журналирования
Set-VsTracing -ServiceModelListenerLogFile "C:\VsLogs\vs_trace.svclog" -ServiceModelListenerSourceLevel All -ServiceModelListenerMaxLogFileSize 10000000 -ServiceModelMessageLoggingListenerLogFile "C:\VsLogs\vs_msg.svclog" -ServiceModelMessageLoggingListenerSourceLevel All -ServiceModelMessageLoggingListenerMaxLogFileSize 10000000 -ServiceModelListenerCircularFilesCount 10 -ServiceModelMessageLoggingListenerCircularFilesCount 10
# Включение журналирования
Enable-VsTracing