Configurando cenários para o Serviço de Log Centralizado no Lync Server 2013

Artigo
07/23/2014

Tópico Última Modificação: 05/02/2014

Os cenários definem o escopo (ou seja, global, site, pool ou computador) e quais provedores usar no Serviço de Log Centralizado. Ao utilizar cenários, você habilita ou desabilita o rastreamento em provedores (por exemplo, S4, SIPStack, mensagens instantâneas e Presença). Ao configurar um cenário, você pode agrupar todos os provedores de uma determinada coleção lógica que aborda uma condição de problema específica. Se você descobrir que um cenário precisa ser modificado para atender às suas necessidades de solução de problemas e registro em log, as Ferramentas de Depuração do Lync Server 2013 fornecerão um módulo de Windows PowerShell chamado ClsController.psm1 que contém uma função chamada Edit-CsClsScenario. O objetivo do módulo é editar as propriedades do cenário nomeado. Exemplos do funcionamento desse módulo são fornecidos neste tópico. As Ferramentas de Depuração do Lync Server 2013 são baixadas do seguinte link: https://go.microsoft.com/fwlink/?LinkId=285257

Importante

Seja qual for o escopo (global, site, pool ou computador), é possível executar no máximo dois cenários por vez. Para determinar quais cenários estão em execução no momento, use Windows PowerShell Get-CsClsScenario. Usando Windows PowerShell e Set-CsClsScenario, você pode alterar dinamicamente quais cenários estão em execução. 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.

Para executar as funções do Serviço de Log Centralizado usando o Shell de Gerenciamento do Lync Server, você deve ser membro dos grupos de segurança CsAdministrator ou CsServerAdministrator RBAC (controle de acesso baseado em função) ou uma função RBAC personalizada que contenha um desses dois grupos. Para retornar uma lista de todas as funções RBAC às qual este cmdlet foi atribuído, incluindo quaisquer funções RBAC personalizadas que você mesmo criou, execute o seguinte comando no Shell de Gerenciamento do Lync Server ou no prompt Windows PowerShell:

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

Por exemplo:

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

O restante deste tópico concentra-se em como definir um cenário, modificar um cenário, determinar quais cenários estão em execução e especificar o que está contido em um cenário para otimizar a solução de problemas. Há duas maneiras de emitir comandos do Serviço de Log Centralizado. Você pode usar o CLSController.exe que está localizado, por padrão, no diretório C:\Arquivos de Programas\Arquivos Comuns\Microsoft Lync Server 2013\CLSAgent. Ou você pode usar o Shell de Gerenciamento do Lync Server para emitir Windows PowerShell comandos. A distinção importante é que, quando você usa CLSController.exe na linha de comando, há uma seleção finita de cenários disponíveis. Ao usar Windows PowerShell, você pode definir novos cenários para uso em suas sessões de log.

Conforme introduzido na Visão Geral do Serviço de Log Centralizado no Lync Server 2013, os elementos de um cenário são:

Provedores Se você estiver familiarizado com o OCSLogger, os provedores são os componentes que você opta por informar ao OCSLogger do que o mecanismo de rastreamento deve coletar logs. Os provedores são os mesmos componentes e, em muitos casos, têm o mesmo nome que os componentes do OCSLogger. Se você não estiver familiarizado com o OCSLogger, os provedores serão componentes específicos da função de servidor dos qual o Serviço de Log Centralizado pode coletar logs. Para obter detalhes sobre a configuração de provedores, consulte Configurando provedores para o Serviço de Log Centralizado no Lync Server 2013.
Identidade O parâmetro –Identity define o escopo e o nome do cenário. Por exemplo, você pode definir um escopo "global" e identificar o cenário como “LyssServiceScenario”. Ao combinar os dois, você define a identidade (por exemplo, “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.

Importante

Se você usar os parâmetros Name e Parent, não poderá usar o parâmetro –Identity.

Para criar um novo cenário com o cmdlet New-CsClsScenario

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

Para este cenário de exemplo, usaremos LyssProvider como a variável de provedor de exemplo.

Para criar um cenário usando as opções definidas, digite:
```
New-CsClsScenario -Identity <scope>/<unique scenario name> -Provider <provider variable>
```
Por exemplo:
```
New-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider $LyssProvider
```
Formato alternativo usando –Name e –Parent:
```
New-CsClsScenario -Name "LyssServiceScenario" -Parent "site:Redmond" -Provider $LyssProvider
```

Para criar um novo cenário com vários provedores usando o cmdlet New-CsClsScenario

Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, clique em Todos os Programas, clique em Microsoft Lync Server 2013 e, em seguida, clique no Shell de Gerenciamento do Lync Server.
Há um limite de dois cenários por escopo. No entanto, não há um limite quanto ao número de provedores. Neste exemplo, vamos supor que criamos três provedores e você deseja atribuir todos eles ao cenário que está definindo. Os nomes das variáveis dos provedores são LyssProvider, ABServerProvider e SIPStackProvider. Para definir e atribuir vários provedores a um cenário, digite o seguinte em um Shell de Gerenciamento do Lync Server ou Windows PowerShell prompt de comando:
```
New-CsClsScenario -Identity "site:Redmond/CollectDataScenario" -Provider @{Add=$LyssProvider, $ABServerProvider,  $SIPStackProvider}
```
Nota

Como é conhecido no Windows PowerShell, a convenção para criar uma tabela de hash @{<variable>=<value1>, <value2>, <value>...} de valores usando é conhecida como nivelamento. Para obter detalhes sobre o nivelamento Windows PowerShell, consulte https://go.microsoft.com/fwlink/p/?LinkId=267760.

Para modificar um cenário existente com o cmdlet Set-CsClsScenario

Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, clique em Todos os Programas, clique em Microsoft Lync Server 2013 e, em seguida, clique no Shell de Gerenciamento do Lync Server.
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”):
```
Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Add=<new provider to add>}
```
Por exemplo:
```
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:
```
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:
```
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:
```
Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider, $ABServerProvider, $SIPStackProvider}
```

Para remover um cenário existente com o cmdlet Remove-CsClsScenario

Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, clique em Todos os Programas, clique em Microsoft Lync Server 2013 e, em seguida, clique no Shell de Gerenciamento do Lync Server.
Se você desejar remover um cenário que foi definido anteriormente, digite o seguinte:
```
Remove-CsClsScenario -Identity <name of scope and scenario>
```
Por exemplo, para remover o cenário definido 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.

Para carregar e descarregar o Edit-CsClsScenario cmdlet usando o módulo ClsController.psm1

Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, clique em Todos os Programas, clique em Microsoft Lync Server 2013 e, em seguida, clique no Shell de Gerenciamento do Lync Server.

Importante

O módulo ClsController.psm1 é fornecido como um download da Web separado. O módulo faz parte das ferramentas de depuração do Lync Server 2013. Por padrão, as ferramentas de depuração são instaladas no diretório C:\Arquivos de Programas\Lync Server 2013\Ferramentas de Depuração.
No Windows PowerShell, digite:
```
Import-Module "C:\Program Files\Lync Server 2013\Debugging Tools\ClsController.psm1"
```
Ponta

O carregamento bem-sucedido do módulo retorna você para o prompt Windows PowerShell comando. Para confirmar se o módulo foi carregado e se Edit-CsClsScenario está disponível, digite Get-Help Edit-CsClsScenario. Você deverá ver a sinopse básica da sintaxe de EditCsClsScenario.
Para descarregar os módulos, digite:
```
Remove-Module ClsController
```
Ponta

O descarregamento bem-sucedido do módulo retorna você para o prompt Windows PowerShell comando. Para confirmar se o módulo foi descarregado, digite Get-Help Edit-CsClsScenario. Windows PowerShell tentar localizar a ajuda para o cmdlet e falhar.

Para remover um provedor existente de um cenário com o módulo Edit-ClsController

Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, clique em Todos os Programas, clique em Microsoft Lync Server 2013 e, em seguida, clique no Shell de Gerenciamento do Lync Server.
Para remover um provedor do cenário AlwaysOn, digite:
```
Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to remove> -Remove
```
Por exemplo:
```
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:
```
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.

Para adicionar um provedor a um cenário com o cmdlet Edit-ClsController

Inicie o Shell de Gerenciamento do Lync Server: clique em Iniciar, clique em Todos os Programas, clique em Microsoft Lync Server 2013 e, em seguida, clique no Shell de Gerenciamento do Lync Server.
Para adicionar um provedor ao cenário AlwaysOn, digite:
```
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:
```
Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Level Info -Flags TF_COMPONENT
```
-Loglevel pode ser do tipo Fatal, Error, Warning, Info, Verbose, Debug ou All. –Flags pode ser qualquer um dos sinalizadores aos quais o provedor oferece suporte, como TF_COMPONENT, TF_DIAG. –Flags também pode ter o valor 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:
```
Edit-CsClsScenario AlwaysOn ChatServer -Level Info -Flags ALL
```