Настройка поставщиков для централизованной службы ведения журналов в Lync Server 2013Configuring providers for Centralized Logging Service in Lync Server 2013

 

Последнее изменение темы: 2014-03-19Topic Last Modified: 2014-03-19

Основные понятия и настройка поставщиков централизованной службы ведения журналов — это одна из самых важных.The concepts and configuration of providers in Centralized Logging Service is one of the most important to grasp. Поставщики напрямую сопоставляются с компонентами роли сервера Lync Server в модели трассировки Lync Server.The providers map directly to Lync Server server role components in the Lync Server tracing model. Поставщик определяет компоненты Lync Server 2013, которые будут трассироваться, тип сообщений (например, Неустранимая ошибка, ошибка или предупреждение) и флаги (например, TF _ Connection или TF _ diag).The provider defines the components of a Lync Server 2013 that will be traced, the type of messages (for example, fatal, error, or warning) to collect, and the flags (for example, TF_Connection or TF_Diag). Поставщики — это компоненты для трассировки в каждой роли сервера Lync Server.Providers are the traceable components in each Lync Server server role. С помощью поставщиков вы определяете уровень и тип трассировки компонентов (например, S4, SIPStack, мгновенных сообщений и сведений о присутствии).By using providers, you define the level and type of tracing on components (for example, S4, SIPStack, IM and Presence). Определенный поставщик используется в сценарии для группирования всех поставщиков для указанной логической коллекции, которые относятся к определенному условию проблемы.The defined provider is used in a scenario to group all of the providers for a given logical collection that address a specific problem condition.

Для запуска функций централизованной службы ведения журналов с помощью командной консоли Lync Server необходимо быть членом группы безопасности CsAdministrator или CsServerAdministrator с управлением доступом на основе ролей (RBAC) или настраиваемой роли RBAC, которая содержит любую из этих двух групп.To run the Centralized Logging Service functions using the Lync Server Management Shell, you must be a member of either the CsAdministrator or the CsServerAdministrator role-based access control (RBAC) security groups, or a custom RBAC role that contains either of these two groups. Чтобы получить список всех ролей управления доступом на основе ролей (RBAC), которым назначен этот командлет (включая все самостоятельно созданные роли RBAC), выполните следующую команду в командной консоли Lync Server или в командной строке Windows PowerShell:To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Lync Server Management Shell or the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Lync Server 2013 cmdlet"}

Пример:For example:

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Set-CsClsConfiguration"}

Оставшаяся часть этого раздела посвящена способам определения поставщиков, изменению поставщика и определениям, содержащимся в определении поставщика для оптимизации устранения неполадок.The remainder of this topic focuses on how to define providers, modify a provider and what a provider definition contains to optimize your troubleshooting. Существует два способа выдача команд службы централизованного ведения журналов.There are two ways to issue Centralized Logging Service commands. Вы можете использовать CLSController.exe, расположенный по умолчанию, в папке C: \ Program Files \ Common Files \ Microsoft Lync Server 2013 \ CLSAgent.You can use the CLSController.exe that is located, by default, in the directory C:\Program Files\Common Files\Microsoft Lync Server 2013\CLSAgent. Вы также можете использовать командную консоль Lync Server для выполнения команд Windows PowerShell.Or, you can use the Lync Server Management Shell to issue Windows PowerShell commands. Важное отличие заключается в том, что при использовании CLSController.exe в командной строке существует ограниченный выбор сценариев, в которых поставщики уже определены и не могут изменяться, но вы можете определить уровень ведения журнала.The important distinction is that when you use CLSController.exe at the command line there is a finite selection of scenarios available in which the providers are already defined and are not changeable, but you can define the log level. С помощью Windows PowerShell вы можете определить новых поставщиков для использования в сеансах ведения журнала и получить полный контроль над их созданием, тем, что они собирают, и на каком уровне они собирают данные.By using Windows PowerShell, you can define new providers for use in your logging sessions, and have complete control over their creation, what they collect, and at what level they collect data.

Важно!

Как уже упоминалось, поставщики являются очень мощным средством. Однако сценарии имеют большее значение, так как объединяют в себе все данные, необходимые для определения и выполнения трассировок компонентов, представленных поставщиками. Сценарии, которые являются коллекциями поставщиков, можно сравнить с выполнением пакетного файла, содержащего сотни команд, для сбора большого объема данных, что отличается от выполнения сотен команд по одной в командной строке.As mentioned, providers are very powerful. However, scenarios are more powerful because they contain the embodiment of all information needed to set and execute tracing on the components that the providers represent. With scenarios being a collection of providers, this could be loosely compared to running a batch file containing hundreds of commands to collect a lot of information versus issuing hundreds of commands, one at a time, at the command line.
Вместо того чтобы потребовать глубокой детализации сведений о поставщиках, Служба централизованного ведения журналов предоставляет ряд сценариев, которые уже определены для вас.Instead of requiring you to dig deeply into the details of providers, the Centralized Logging Service provides a number of scenarios that are already defined for you. Предоставленные сценарии покрывают большое количество различных проблем и неполадок, которые могут возникнуть.The provided scenarios cover the vast majority of possible issues that you will encounter. В редких случаях может понадобиться создать и определить поставщиков и назначить их в сценарии.In rare cases, you may need to create and define providers and assign them to scenarios. Настоятельно рекомендуется ознакомиться с каждым предоставленным сценарием, прежде чем создавать новых поставщиков и сценарии.We strongly recommend that you become familiar with each of the scenarios provided before you investigate the need to create new providers and scenarios. Хотя здесь предоставляются сведения о создании поставщиков, чтобы вы могли ознакомиться с тем, как сценарии используют элементы поставщиков для сбора данных трассировок, сведения о самих поставщиках в настоящее время не предоставлены.While information about creating providers is found here to familiarize you with how the scenarios use the provider elements to collect trace information, details on the providers themselves are not provided at this time.

В статье Обзор централизованной службы ведения журналов в Lync Server 2013ключевые элементы определения поставщика для использования в сценарии:Introduced in Overview of the Centralized Logging Service in Lync Server 2013, the key elements of defining a provider for use in a scenario are:

  • Поставщики услуг     Если вы знакомы с OCSLogger, поставщики — это компоненты, которые вы назначите, чтобы сообщить OCSLogger о том, какие журналы должны собираться ядром трассировки.Providers   If you are familiar with OCSLogger, providers are the components that you choose to tell OCSLogger what the tracing engine should collect logs from. Поставщики — это те же компоненты, а во многих случаях их имя совпадает с компонентами в OCSLogger.The providers are the same components, and in many cases have the same name as the components in OCSLogger. Если вы не знакомы с OCSLogger, поставщики — это компоненты, зависящие от роли сервера, из которых Служба централизованного ведения журналов может собирать журналы.If you are not familiar with OCSLogger, providers are server-role specific components that the Centralized Logging Service can collect logs from. В случае централизованной службы ведения журналов CLSAgent — это архитектурная часть централизованной службы ведения журналов, которая выполняет трассировку компонентов, которые вы определили в конфигурации поставщиков.In the case of the Centralized Logging Service, the CLSAgent is the architectural part of the Centralized Logging Service that is doing the tracing of the components that you define in the providers configuration.

  • Уровни     ведения журнала OCSLogger предоставляет возможность выбрать количество уровней детализации собранных данных.Logging levels   OCSLogger provided the option to choose a number of levels of detail for the data collected. Эта функция является неотъемлемой частью централизованной службы ведения журналов и сценариев и определяется с помощью параметра Type .This feature is an integral part of the Centralized Logging Service and scenarios, and is defined by the Type parameter. Вы можете выбрать следующие параметры.You can choose from the following:

    • Все     Собирает сообщения трассировки типа "Неустранимая ошибка", "ошибка", "предупреждение" и "сведения" в журнал для определенного поставщика.All   Collects trace messages of type fatal, error, warning, and info to the log for the defined provider.

    • Неустранимая     Ошибка Собирает только сообщения трассировки, указывающие на сбой определенного поставщика.Fatal   Collects only the trace messages that indicate a failure for the defined provider.

    • Error (ошибка     ) Собирает только сообщения трассировки, указывающие на ошибку определенного поставщика, а также неустранимые сообщения.Error   Collects only the trace messages that indicate an error for the defined provider, plus fatal messages.

    • Warning (предупреждение     ) Собирает только сообщения трассировки, указывающие на предупреждение для определенного поставщика, а также неустранимые сообщения и сообщения об ошибках.Warning   Collects only the trace messages that indicate a warning for the defined provider, plus fatal and error messages.

    • Info (сведения     ) Собирает только сообщения трассировки, указывающие информационное сообщение для определенного поставщика, а также неустранимые, ошибочные и предупреждающие сообщения.Info   Collects only the trace messages that indicate an informational message for the defined provider, plus fatal, error, and warning messages.

    • Подробные сведения     Собирает все сообщения трассировки типа "Неустранимая ошибка", "ошибка", "предупреждение" и "информация" для определенного поставщика.Verbose   Collects all trace messages of type fatal, error, warning and info for the defined provider.

  • Flags (флаги     ) OCSLogger предоставляет возможность выбора флагов для каждого поставщика, определяющего тип данных, которые можно получить из файлов трассировки.Flags   OCSLogger provided the option to choose flags for each provider that defined what type of information you could retrieve from the trace files. В зависимости от поставщика можно задать следующие флаги:You can chose the following flags, based on the provider:

    • Tf _ Подключение     предоставляет записи журнала, связанные с подключением.TF_Connection   Provides connection-related log entries. Эти журналы включают сведения о подключениях к определенному компоненту.These logs include information about connections established to and from a particular component. Кроме того, может быть включен большой объем сведений сетевого уровня (то есть для компонентов без концепции подключения).This may also include significant network-level information (that is, for components without the concept of a connection).

    • Tf _ Безопасность     обеспечивает все события и записи журнала, связанные с безопасностью.TF_Security   Provides all events/log entries related to security. Например, для SipStack, это события безопасности, такие как ошибки проверки домена и ошибки проверки подлинности и авторизации клиентов.For example, for SipStack, these are security events such as domain validation failure, and client authentication/authorization failures.

    • Tf _ Средство DIAG     предоставляет диагностические события, которые можно использовать для диагностики или устранения неполадок в компоненте.TF_Diag   Provides diagnostics events that you can use to diagnose or troubleshoot the component. Например, для SipStack это ошибки сертификатов или ошибки/предупреждения, связанные с DNS.For example, for SipStack, these are certificate failures, or DNS warnings/errors.

    • Tf _ Протокол     предоставляет сообщения протокола, такие как SIP и Объединенные сообщения с пакетным кодеком сообщества.TF_Protocol   Provides protocol messages such as SIP and Combined Community Codec Pack messages.

    • Tf _ Компонент     включает ведение журнала для компонентов, указанных как часть поставщиков.TF_Component   Enables logging on the components specified as part of the providers.

    • Все     Задает все доступные флаги, доступные для поставщика.All   Sets all available flags available for the provider.

Просмотр сведений о существующих поставщиках сценариев централизованной службы ведения журналовTo review information about existing Centralized Logging Service scenario providers

  1. Запустите командную консоль Lync Server: нажмите кнопку Пуск, последовательно выберите пункты Все программы и Microsoft Lync Server 2013 и щелкните элемент Командная консоль Lync Server.Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. Чтобы просмотреть конфигурацию существующих поставщиков, введите следующую команду:To review the configuration of existing providers, type the following:

    Get-CsClsScenario -Identity <scope and scenario name> 
    

    Например, чтобы просмотреть сведения о глобальном помощнике конференц-связи, введите следующее:For example, to review information about the global conferencing attendant, type:

    Get-CsClsScenario -Identity "global/CAA"
    

    Команда отображает список поставщиков со связанными флагами, параметрами и компонентами.The command displays a list of providers with the associated flags, settings, and components. Если отображаемая информация не хватает или слишком длинная длина списка для стандартного формата списка Windows PowerShell, можно отобразить дополнительные сведения, определив другой метод вывода.If the information displayed is not enough or the list is too long for the default Windows PowerShell list format, you can display additional information by defining a different output method. Для этого выполните следующую команду:To do this, type:

    Get-CsClsScenario -Identity "global/CAA" | Select-Object -ExpandProperty Provider
    

    В выходе этой команды отображается каждый поставщик. Каждая запись состоит из пяти строк: имя поставщика, тип ведения журнала, уровень ведения журнала, флаги, GUID и роль.The output of this command displays each provider displayed in a five line format with the provider name, type of logging, logging level, flags, GUID, and role, each one on a separate line.

Определение нового поставщика сценария для централизованной службы ведения журналовTo define a new Centralized Logging Service scenario provider

  1. Запустите командную консоль Lync Server: нажмите кнопку Пуск, последовательно выберите пункты Все программы и Microsoft Lync Server 2013 и щелкните элемент Командная консоль Lync Server.Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. Поставщик сценария состоит из отслеживаемого компонента, используемых флагов и уровня детализации собираемых данных. Это определяется следующей командой:A scenario provider consists of a component to trace, flags to use, and a level of detail to collect. You do this by typing:

    $<variableName> = New-CsClsProvider -Name <provider component> -Type <log type> -Level <log level detail type> -Flags <provider trace log flags>
    

    Например, определение поставщика трассировки, которое указывает, что нужно собирать с поставщика Lyss и при каком уровне детализации, выглядит следующим образом.For example, a trace provider definition that defines what to collect and to what level of detail from the Lyss provider looks like the following:

    $LyssProvider = New-CsClsProvider -Name "Lyss" -Type "WPP" -Level "Info" -Flags "All"
    

Параметр –Level указывает сбор сообщений типа неустранимая ошибка, ошибка, предупреждение и информация.The –Level collects fatal, error, warning, and information messages. Используются все флажки, определенные для поставщика Lyss и включающие _ подключения TF, TF _ diag и TF _ Protocol.The flags used are all of those defined for the Lyss provider, and include TF_Connection, TF_Diag and TF_Protocol.

После определения переменной $LyssProvider можно использовать ее в командлете New-CsClsScenario для сбора трассировок с поставщика Lyss.After the variable $LyssProvider is defined, you can use it with the New-CsClsScenario cmdlet to collect traces from the Lyss provider. Чтобы завершить создание и назначение поставщика новому сценарию, введите следующую команду:To complete the creation and assignment of the provider to a new scenario, type:

New-CsClsScenario -Identity "site:Redmond/RedmondLyssInfo" -Provider $LyssProvider

где $LyssProvider — это переменная, содержащая определенный сценарий, созданный с помощью командлета New-CsClsProvider.Where $LyssProvider is the variable containing the defined scenario created with New-CsClsProvider.

Изменение существующего поставщика сценариев централизованной службы ведения журналовTo change an existing Centralized Logging Service scenario provider

  1. Запустите командную консоль Lync Server: нажмите кнопку Пуск, последовательно выберите пункты Все программы и Microsoft Lync Server 2013 и щелкните элемент Командная консоль Lync Server.Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. Чтобы обновить или изменить конфигурацию существующего поставщика, введите следующую команду:To update or change the configuration of an existing provider, type:

    $LyssProvider = New-CsClsProvider -Name "Lyss" -Type "WPP" -Level "Debug" -Flags "TF_Connection, TF_Diag"
    

    Затем обновите сценарий, чтобы назначить поставщика. Введите следующее:You then update the scenario to assign the provider by typing the following:

    Set-CsClsScenario -Identity "site:Redmond/RedmondLyssInfo" -Provider $LyssProvider
    

Конечный результат выполнения команды — обновление флагов и уровня поставщика назначенного для сайта сценария: Redmond/RedmondLyssInfo.The end result of the command is that the scenario site:Redmond/RedmondLyssInfo will have updated flags and level for the provider assigned to it. Новый сценарий можно просмотреть с помощью командлета Get-CsClsScenario.You can view the new scenario by using Get-CsClsScenario. Дополнительные сведения см. в разделе Get-CsClsScenario.For details, see Get-CsClsScenario.

Предупреждение

New-ClsCsProvider не определяет допустимость флагов.New-ClsCsProvider does not check to determine whether the flags are valid. Убедитесь, что названия флагов указаны верно (например, TF_DIAG или TF_CONNECTION).Make sure that the spelling of the flags (for example, TF_DIAG or TF_CONNECTION) is spelled correctly. Если названия флагов указаны неверно, поставщик не вернет ожидаемые сведения журналов.If the flags are not spelled correctly, the provider cannot return the expected log information.

Если необходимо добавить в этот сценарий дополнительных поставщиков, введите следующую команду:If you want to add additional providers to this scenario, type the following:

Set-CsClsScenario -Identity "site:Redmond/RedmondLyssInfo" -Provider @{Add=$ABSProvider, $CASProvider, S4Provider}

где каждый поставщик, определенный с помощью директивы Add, уже был определен с помощью процесса New-CsClsProvider.Where each provider defined with the Add directive has already been defined using the New-CsClsProvider process.

Чтобы удалить поставщика сценарияTo remove a scenario provider

  1. Запустите командную консоль Lync Server: нажмите кнопку Пуск, последовательно выберите пункты Все программы и Microsoft Lync Server 2013 и щелкните элемент Командная консоль Lync Server.Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. Приведенные командлеты позволяют обновить существующих поставщиков и создать новых.The cmdlets provided allow you to update existing providers and create new providers. Чтобы удалить поставщика, необходимо использовать директиву Replace для параметра Provider в командлете Set-CsClsScenario.To remove a provider, you must use the Replace directive for the Provider parameter to Set-CsClsScenario. Единственным способом полностью удалить поставщика является замена его на переопределенного поставщика того же типа с тем же именем, что выполняется с помощью директивы Update.The only way to completely remove a provider is to replace it with a redefined provider of the same name and use the Update directive. Например, наш поставщик LyssProvider определяется с помощью конвейера WPP в качестве типа журнала, уровня "Отладка", а флаги Set — TF _ Connection и TF _ DIAG.For example, our provider LyssProvider is defined with WPP as the log type, level set to Debug, and flags set are TF_CONNECTION and TF_DIAG. Необходимо изменить флаги на All.You need to change the flags to “All”. Чтобы изменить поставщика, выполните следующую команду:To change the provider, type the following:

    $LyssProvider = New-CsClsProvider -Name "Lyss" -Type "WPP" -Level "Debug" -Flags "All"
    

     

    Set-CsClsScenario -Identity "site:Redmond/RedmondLyssInfo" -Provider @{Replace=$LyssProvider}
    
  3. Если необходимо полностью удалить сценарий и связанных с ним поставщиков, выполните следующую команду:If you want to completely remove a scenario and the providers associated with it, type the following:

    Remove-CsClsScenario -Identity <scope and name of scenario>
    

    Пример:For example:

    Remove-CsClsScenario -Identity "site:Redmond/RedmondLyssInfo"
    

    Предупреждение

    Командлет Remove-CsClsScenario не запрашивает подтверждения.The cmdlet Remove-CsClsScenario does not prompt you for confirmation. Сценарий удаляется вместе со всеми назначенными ему поставщиками.The scenario is deleted, along with the providers that were assigned to it. Можно повторно создать сценарий, повторно выполнив команды, которые использовались для его исходного создания.You can recreate the scenario by re-running the commands used to create it initially. Процедуры восстановления удаленных сценариев или поставщиков не существует.There is no procedure to recover removed scenarios or providers.

При удалении сценария с помощью командлета Remove-CsClsScenario вы полностью удаляете сценарий из области применения.When you remove a scenario by using the Remove-CsClsScenario cmdlet, you completely remove the scenario from the scope. Чтобы использовать созданные сценарии и поставщиков, которые являются частью сценария, необходимо создать новых поставщиков и назначить их новому сценарию.To use the scenarios that you created and the providers that were a part of the scenario, you create new providers and assign them to a new scenario.