Usar a ferramenta Diagnóstico de Página para SharePoint

Artigo
01/08/2024

Este artigo descreve como usar a ferramenta Diagnóstico de Página para SharePoint para analisar páginas de sites modernas e clássicas do SharePoint Online em relação a um conjunto predefinido de critérios de desempenho.

A ferramenta Diagnóstico de Página para SharePoint pode ser instalada para:

Dica

A versão 2.0.0 e posterior inclui suporte para páginas modernas, além de páginas de sites clássicas. Se você não tiver certeza de qual versão da ferramenta está usando, poderá selecionar o link Sobre ou as reticências (...) para verificar sua versão. Atualize sempre para a versão mais recente ao usar a ferramenta.

A ferramenta Diagnóstico de Página para SharePoint é uma extensão de navegador para os novos navegadores Microsoft Edge (https://www.microsoft.com/edge) e Chrome que analisa tanto o portal moderno do SharePoint Online quanto as páginas clássicas do site de publicação.

Importante

Essa ferramenta funciona apenas para o SharePoint Online e não pode ser usada em uma página do sistema do SharePoint ou em uma página do Aplicativo do SharePoint. O tipo de página de aplicativo foi projetado para ser usado para aplicativos comerciais específicos no SharePoint Online e não para portais. A ferramenta foi projetada para otimizar páginas do portal e páginas do site do Teams.

A ferramenta gera um relatório para cada página analisada mostrando como a página é executada em relação a um conjunto predefinido de regras e exibe informações detalhadas quando os resultados de um teste estão fora do valor da linha de base. Administradores e designers do SharePoint Online podem usar a ferramenta para solucionar problemas de desempenho e garantir que novas páginas sejam otimizadas antes da publicação.

A ferramenta Diagnóstico de Página foi projetada para analisar somente páginas do site do SharePoint, não páginas do sistema, como allitems.aspx ou sharepoint.aspx. Se você tentar executar a ferramenta em uma página do sistema ou em qualquer outra página fora do local, receberá uma mensagem de erro informando que a ferramenta não pode ser executada para esse tipo de página.

Deve ser executado em uma página do SharePoint.

Isso não é um erro na ferramenta, pois não há valor na avaliação de bibliotecas ou páginas do sistema. Navegue até uma página do site do SharePoint para usar a ferramenta. Se esse erro ocorrer em uma página do SharePoint, marcar página master para garantir que os metatags do SharePoint não tenham sido removidos.

Para fornecer comentários sobre a ferramenta, selecione as reticências no canto superior direito da ferramenta e selecione Dar comentários.

Dê comentários.

Instalar a ferramenta Diagnóstico de Página para SharePoint

O procedimento de instalação nesta seção funciona para os navegadores Chrome e Microsoft Edge.

Importante

A Microsoft não lê dados ou conteúdo de página que é analisado pela ferramenta Diagnóstico de Página para SharePoint e não capturamos nenhuma informação pessoal, site ou informações de download. As únicas informações identificáveis registradas na Microsoft pela ferramenta são o nome do locatário, as contagens de regras que falharam e a data e hora em que a ferramenta foi executada. Essas informações são usadas pela Microsoft para entender melhor o portal moderno e publicar tendências de uso do site e problemas comuns de desempenho.

Instale a ferramenta Diagnóstico de Página para SharePoint para a extensão do Microsoft Edge(Edge) ou Chrome(extensão do Chrome). Examine a Política de Privacidade do Usuário fornecida na página de descrição no repositório. Ao adicionar a ferramenta ao navegador, você verá o aviso de permissões a seguir.

Este aviso está em vigor porque uma página pode conter conteúdo de locais fora do SharePoint, dependendo das web parts e personalizações na página. Isso significa que a ferramenta lerá as solicitações e respostas quando o botão iniciar for clicado e somente para a guia ativa do SharePoint em que a ferramenta está em execução. Essas informações são capturadas localmente pelo navegador da Web e estão disponíveis para você por meio do botão Exportar para JSON ou Exportar para HAR na guia rastreamento de rede da ferramenta. As informações não são enviadas ou capturadas pela Microsoft. (A ferramenta respeita a política de privacidade da Microsoft acessível aqui.)

A permissão Gerenciar seus downloads aborda o uso da funcionalidade Exportar para JSON da ferramenta. Siga as diretrizes de privacidade da própria empresa antes de compartilhar o arquivo JSON fora de sua organização, pois os resultados contêm URLs e que podem ser classificadas como PII (Informações Pessoalmente Identificáveis).
Se você quiser usar a ferramenta no modo Incognito ou InPrivate, siga o procedimento para seu navegador:
1. No Microsoft Edge, navegue até Extensões ou digite edge://extensions na barra de URL e selecione Detalhes para a extensão. Nas configurações de extensão, selecione a caixa de seleção para permitir no InPrivate.
2. No Chrome, navegue até Extensões ou digite chrome://extensions na barra de URL e selecione Detalhes para a extensão. Nas configurações de extensão, selecione o controle deslizante para permitir no Incognito.
Navegue até a página do site do SharePoint no SharePoint Online que você gostaria de examinar. Permitimos o "carregamento de atraso" de itens em páginas; Portanto, a ferramenta não será interrompida automaticamente (isso é por design para acomodar todos os cenários de carga de página). Para interromper a coleção, selecione Parar. Verifique se a carga da página foi concluída antes de interromper a coleta de dados ou você só capturará um rastreamento parcial.
Clique no botão da barra de Para carregar a ferramenta, você será apresentado com a seguinte janela pop-up de extensão:

Selecione Iniciar para começar a coletar dados para análise.

O que você verá na ferramenta Diagnóstico de Página para SharePoint

Clique nas reticências (...) no canto superior direito da ferramenta para encontrar os seguintes links:
1. O link Recursos adicionais fornece diretrizes gerais e detalhes sobre a ferramenta, incluindo um link de volta para este artigo.
2. O link Fornecer comentários fornece um link para o site de Voz do Usuário do SharePoint Sites e Colaboração .
3. O link Sobre inclui a versão atualmente instalada da ferramenta e um link direto para o aviso de terceiros da ferramenta.
Os detalhes ID, SPRequestDuration, SPIISLatency, Tempo de carga de página e URL são informativos e podem ser usados para algumas finalidades.
- CorrelationID é um elemento importante ao trabalhar com Suporte da Microsoft, pois permite que eles coletem mais dados de diagnóstico para a página específica.
- SPRequestDuration é o tempo necessário para o SharePoint processar a página. Navegação estrutural, imagens grandes, muitas chamadas de API podem contribuir para durações mais longas.
- SPIISLatency é a hora em milissegundos necessários para o SharePoint Online começar a carregar a página. Esse valor não inclui o tempo necessário para que o aplicativo Web responda.
- O tempo de carga da página é o tempo total registrado pela página desde o momento da solicitação até o momento em que a resposta foi recebida e renderizada no navegador. Esse valor é afetado por vários fatores, incluindo latência de rede, desempenho do computador e o tempo necessário para o navegador carregar a página.
- A URL da página (Uniform Resource Locator) é o endereço Web da página atual.

A guia Testes de Diagnóstico exibe os resultados da análise em três categorias; Nenhuma ação necessária, oportunidades de melhoria e atenção necessárias. Cada resultado do teste é representado por um item em uma dessas categorias, conforme descrito na tabela a seguir:

Categoria	Cor	Descrição
Atenção necessária	Vermelho	O resultado do teste está fora do valor da linha de base e está afetando o desempenho da página. Siga as diretrizes de correção.
Oportunidades de aprimoramento	Amarelo	O resultado do teste está fora do valor da linha de base e pode estar contribuindo para problemas de desempenho. Critérios específicos de teste podem ser aplicados.
Nenhuma ação é necessária	Verde	O resultado do teste está dentro do valor da linha de base do teste.

Página diagnóstico.

Uma guia Rastreamento de rede fornece detalhes sobre solicitações e respostas de build de página.

Como usar a guia Testes de Diagnóstico

Quando você analisa uma página do portal moderno do SharePoint ou uma página de site de publicação clássica com a ferramenta Diagnóstico de Página para SharePoint, os resultados são analisados usando regras predefinidas que comparam resultados com valores de linha de base e são exibidos na guia Testes de diagnóstico . As regras para determinados testes podem usar valores de linha de base diferentes para sites de publicação modernos e clássicos, dependendo de como as características de desempenho específicas diferem entre os dois.

Os resultados do teste que aparecem nas categorias Oportunidades de melhoria ou Atenção necessária indicam áreas que devem ser revisadas em relação às práticas recomendadas e podem ser selecionadas para exibir informações adicionais sobre o resultado. Os detalhes de cada item incluem um link Saiba mais , que o levará diretamente às diretrizes apropriadas relacionadas ao teste. Os resultados do teste que aparecem na categoria Nenhuma ação necessária indicam a conformidade com a regra relevante e não exibem detalhes adicionais quando selecionados.

As informações na guia Testes de diagnóstico não informarão como projetar páginas, mas destacarão fatores que podem afetar o desempenho da página. Algumas funcionalidades e personalizações de página têm um impacto inevitável no desempenho da página e devem ser revisadas para uma possível correção ou omissão da página se o impacto for substancial.

Resultados vermelhos ou amarelos também podem indicar web parts que atualizam dados com muita frequência. Por exemplo, as notícias corporativas não são atualizadas a cada segundo, mas as web parts personalizadas geralmente são criadas para buscar as últimas notícias a cada segundo, em vez de implementar elementos de cache que poderiam melhorar a experiência geral do usuário. Tenha em mente ao incluir web parts em uma página que muitas vezes há maneiras simples de reduzir seu impacto de desempenho avaliando o valor de cada parâmetro disponível para garantir que ele seja definido adequadamente para sua finalidade pretendida.

Observação

Sites de equipe clássicos que não têm o recurso de publicação habilitado não podem fazer uso de CDNs. Quando você executa a ferramenta nesses sites, espera-se que o teste cdn falhe e possa ser ignorado, mas todos os testes restantes são aplicáveis. A funcionalidade adicional do recurso de publicação do SharePoint pode aumentar o tempo de carga da página, portanto, ela não deve ser habilitada apenas para permitir a funcionalidade da CDN.

Importante

As regras de teste são adicionadas e atualizadas regularmente, portanto, consulte a versão mais recente da ferramenta para obter detalhes sobre regras atuais e informações específicas incluídas nos resultados do teste. Você pode verificar a versão gerenciando suas extensões e a extensão aconselhará se uma atualização está disponível.

Como usar a guia Rastreamento de Rede e como exportar um arquivo HAR

A guia Rastreamento de Rede fornece informações detalhadas sobre as duas solicitações para criar a página e as respostas recebidas do SharePoint.

Procure por tempos de carga de item sinalizados como vermelhos. Cada solicitação e resposta é codificada por cor para indicar seu impacto no desempenho geral da página usando as seguintes métricas de latência:
- Verde: < 500 ms
- Amarelo: 500-1000 ms
- Vermelho: > 1000 ms
Na imagem mostrada acima, o item vermelho pertence à página padrão. Ele sempre mostrará vermelho, a menos que a página seja carregada em < 1000 ms (menos de 1 segundo).
Testar os tempos de carga do item. Em alguns casos, não haverá nenhum indicador de hora ou cor porque os itens já foram armazenados em cache pelo navegador. Para testar isso corretamente, abra a página, desmarque o cache do navegador e clique em Iniciar , pois isso forçará uma carga de página "fria" e será um verdadeiro reflexo da carga inicial da página. Em seguida, isso deve ser comparado à carga de página "quente", pois isso também ajudará a determinar quais itens estão sendo armazenados em cache na página.
Compartilhe detalhes relevantes com outras pessoas que podem ajudar a investigar problemas. Para compartilhar os detalhes ou informações fornecidos na ferramenta com seus desenvolvedores ou uma pessoa de suporte técnico, usar o Habilitar exportar para o Arquivo HTTP (HAR) é a abordagem recomendada.

A exportação deve ser habilitada antes de clicar em Iniciar, que habilitará o modo de depuração no navegador. Isso gera um HAR (arquivo HTTP Archive) que pode ser acessado por meio da guia "Rastreamento de Rede". Clique no botão "Exportar para HAR" para baixar o arquivo no computador e, em seguida, você pode compartilhá-lo de acordo. O arquivo pode ser aberto em várias ferramentas de depuração, como F12 Developer Tools e Fiddler.

Rastreamento de rede.

Importante

Esses resultados contêm URLs e que podem ser classificadas como PII (Informações Pessoalmente Identificáveis). Certifique-se de seguir as diretrizes da sua organização antes de distribuir essas informações.

Envolvimento com Suporte da Microsoft

Incluímos um recurso de nível Suporte da Microsoft que só deve ser utilizado ao trabalhar diretamente em um caso de suporte. Utilizar esse recurso não fornecerá nenhum benefício a você quando usado sem o envolvimento da equipe de suporte e pode fazer com que a página tenha um desempenho significativamente mais lento. Não há informações adicionais ao usar esse recurso na ferramenta, pois as informações adicionais são adicionadas ao log no serviço.

Nenhuma alteração é visível, exceto que você será notificado de que o habilitou e o desempenho da página será degradado por um desempenho 2 a 3 vezes mais lento enquanto estiver habilitado. Ele só será relevante para a página específica e para essa sessão ativa. Por esse motivo, isso deve ser usado com moderação e somente quando ativamente envolvido com suporte.

Para habilitar o recurso de nível Suporte da Microsoft

Abra a ferramenta Diagnóstico de Página para SharePoint.
No teclado, pressione ALT-Shift-L. Isso exibirá a caixa Habilitar marcar de log de suporte.
Selecione a caixa marcar e clique em Iniciar para recarregar a página e gerar log verboso.

Você deve observar a CorrelaçãoID (exibida na parte superior da ferramenta) e fornecê-la ao representante de suporte para permitir que elas coletem informações adicionais sobre a sessão de diagnóstico.