Compartilhar via


Monitorar e solucionar problemas de execuções de plug-in do Dataverse (versão preliminar)

[Este tópico faz parte da documentação de pré-lançamento e está sujeito a alterações.]

Use o rastreamento para solucionar problemas de plug-ins de low-code e de código profissional. O rastreamento ajuda os criadores registrando informações de runtime como auxílio no diagnóstico da causa de falhas ou para validação geral de determinados estados durante o desenvolvimento.

Importante

  • Este é um recurso em versão preliminar.
  • Os recursos de versão preliminar não foram criados para uso em ambientes de produção e podem ter funcionalidade restrita. Esses recursos são disponibilizados antes de um lançamento oficial para que os clientes possam ter acesso antecipado e forneçam comentários.

O módulo de monitoramento de plug-ins do acelerador do Dataverse é uma exibição aprimorada dos recursos existentes de rastreamento e registro em log disponíveis Microsoft Dataverse para plug-ins. A interface ajuda a melhorar os processos de solução de problemas e depuração durante a fase de desenvolvimento, colocando detalhes relevantes em um tratamento moderno.

Todos os eventos surgidos no aplicativo são lidos na tabela Rastreamento por 24 horas pelos seguintes tipos de fluxo de trabalho:

  • Plug-ins
  • APIs Personalizadas
  • Plug-ins low-code instantâneos e automatizados

Interface de monitoramento de plug-ins

Pré-requisitos

Você deve ter a seguinte atribuição de direito de acesso e acesso ao aplicativo acelerador do Dataverse:

  • Direito de acesso: os direitos de acesso de personalizador e administrador do sistema têm os privilégios necessários para habilitar os logs e usar o aplicativo por padrão.

  • Como alternativa, você pode criar funções personalizadas com acesso específico para cada recurso configurando os seguintes privilégios:

    • Para ler logs, é necessário o privilégio de leitura em nível de organização para a tabela Rastreamento.
    • Para ativar o registro em log no ambiente, o privilégio de gravação em nível de organização na Tabela da organizaçãoPluginTraceLogSetting é obrigatório.

Recursos principais

  • Visualizador de log centralizado: acesse e visualize logs de rastreamento de APIs personalizadas do Dataverse, plug-ins low-code e execuções de plug-ins de código profissional em um ambiente a partir de um local central.
  • Recursos de filtragem: filtre convenientemente o histórico de logs para encontrar rapidamente logs relevantes para suas necessidades de depuração.

Instalação

Este recurso está disponível no aplicativo acelerador do Dataverse. Acesse o artigo do acelerador do Dataverse para obter instruções de instalação.

Experimente o recurso de monitoramento de plug-ins

  1. Execute o acelerador do Dataverse.

  2. Acesse o recurso Monitoramento de plug-ins (no painel de navegação esquerdo ou no cartão de recurso na tela inicial).

Navegue até a página de monitoramento de plug-ins

Habilitar a captura de logs

Se a captura de logs não estiver habilitada em seu ambiente, a página de aterrissagem exibirá um estado desativado com duas opções para habilitar o registro em log: Todos ou Exceções. Escolha a opção apropriada com base em suas necessidades, acesse o artigo Registro em log e rastreamento para obter mais informações.

Habilitar a tela de registro em log com botões para habilitar todos os logs ou habilitar somente exceções

Você pode alterar essas configurações posteriormente na tela Configurações, se necessário, que pode ser acessada na barra de comandos das telas principais.

A tela de configurações de log fornece controles para atualizar as configurações de log

Dica

O rastreamento e o registro em log são ideais para depuração durante o desenvolvimento do plug-in. Para fluxos de trabalho de plug-in em produção, use o Azure App Insights para o monitoramento.

Exibir logs

Quando os logs estão habilitados, os eventos do plug-in começam a ser exibidos na lista principal exibida na tela.

Dica

Se não houver logs sendo exibidos, você poderá criar e executar um novo plug-in low-code para começar a exibir logs.

Filtrar logs

Utilize os recursos de filtragem para encontrar rapidamente logs relevantes para os plug-ins nos quais você está trabalhando.

Selecione Filtrar no lado superior direito da barra de comandos para abrir o painel de filtragem. Você também pode filtrar rapidamente por palavras-chave usando a barra de pesquisa.

Filtrar logs

Filtro Description
Name Selecione o nome lógico do plug-in.
Iniciar depois/antes A data e hora de quando o plug-in foi invocado.
Habilitar somente exceção Mostra execuções com status de falha.
Duração mín./máx. Intervalo mínimo e máximo da duração do plug-in.
Type A classificação do fluxo de trabalho do plug-in. Os tipos disponíveis incluem:
  • Plug-ins low-code instantâneo
  • Plug-in low-code automatizado
  • Plug-ins
  • API Personalizada
Mode Se o plug-in é síncrono ou assíncrono.

Ler detalhes do log

Selecione uma entrada de log específica para exibir informações detalhadas sobre a execução do plug-in. Os detalhes do log incluem carimbo de data/hora, nome do plug-in, status de execução, parâmetros de saída, mensagens de erro e muito mais. Os campos bloco de mensagens e bloco de exceção são exibidos abaixo dos detalhes básicos no painel e serão expandidos se houver dados nas respectivas colunas.

Práticas recomendadas

Examinar detalhes do log

  • Selecione uma entrada de log específica para exibir informações detalhadas sobre a execução do plug-in.
  • Os detalhes do log podem incluir carimbo de data/hora, nome do plug-in, status de execução, parâmetros de entrada/saída, mensagens de erro e muito mais.

Solucionar problemas

  • Use as informações fornecidas nos logs de rastreamento para solucionar quaisquer problemas que surjam durante a execução do plug-in.
  • Analise mensagens de erro, parâmetros de entrada/saída e detalhes da execução para identificar a causa raiz do problema.
  • Use mensagens de rastreamento para fornecer dicas úteis. A gravação no serviço de rastreamento está disponível no SDK do Dataverse e em plug-ins low-code como a função Trace no Power Fx.

Execute ações

  • Com base nos insights coletados dos logs de rastreamento, tome as medidas apropriadas para resolver quaisquer problemas de desempenho ou bugs identificados.
  • Isso pode envolver o ajuste das configurações do plug-in, a atualização da lógica do código ou a busca de ajuda em recursos de suporte.

Planejar para testar

  • Crie o hábito de planejar casos de teste que você pode executar nos logs de rastreamento para validar o desempenho do plug-in durante o desenvolvimento.
  • Resolva quaisquer problemas ou anomalias prontamente para manter a estabilidade geral e a confiabilidade de seus plug-ins do Dataverse.

Monitorar o desempenho do plug-in

  • Monitore regularmente o desempenho do plug-in na produção, revisando os logs de rastreamento registrados com o Application Insights.
  • Fique atento ao status da execução, às mensagens de erro e a quaisquer anomalias que possam indicar problemas ou bugs de desempenho.

Perguntas frequentes sobre o

Quais privilégios são necessários para acessar o Visualizador de Log de Rastreamento?

Você deve ter pelo menos privilégios de leitura na tabela Rastreamento para exibir logs.

Quem pode habilitar a captura de logs no ambiente?

Os administradores de sistema com os direitos de acesso apropriados podem habilitar a captura de logs em seu ambiente. Especificamente, é necessário o acesso de gravação à tabela Organização para atualizar o valor da coluna PluginTraceLogSetting.

Posso filtrar o histórico de logs para encontrar logs específicos?

Sim, o visualizador de log de rastreamento fornece recursos de filtragem, permitindo que os usuários encontrem de maneira conveniente os logs relevantes para suas necessidades de depuração.

O recurso de monitoramento de plug-ins está disponível em todos os ambientes?

O recurso é fornecido pelo acelerador do Dataverse e está disponível em todos os ambientes que tenham o aplicativo instalado. O aplicativo é instalado automaticamente em todos os novos ambientes, mas também pode ser instalado em ambientes mais antigos, seguindo as instruções de instalação.

Depois que habilitei o registro em log, ele ainda exibe a tela "O registro em log está desativado"

Se você tiver os privilégios corretos e tiver certeza de que habilitou o registro em log, atualize a guia do navegador. Você pode validar se o registro em log está habilitado usando a experiência herdada.

Ver também

Obter recursos em versão preliminar antecipadamente com o acelerador do Dataverse (versão preliminar)