Log de diagnóstico na visão geral dos Serviços Corporativos de Conectividade (SharePoint Server 2010)

Artigo
03/07/2017

Aplica-se a: SharePoint Server 2010

Tópico modificado em: 2016-11-30

Você pode resolver problemas relacionados aos Microsoft Serviços Corporativos de Conectividade nos servidores que estão executando o Microsoft SharePoint Server 2010 e nos aplicativos clientes do O Microsoft Office 2010 usando os logs de eventos e de rastreamento no cliente ou servidor. Além disso, cada entrada em tais logs tem uma ID de Atividade associada que pode ser usada para acompanhar um problema do cliente ou servidor para a fonte de dados externa.

Observação

Além dos métodos de log abordados neste tópico, você pode usar o Pacote de Gerenciamento do Microsoft System Center Operations Manager para monitorar uma solução com base nos Microsoft Serviços Corporativos de Conectividade. Para obter mais informações sobre como configurar o Pacote de Gerenciamento do System Center Operations Manager, consulte o guia incluído no download do pacote de gerenciamento no artigo sobre pacote de gerenciamento dos Produtos do Microsoft SharePoint 2010 (https://go.microsoft.com/fwlink/?linkid=184971&clcid=0x416).

Neste artigo:

Logs de diagnóstico nos Serviços Corporativos de Conectividade
Sobre IDs de Atividade
Logs de diagnóstico em servidores
Log de diagnóstico nos clientes do Office 2010
Exemplo: usando logs de diagnóstico

Logs de diagnóstico nos Serviços Corporativos de Conectividade

Para soluções que se baseiem nos Microsoft Serviços Corporativos de Conectividade, o log de diagnóstico ocorre em ambos o servidores que estão executando o SharePoint Server 2010 e nos clientes do Office 2010. São dois os logs: de eventos e de rastreamento. Eles registram as informações de diagnóstico geradas pelos Microsoft Serviços Corporativos de Conectividade. Os logs de eventos registram as mensagens de erro. Os logs de rastreamento contêm informações mais detalhadas, como rastreamentos de pilha e mensagens informativas. No geral, os logs de rastreamento apresentam mais detalhes do que os de evento.

Cada item de informação registrado inclui uma ID de Atividade, um valor GUID exclusivo. Os valores da ID de atividade também podem ser enviados para sistemas externos quando uma operação Criar, Atualizar ou Excluir ocorre em um item. Com as IDs de Atividade, uma ação pode ser rastreada do servidor ou cliente à fonte de dados externa. Para obter mais informações sobre IDs da Atividade, consulte Sobre IDs de Atividade.

Você pode definir o nível de log de diagnóstico para os logs de eventos e de rastreamento. Isso limitará os tipos e a quantidade de informações gravadas em cada log. As tabelas a seguir definem os níveis de log disponíveis para os log de eventos e de rastreamento:

Níveis do log de eventos

Nível	Definição
Nenhuma	Não ocorrem logs.
Crítico	Esse tipo de mensagem indica um erro sério que causou falha grave na solução.
Erro	Esse tipo de mensagem indica uma condição urgente. Todos os eventos de erro devem ser investigados.
Aviso	Esse tipo de mensagem indica um problema em potencial ou que pode exigir atenção. As mensagens de aviso devem ser examinadas e acompanhadas para a detecção de padrões ao longo do tempo.
Informações	As mensagens de informações não exigem ação alguma, mas podem fornecer dados valiosos para o monitoramento do estado de sua solução.
Detalhado	Esse nível de log de eventos corresponde a mensagens ou eventos longos.

Níveis de log de rastreamento

Nível	Definição
Nenhuma	Nenhum log de rastreamento é gravado.
Inesperado	Esse nível é usado para registrar mensagens sobre eventos que interrompem o processamento de soluções. Quando é definido com esse nível, o log inclui apenas os eventos desse nível.
Monitorável	Esse nível é usado para registrar mensagens sobre eventos irrecuperáveis que limitam a funcionalidade da solução, mas não interrompem o aplicativo. Quando é definido com esse nível, o log também inclui erros críticos (nível Inesperado).
Alta	Esse nível é usado para registrar eventos que são inesperados, mas que não paralisam o processamento de uma solução. Quando é definido com esse nível, o log inclui avisos, erros (nível Monitorável) e erros críticos (nível Inesperado).
Média	Quando é definido com esse nível, o log de rastreamento inclui tudo, exceto mensagens Detalhadas. Esse nível é usado para registrar todas as informações de alto nível sobre operações que foram executadas. Nesse nível, são registrados detalhes suficientes para construir o fluxo de dados e a sequência de operações. Esse nível de log pode ser usado por administradores ou analistas de suporte para solução de problemas.
Detalhado	Quando é definido com esse nível, o log inclui mensagens de todos os outros níveis. Quase todas as ações executadas são registradas quando você usa esse nível. O rastreamento detalhado produz muitas mensagens de log. Esse nível geralmente é usado apenas para depuração em um ambiente de desenvolvimento.

Os logs de diagnóstico são úteis em ambientes de desenvolvimento e de produção, mas os requisitos para o nível de log provavelmente são diferentes, dependendo do tipo de ambiente. Ao planejar logs de diagnóstico nos Microsoft Serviços Corporativos de Conectividade, considere as necessidades comerciais e o estágio do ciclo de vida do ambiente antes de definir o nível de log.

Por exemplo, durante o design de soluções, para fins de depuração, é possível definir ambos os níveis de log como Detalhado para capturar todas as mensagens geradas sobre o estado do sistema. Por outro lado, em um ambiente de produção, convém capturar apenas mensagens das categorias Alto, Monitorável e Inesperado para logs de rastreamento e das categorias Crítico e Erro para logs de eventos. Isso poupa espaço em disco para logs e limita os efeitos negativos sobre o desempenho causados pelos logs.

Sobre IDs de Atividade

Um valor GUID exclusivo, denominado ID da Atividade, é gerado no servidor e cliente do Office para cada opção Criar, Atualizar ou Excluir nos dados externos em uma solução com base nos Microsoft Serviços Corporativos de Conectividade. Qualquer coisa relacionada à operação que esteja registrada no log de rastreamento ou no log de eventos incluirá seu respectivo valor de ID de Atividade.

Importante

Nos arquivos de logs de eventos e de rastreamento no servidor, valores de ID de Atividade são rotulados como “CorrelationId”.

O valor de ID de Atividade gerado para uma operação Criar, Atualizar ou Excluir é enviado ao sistema externo junto com outras informações relacionadas à operação. Se o sistema externo tiver um mecanismo de log, esse valor poderá ser capturado e registrado nesse sistema. Assim, se uma operação gerar entradas nos logs do servidor do SharePoint ou do cliente do Office, a mesma operação poderá ser rastreada para o sistema externo usando seu respectivo valor de ID de Atividade. Isso facilitará a resolução de problemas de ponta a ponta.

Frequentemente, uma operação como Criar faz com que vários eventos sejam gravados nos logs. Quando isso ocorre, o mesmo valor de ID de Atividade é usado para todos os eventos registrados para a operação. Isso é útil para solução de problemas, porque com o valor recorrente de ID de Atividade é possível localizar todos os eventos de uma operação específica. Por outro lado, quando o mesmo tipo de operação ocorre repetidamente, um valor exclusivo de ID de Atividade é gerado para cada instância da operação. Por exemplo, se um item de um tipo de conteúdo externo for atualizado duas vezes, cada operação de atualização será associada a um valor exclusivo de ID de Atividade.

Dica

Em certas circunstâncias, o Serviço de Conectividade de Dados Corporativos tentará executar uma operação novamente se ela não tiver passado para o sistema externo. Nesse caso, a mesma ID de Atividade será usada para a operação tentada novamente.

Logs de diagnóstico em servidores

Por padrão, os logs dos Microsoft Serviços Corporativos de Conectividade são habilitados nos servidores do SharePoint Server. Os níveis de log padrão são:

Para o log de eventos: Crítico e Erro
Para o log de rastreamento: Médio

Se os logs de diagnóstico dos Microsoft Serviços Corporativos de Conectividade forem desabilitados, habilite-os selecionando Serviços Corporativos de Conectividade na página Log de Diagnóstico na Administração Central do SharePoint Server. Você também pode usar o Windows PowerShell para configurar logs de eventos e de rastreamento no servidor. Por exemplo, é possível alterar a unidade na qual os logs são gravados e definir o nível de detalhamento dos logs.

Para obter mais informações sobre logs no SharePoint Server, como, por exemplo, a maneira de definir a localização dos arquivos de log, consulte Configure diagnostic logging (SharePoint Server 2010).

Você pode usar o Windows PowerShell para exibir os logs de eventos no servidor e exportar os logs, por exemplo, para um programa de planilha eletrônica. Para obter mais informações, consulte Exibir logs de diagnóstico (SharePoint Server 2010).

Os Microsoft Serviços Corporativos de Conectividade geram duas categorias para o log de rastreamento nos servidores Web front-end do SharePoint Server: BDC_Shared_Services e SS_Shared_Service. Você pode usar o Visualizador de Eventos para abrir o log de rastreamento e pode filtrar as entradas de log relevantes pesquisando “SPS_BusinessData” (para a saída dos Microsoft Serviços Corporativos de Conectividade) e “SPS_SecureStoreService”.

Log de diagnóstico nos clientes do Office 2010

Os logs de eventos e de rastreamento das soluções dos Microsoft Serviços Corporativos de Conectividade estão disponíveis nos clientes do Conjunto do Microsoft Office 2010 que usam a infraestrutura dos Microsoft Serviços Corporativos de Conectividade. Por padrão, o log de eventos dos Microsoft Serviços Corporativos de Conectividade está habilitado nos clientes. No entanto, para proteger o desempenho, apenas erros (críticos e em geral) são registrados e essa configuração não pode ser alterada. Os computadores clientes com Windows incluem um Visualizador de Eventos que pode ser usado para exibir os logs de eventos. Para obter informações sobre como exibir os logs de eventos para uma versão específica do Windows, consulte a documentação do produto.

O log de rastreamento está desabilitado por padrão nos computadores clientes para ajudar a melhorar o desempenho. Habilite esse log nos computadores clientes se estiver encontrando problemas que deseje diagnosticar. Por exemplo, se uma entrada de log de eventos indicar um erro que pode ter sido provocado por uma atividade que esteja relacionada aos Microsoft Serviços Corporativos de Conectividade, habilite o log de rastreamento para coletar dados adicionais na próxima vez que o evento ocorrer.

O método para habilitar o log de rastreamento e ler logs varia dependendo da versão do Windows no computador. Por exemplo, nos computadores que executam o Windows XP, você habilita o rastreamento executando um script que usa o comando logman. No Windows Vista e posterior, as ferramentas do sistema (como o Monitor de Desempenho e de Confiabilidade) estão disponíveis em adição ao comando logman. Entre em contato com a documentação do produto do Windows para obter detalhes sobre como habilitar o rastreamento e capturar os resultados.

O script de amostra a seguir usa o comando logman para habilitar o log de rastreamento:

rem This script will enable logging, directing log messages to a file specified by the "%FILE_NAME%" given by the user.

@setlocal
@echo off
pushd %~dp0
set PATH_NAME=%TEMP%\BCS
set FILE_NAME=%PATH_NAME%\ETWTraceLog
set TRACE_COLLECTION=BCS
::tracelog -start BCS -guid #b8622a02-c377-46b1-b861-38a787a8e44a -b 128 -flags 0xFFFF -level 5 -f "%FILE_NAME%.etl"
md "%PATH_NAME%" 1>nul 2>nul
logman create trace %TRACE_COLLECTION% -p "{b8622a02-c377-46b1-b861-38a787a8e44a}" 0xFFFF 5 -o "%FILE_NAME%.etl" -ets
echo.
echo Business Connectivity Services tracing has been started. To end press any key.
echo.
pause

Como no servidor, um valor de ID de Atividade exclusivo é gerado para cada operação Criar, Atualizar ou Excluir executada em um item no cliente. Esses valores são registrados nos logs e enviados para sistemas externos junto com outras informações sobre operações. Além disso, uma solução pode ser configurada de modo que os valores de ID de Atividade sejam exibidos nas mensagens de erro. Isso facilita a resolução dos problemas encontrados pelos usuários da solução.

Importante

Como a versão necessária da interface de programação do Rastreamento de Eventos para Windows, de cuja geração de ID de Atividade dependente, não está disponível no sistema operacional Windows XP, clientes executando o Windows XP não tem suporte para a geração de ID de Atividade.

Exemplo: usando logs de diagnóstico

Esse cenário curto e simplificado ilustra o uso de logs de diagnóstico em um ambiente de produção. Uma empresa implantou uma nova solução de envio de cartão de ponto com base nos Microsoft Serviços Corporativos de Conectividade. A solução usa um sistema externo para armazenar informações de cartão de ponto para os funcionários, como férias e licença médica, e para interagir com os funcionários e o sistema de folha de pagamento quando os funcionários relatam sua licença do trabalho. Os funcionários usam uma Web Part para interagir com o sistema.

No farm de servidores, os níveis de log são definidos com os valores padrão para os Microsoft Serviços Corporativos de Conectividade:

Para o log de eventos: Crítico e Erro
Para o log de rastreamento: Médio

Nesse cenário, um funcionário envia um valor correspondente ao número de horas de licença médica, mas o funcionário e seu gerente não recebem uma mensagem de email de confirmação relatando que o período de licença médica foi enviado com êxito. O funcionário liga para o serviço de suporte técnico interno e relata o problema.

A técnica de suporte reconhece que o aplicativo de cartão de ponto se baseia nos Microsoft Serviços Corporativos de Conectividade. Ela verifica o log de eventos, mas não encontra erros associados à identidade do usuário no momento em que ele enviou a solicitação de cartão de ponto. Ela verifica então o log de rastreamento, no qual encontra a prova da atividade: uma operação Atualizar associada ao usuário no horário adequado. A operação Atualizar no log de rastreamento inclui um valor de ID de Atividade que a técnica de suporte anota.

A técnica de suporte sabe que também há suporte para logs no sistema externo. Usando a ID de Atividade, ela localiza o item registrado no sistema externo e encontra prova de um erro gravado no log ao final da operação Atualizar: a atualização falhou porque o funcionário tinha usado todo o seu tempo de licença médica alocado. Ela também observa que não há uma entrada de log confirmando que uma mensagem de email foi gerada no sistema externo imediatamente ao final da operação Atualizar. A técnica de suporte conclui que há um erro na lógica do aplicativo de cartão de ponto. Embora o aplicativo tenha funcionado corretamente ao deixar de alocar pagamento para o período de licença médica quando o funcionário excedeu sua quantidade de horas alocada, ele não gerou uma mensagem de email informando o funcionário a respeito do problema. Ela relata o problema à equipe de desenvolvimento que criou o aplicativo, e a equipe de desenvolvimento o atualiza.