Configurando cenários para o serviço de registro em log centralizado no Lync Server 2013Configuring scenarios for the Centralized Logging Service in Lync Server 2013

 

Última modificação do tópico: 2014-02-05Topic Last Modified: 2014-02-05

Os cenários definem o escopo (ou seja, global, site, pool ou computador) e quais provedores usar no serviço de registro em log centralizado.Scenarios define the scope (that is, global, site, pool, or computer) and what providers to use in the Centralized Logging Service. Usando cenários, você habilita e desabilita o rastreamento nos provedores (por exemplo, S4, SIPStack, mensagens instantâneas e presença).By using scenarios, you enable or disable tracing on providers (for example, S4, SIPStack, IM, and Presence). Ao configurar um cenário, você pode agrupar todos os provedores de determinado conjunto lógico que tratam um problema específico.By configuring a scenario, you can group all of the providers for a given logical collection that address a specific problem condition. Se você achar que um cenário precisa ser modificado para atender às suas necessidades de solução de problemas e log, as ferramentas de depuração do Lync Server 2013 fornecem um módulo do Windows PowerShell chamado ClsController. psm1 que contém uma função chamada Edit-CsClsScenario.If you find that a scenario needs to be modified to meet your troubleshooting and logging needs, the Lync Server 2013 Debug Tools provides you a Windows PowerShell module named ClsController.psm1 that contains a function named Edit-CsClsScenario. A finalidade desse módulo é editar as propriedades do cenário nomeado.The purpose of the module is to edit the properties of the named scenario. Neste tópico, serão fornecidos exemplos de como esse módulo funciona.Examples of how this module works are provided in this topic. As ferramentas de depuração do Lync Server 2013 são baixadas do seguinte link: https://go.microsoft.com/fwlink/?LinkId=285257The Lync Server 2013 Debug Tools are downloaded from the following link: https://go.microsoft.com/fwlink/?LinkId=285257

Importante

Para qualquer dado escopo (global, site, pool ou computador), é possível executar no máximo dois cenários por vez.For any given scope—site, global, pool or computer—you can run a maximum of two scenarios at any given time. Para determinar quais cenários estão em execução no momento, use o Windows PowerShell e o Get-CsClsScenario.To determine which scenarios are currently running, use Windows PowerShell and Get-CsClsScenario. Usando o Windows PowerShell e o set-CsClsScenario, você pode alterar dinamicamente quais cenários estão em execução.By using Windows PowerShell and Set-CsClsScenario, you can dynamically change which scenarios are running. Você pode modificar quais cenários estão em execução durante uma sessão de registro em log para ajustar ou refinar os dados coletados e de quais provedores.You can modify which scenarios are running during a logging session to adjust or refine the data you are collecting and from which providers.

Para executar as funções de serviço de registro em log centralizado usando o Shell de gerenciamento do Lync Server, você deve ser membro dos grupos de segurança do controle de acesso baseado em função do CsAdministrator ou do CsServerAdministrator, ou uma função RBAC personalizada que contenha um desses dois grupos.To run the Centralized Logging Service functions by 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. Para retornar uma lista de todas as funções RBAC às quais este cmdlet foi atribuído, incluindo qualquer função RBAC personalizada que você criou sozinho, execute o seguinte comando no Shell de gerenciamento do Lync Server ou no prompt do Windows PowerShell:To return a list of all the 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"}

Por exemplo:For example:

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

O restante deste tópico se concentra em como definir um cenário, modificar um cenário, recuperar quais cenários estão em execução, remover um cenário e especificar o que um cenário contém para otimizar a solução de problemas.The remainder of this topic focuses on how to define a scenario, modify a scenario, retrieve what scenarios are running, remove a scenario, and specify what a scenario contains to optimize your troubleshooting. Há duas maneiras de emitir comandos de serviço de registro centralizado.There are two ways to issue Centralized Logging Service commands. Você pode usar o CLSController.exe localizado, por padrão, no diretório C: Arquivos de \ programas \ comuns \ do 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. Ou você pode usar o Shell de gerenciamento do Lync Server para emitir comandos do Windows PowerShell.Or, you can use the Lync Server Management Shell to issue Windows PowerShell commands. A distinção importante é que, quando você usa CLSController.exe na linha de comando, há uma seleção finita de cenários disponíveis.The important distinction is that when you use CLSController.exe at the command line there is a finite selection of scenarios available. Ao usar o Windows PowerShell, você pode definir novos cenários para usar em suas sessões de registro em log.When you use Windows PowerShell, you can define new scenarios for use in your logging sessions.

Como apresentado na visão geral do serviço de registro em log centralizado no Lync Server 2013, os elementos de um cenário são:As introduced in Overview of the Centralized Logging Service in Lync Server 2013, the elements of a scenario are:

  • Provedores     Se você estiver familiarizado com o OCSLogger, os provedores são os componentes que você escolhe para informar ao OCSLogger o que o mecanismo de rastreamento deve coletar logs.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. Os provedores são os mesmos componentes e, em muitos casos, têm o mesmo nome que os componentes do OCSLogger.The providers are the same components, and in many cases have the same name as the components in OCSLogger. Se você não estiver familiarizado com o OCSLogger, os provedores são componentes específicos de função de servidor que o serviço de registro em log centralizado pode coletar logs.If you are not familiar with OCSLogger, providers are server role specific components that the Centralized Logging Service can collect logs from. Para obter detalhes sobre a configuração de provedores, consulte Configuring Providers for central Logging Service in Lync Server 2013.For details about the configuration of providers, see Configuring providers for Centralized Logging Service in Lync Server 2013.

  • Identity     O parâmetro – Identity define o escopo e o nome do cenário.Identity   The parameter –Identity sets the scope and name of the scenario. Por exemplo, você pode definir um escopo "global" e identificar o cenário como “LyssServiceScenario”.For example, you could set a scope of “global” and identify the scenario with “LyssServiceScenario”. Ao combinar os dois, você define a identidade (por exemplo, “global/LyssServiceScenario”).When you combine the two, you define the Identity (for example, “global/LyssServiceScenario”).

    Opcionalmente, você pode usar os parâmetros –Name e –Parent. Você define o parâmetro Name para identificar exclusivamente o cenário. Se usá-lo, também deverá usar Parent para adicionar o cenário ao escopo global ou site.Optionally, you can use the –Name and –Parent parameters. You define the Name parameter to uniquely identify the scenario. If you use Name, you must also use Parent to add the scenario to either global or site.

    Importante

    Se você usar os parâmetros Name e Parent, não poderá usar o parâmetro –Identity.If you use the Name and Parent parameters, you cannot use the –Identity parameter.

Para criar um novo cenário com o cmdlet New-CsClsScenarioTo create a new scenario with the New-CsClsScenario cmdlet

  1. Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, em Todos os Programas, em Microsoft Lync Server 2013 e em Shell de Gerenciamento do 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. Para criar um novo cenário para uma sessão de registro em log, use New-CsClsProvider e defina o nome do cenário (ou seja, como ele será identificado exclusivamente).To create a new scenario for a logging session, use New-CsClsProvider and define the name of the scenario (that is, how it will be uniquely identified). Escolha um tipo de formato de registro em log entre WPP (ou seja, o pré-processador de rastreamento de software do Windows, que é o padrão), EventLog (ou seja, o formato de log de eventos do Windows) ou IISLog (ou seja, o arquivo de formato ASCII baseado no formato de arquivo de log do IIS).Choose a type of logging format from WPP (that is, Windows software tracing preprocessor and is the default), EventLog (that is, Windows event log format), or IISLog (that is, ASCII format file based on the IIS log file format). Em seguida, defina o nível (conforme definido em Níveis de registro em log neste tópico) e os sinalizadores (conforme definido em Sinalizadores neste tópico).Next, define Level (as the defined under Logging Levels in this topic), and Flags (as defined under Flags in this topic).

    Para este cenário de exemplo, usaremos LyssProvider como a variável de provedor de exemplo.For this example scenario, we use LyssProvider as the example provider variable.

    Para criar um cenário usando as opções definidas, digite:To create a scenario using the options defined, type:

    New-CsClsScenario -Identity <scope>/<unique scenario name> -Provider <provider variable>
    

    Por exemplo:For example:

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

    Formato alternativo usando –Name e –Parent:The alternate format using –Name and –Parent:

    New-CsClsScenario -Name "LyssServiceScenario" -Parent "site:Redmond" -Provider $LyssProvider
    

Para criar um novo cenário com vários provedores usando o cmdlet New-CsClsScenarioTo create a new scenario with multiple providers with the New-CsClsScenario cmdlet

  1. Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, em Todos os Programas, em Microsoft Lync Server 2013 e em Shell de Gerenciamento do 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. Há um limite de dois cenários por escopo.You are limited to two scenarios per scope. No entanto, não há um limite quanto ao número de provedores.However, you are not limited to a set number of providers. Neste exemplo, suponha que criamos três provedores e você deseja atribuir todos eles ao cenário que está definindo.In this example, assume that we have created three providers, and you want to assign all three to the scenario you are defining. Os nomes das variáveis dos provedores são LyssProvider, ABServerProvider e SIPStackProvider.The provider variable names are LyssProvider, ABServerProvider, and SIPStackProvider. Para definir e atribuir vários provedores a um cenário, digite o seguinte em um shell de gerenciamento do Lync Server ou prompt de comando do Windows PowerShell:To define and assign multiple providers to a scenario, type the following at a Lync Server Management Shell or Windows PowerShell command prompt:

    New-CsClsScenario -Identity "site:Redmond/CollectDataScenario" -Provider @{Add=$LyssProvider, $ABServerProvider,  $SIPStackProvider}
    

    Observação

    Como é conhecido no Windows PowerShell, a Convenção para criar uma tabela de hash de valores usando @{<variable>=<value1>, <value2>, <value>...} é conhecida como splatting.As it is known in Windows PowerShell, the convention for creating a hash table of values using @{<variable>=<value1>, <value2>, <value>...} is known as splatting. Para obter detalhes sobre o splatting no Windows PowerShell, consulte https://go.microsoft.com/fwlink/p/?LinkId=267760 .For details about splatting in Windows PowerShell, see https://go.microsoft.com/fwlink/p/?LinkId=267760.

Para modificar um cenário existente com o cmdlet Set-CsClsScenarioTo modify an existing scenario with the Set-CsClsScenario cmdlet

  1. Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, em Todos os Programas, em Microsoft Lync Server 2013 e em Shell de Gerenciamento do 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. Há um limite de dois cenários por escopo. Você pode alterar quais cenários estão em execução a qualquer momento, mesmo quando uma sessão de coleta de log está em andamento. Se você redefinir os cenários em execução, a sessão de registro em log atual parará de usar o cenário que foi removido e começará a usar o novo cenário. No entanto, as informações de log que já foram coletadas com o cenário removido permanecerão nos logs coletados. Para definir um novo cenário, faça o seguinte (pressupondo a adição de um provedor já definido chamado “S4Provider”):You are limited to two scenarios per scope. You can change which scenarios are running at any time, even when a logging capture session is in process. If you redefine the running scenarios, the current logging session will stop using the scenario that was removed and then begin using the new scenario. However, the logging information that was captured with the removed scenario remains in the captured logs. To define a new scenario, do the following (that is, assuming the addition of an already defined provider named “S4Provider”):

    Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Add=<new provider to add>}
    

    Por exemplo:For example:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Add=$S4Provider}
    

    Se você desejar substituir provedores, defina um único provedor ou uma lista separada por vírgulas de provedores para substituir o conjunto atual. Se você desejar substituir apenas um de vários provedores, adicione os provedores atuais junto com os novos provedores para criar um novo conjunto de provedores que contenha os provedores novos e existentes. Para substituir todos os provedores por um novo conjunto, digite o seguinte:If you want to replace providers, define a single provider or a comma separated list of providers to replace the current set. If you only want to replace one of many providers, add the current providers with the new providers to create a new set of providers that contains both new providers and existing providers. To replace all providers with a new set, type the following:

    Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Replace=<providers to replace existing provider set>}
    

    Por exemplo, para substituir o conjunto atual de $LyssProvider, $ABServerProvider e $SIPStackProvider por $LyssServiceProvider:For example, to replace the current set of $LyssProvider, $ABServerProvider, and $SIPStackProvider with $LyssServiceProvider:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider}
    

    Para substituir apenas o provedor $LyssProvider do conjunto atual de $LyssProvider, $ABServerProvider e $SIPStackProvider por $LyssServiceProvider, digite o seguinte:To replace just the $LyssProvider provider from the current set of $LyssProvider, $ABServerProvider, and $SIPStackProvider with $LyssServiceProvider, type the following:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider, $ABServerProvider, $SIPStackProvider}
    

Para remover um cenário existente com o cmdlet Remove-CsClsScenarioTo remove an existing scenario with the Remove-CsClsScenario cmdlet

  1. Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, em Todos os Programas, em Microsoft Lync Server 2013 e em Shell de Gerenciamento do 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. Se você desejar remover um cenário que foi definido anteriormente, digite o seguinte:If you want to remove a scenario that has been previously defined, type the following:

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

    Por exemplo, para remover o cenário definido site:Redmond/LyssServiceScenario:For example, to remove the defined scenario site:Redmond/LyssServiceScenario:

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

O cmdlet Remove-CsClsScenario remove o cenário especificado, mas os rastreamentos que foram coletados ainda estarão disponíveis nos logs para pesquisa.The Remove-CsClsScenario cmdlet removes the specified scenario, but the traces that have been captured are still available in the logs for you to search on.

Para carregar e descarregar o cmdlet Edit-CsClsScenario usando o módulo ClsController.psm1To load and unload the Edit-CsClsScenario cmdlet using the ClsController.psm1 module

  1. Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, em Todos os Programas, em Microsoft Lync Server 2013 e em Shell de Gerenciamento do 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.

    Importante

    O módulo ClsController.psm1 é fornecido como um download da Web separado.The ClsController.psm1 module is provided as a separate Web download. O módulo faz parte das ferramentas de depuração do Lync Server 2013.The module is part of the Lync Server 2013 Debugging tools. Por padrão, as ferramentas de depuração são instaladas no diretório C:\Program Files\Lync Server 2013\Debugging Tools.By default, the debugging tools are installed in the directory C:\Program Files\Lync Server 2013\Debugging Tools.

  2. No Windows PowerShell, digite:From the Windows PowerShell, type:

    Import-Module "C:\Program Files\Lync Server 2013\Debugging Tools\ClsController.psm1"
    

    Dica

    O carregamento bem-sucedido do módulo retorna ao prompt de comando do Windows PowerShell.Successful loading of the module returns you to the Windows PowerShell command prompt. Para confirmar que o módulo está carregado e que o Edit-CsClsScenario está disponível, digite Get-Help Edit-CsClsScenario .To confirm that the module is loaded and that Edit-CsClsScenario is available, type Get-Help Edit-CsClsScenario. Você deverá ver a sinopse básica da sintaxe de EditCsClsScenario.You should see the basic synopsis of the syntax for EditCsClsScenario.

  3. Para descarregar os módulos, digite:To unload the modules, type:

    Remove-Module ClsController
    

    Dica

    O descarregamento bem-sucedido do módulo retorna ao prompt de comando do Windows PowerShell.Successful unloading of the module returns you to the Windows PowerShell command prompt. Para confirmar que o módulo é descarregado, digite Get-Help Edit-CsClsScenario .To confirm that the module is unloaded, type Get-Help Edit-CsClsScenario. O Windows PowerShell tentará localizar a ajuda para o cmdlet e falhará.Windows PowerShell will attempt to locate the help for the cmdlet and fail.

Para remover um provedor existente de um cenário com o módulo Edit-ClsControllerTo remove an existing provider from a scenario with the Edit-ClsController module

  1. Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, em Todos os Programas, em Microsoft Lync Server 2013 e em Shell de Gerenciamento do 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. Para remover um provedor do cenário AlwaysOn, digite:To remove a provider from the AlwaysOn scenario, type:

    Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to remove> -Remove
    

    Por exemplo:For Example:

    Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Remove
    

    Os parâmetros ScenarioName e ProviderName são posicionais (ou seja, devem ser definidos na posição esperada na linha de comando). O nome do parâmetro não precisa ser explicitamente definido se o nome do cenário estiver na segunda ou na terceira posição em relação ao nome do cmdlet na primeira posição. Usando essas informações, o comando anterior seria digitado como:The parameters ScenarioName and ProviderName are positional (that is, they must be defined in the expected position in the command line) parameters. The parameter name does not have to be explicitly defined if the scenario name is in position two and the provider is in position three, relative to the name of the cmdlet as position one. Using this information, the previous command would be typed as:

    Edit-CsClsScenario AlwaysOn ChatServer -Remove
    

    A colocação posicional dos valores de parâmetro aplica-se somente a –Scenario e –Provider. Todos os outros parâmetros devem ser definidos explicitamente.The positional placing of the parameter values applies only to –Scenario and –Provider. All other parameters must be explicitly defined.

Para adicionar um provedor a um cenário com o cmdlet Edit-ClsControllerTo add a provider to a scenario with the Edit-ClsController module

  1. Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, em Todos os Programas, em Microsoft Lync Server 2013 e em Shell de Gerenciamento do 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. Para adicionar um provedor ao cenário AlwaysOn, digite:To add a provider to the AlwaysOn scenario, type:

    Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to add> -Level <string of type level> -Flags <string of type flags>
    

    Por exemplo:For Example:

    Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Level Info -Flags TF_COMPONENT
    

    -LogLevel pode ser do tipo fatal, erro, aviso, info, Verbose, debug ou ALL.-Loglevel can be of the type Fatal, Error, Warning, Info, Verbose, Debug, or All. – Os sinalizadores podem ser qualquer um dos sinalizadores aos quais o provedor oferece suporte, como o _ componente TF, TF _ diag.–Flags can be any of the flags that the provider supports, such as TF_COMPONENT, TF_DIAG. –Flags também pode ter o valor ALL.–Flags can also be of value ALL

    O exemplo anterior também pode ser digitado com o uso do recurso posicional do cmdlet. Por exemplo, para adicionar o provedor ChatServer ao cenário AlwaysOn, digite:The previous example can also be typed using the positional feature of the cmdlet. For example, to add the provider ChatServer to the AlwaysOn scenario, type:

    Edit-CsClsScenario AlwaysOn ChatServer -Level Info -Flags ALL