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

Este artigo descreve como usar a ferramenta Diagnóstico de Página para SharePoint para analisar páginas de site 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 site 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. Sempre atualize para a versão mais recente ao usar a ferramenta.

A ferramenta Diagnóstico de Página para SharePoint é uma extensão do navegador para os novos navegadores Microsoft Edge (https://www.microsoft.com/edge) e Chrome que analisam o portal moderno do SharePoint Online e as páginas clássicas do site de publicação. Essa ferramenta só funciona para SharePoint Online e não pode ser usada em uma SharePoint do sistema.

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 ficam fora do valor de linha de base. SharePoint designers e administradores 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 SharePoint páginas do site, 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 não site, 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 SharePoint página.

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 SharePoint site para usar a ferramenta. Se esse erro ocorrer em uma SharePoint, verifique a página mestra para garantir que as SharePoint metatags não foram removidas.

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

Envie comentários.

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

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

Importante

A Microsoft não lê dados ou conteúdo de página 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 a 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.

  1. Instale a ferramenta Diagnóstico de Página para SharePoint para Microsoft Edge (extensão do 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.

    Permissões de extensão.

    Este aviso está em vigor porque uma página pode conter conteúdo de locais fora 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 SharePoint ativa 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 nem capturadas pela Microsoft. (A ferramenta respeita a política de privacidade da Microsoft acessível aqui.)

    A permissão Gerenciar seus downloads abrange o uso da funcionalidade Exportar para JSON da ferramenta. Siga as diretrizes de privacidade da sua empresa antes de compartilhar o arquivo JSON fora da sua organização, pois os resultados contêm URLs e podem ser classificados como PII (Informações de Identificação Pessoal).

  2. Se você quiser usar a ferramenta no modo Anônimo 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 da extensão. Nas configurações de extensão, marque a caixa de seleção para permitir em InPrivate.
    2. No Chrome, navegue até Extensões ou digite chrome://extensions na barra de URL e selecione Detalhes da extensão. Nas configurações de extensão, selecione o controle deslizante para permitir incógnito.
  3. Navegue até a SharePoint site 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 ocorre por design para acomodar todos os cenários de carregamento de página). Para interromper a coleta, selecione Parar. Verifique se o carregamento da página foi concluído antes de interromper a coleta de dados ou você só capturará um rastreamento parcial.

  4. Clique no botão da barra de ferramentas da extensão Diagnóstico de página para SharePoint logotipo. para carregar a ferramenta e você verá a seguinte janela pop-up de extensão:

    Pop-up da ferramenta Diagnóstico de Página.

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

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

  1. 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 SharePoint Sites e Voz do Usuário de Colaboração.
    3. O link Sobre inclui a versão instalada atualmente da ferramenta e um link direto para o aviso de terceiros da ferramenta.
  2. A ID de correlação, SPRequestDuration, SPIISLatency**, tempo** de carregamento de página e detalhes da URL são informativos e podem ser usados para algumas finalidades.

    Detalhes do diagnóstico de página.

    • CorrelationID é um elemento importante ao trabalhar com Suporte da Microsoft, pois permite coletar mais dados de diagnóstico para a página específica.
    • SPRequestDuration é o tempo necessário para SharePoint processar a página. Navegação estrutural, imagens grandes, muitas chamadas à API podem contribuir para durações mais longa.
    • SPIISLatency é o tempo em milissegundos necessários para SharePoint Online comece a carregar a página. Esse valor não inclui o tempo necessário para que o aplicativo Web responda.
    • O tempo de carregamento 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 a latência de rede, o 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.
  3. 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ária. Cada resultado de teste é representado por um item em uma destas categorias, conforme descrito na tabela a seguir:

    Categoria Cor Descrição
    Atenção necessária Vermelho O resultado do teste fica fora do valor da linha de base e está afetando o desempenho da página. Siga as diretrizes de correção.
    Oportunidades de melhoria 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 do teste podem ser aplicados.
    Nenhuma ação é necessária Verde O resultado do teste está dentro do valor de linha de base do teste.

    Diagnóstico de página.

  4. 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 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 clássicos e portal moderno, dependendo do desempenho específico as características diferem entre as duas.

Os resultados de teste que aparecem nas oportunidades de melhoria ou categorias de atenção necessárias indicam áreas que devem ser revisadas em relação às práticas recomendadas e podem ser selecionados para exibir informações adicionais sobre o resultado. Os detalhes de cada item incluem um link do Learn more , que levará você diretamente para as 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 possíveis correções ou omissões da página se seu impacto for substancial.

Os 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 web parts personalizadas geralmente são criadas para buscar as notícias mais recentes 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 no 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 usar CDNs. Quando você executa a ferramenta nesses sites, o teste CDN deve falhar e pode ser ignorado, mas todos os testes restantes são aplicáveis. A funcionalidade adicional do recurso SharePoint publicação pode aumentar os tempos de carregamento da página, portanto, ele não deve ser habilitado apenas para permitir CDN funcionalidade.

Importante

As regras de teste são adicionadas e atualizadas regularmente, portanto, consulte a versão mais recente da ferramenta para obter detalhes sobre as 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 informará 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 solicitações para criar a página e as respostas recebidas de SharePoint.

  1. Procure os tempos de carregamento do item sinalizados como vermelho. Cada solicitação e resposta é codificada por cores 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

    Rastreamento de rede.

    Na imagem mostrada acima, o item vermelho pertence à página padrão. Ele sempre será exibido em vermelho, a menos que a página seja carregada em < 1000 ms (menos de 1 segundo).

  2. Tempos de carregamento do item de teste. Em alguns casos, não haverá nenhum indicador de tempo ou cor porque os itens já foram armazenados em cache pelo navegador. Para testar isso corretamente, abra a página, limpe o cache do navegador e clique em Iniciar, pois isso forçará um carregamento de página "frio" e será um reflexo real do carregamento inicial da página. Isso deve ser comparado com a carga de página "quente", pois isso também ajudará a determinar quais itens estão sendo armazenados em cache na página.

  3. Compartilhe detalhes relevantes com outras pessoas que podem ajudar a investigar problemas. Para compartilhar os detalhes ou as informações fornecidas na ferramenta com seus desenvolvedores ou com uma pessoa de suporte técnico, o uso de Habilitar a exportação para o arquivo HTTP (HAR) é a abordagem recomendada.

    Habilite a exportação para HAR.

Isso deve ser habilitado antes de clicar em Iniciar, que habilitará o modo de depuração no navegador. Ele gerará um ARQUIVO DE ARQUIVO HTTP (HAR) que pode ser acessado por meio da guia "Rastreamento de Rede". Clique em "Exportar para HAR" e ele baixará o arquivo no computador e você poderá compartilhá-lo adequadamente. 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 podem ser classificados como PII (Informações de Identificação Pessoal). Siga as diretrizes da sua organização antes de distribuir essas informações.

Envolvendo com Suporte da Microsoft

Incluímos um recurso de Suporte da Microsoft nível que só deve ser utilizado ao trabalhar diretamente em um caso de suporte. Utilizar esse recurso não fornecerá nenhum benefício quando usado sem o envolvimento da equipe de suporte e poderá tornar a página significativamente mais lenta. 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 a habilitou e o desempenho da página será significativamente degradado por 2 a 3 vezes o desempenho mais lento enquanto estiver habilitado. Ele só será relevante para a página específica e essa sessão ativa. Por esse motivo, isso deve ser usado com moderação e somente quando ativamente envolvido com o suporte.

Para habilitar o recurso Suporte da Microsoft nível de segurança

  1. Abra a ferramenta Diagnóstico de Página SharePoint aplicativo.

  2. No teclado, pressione ALT-Shift-L. Isso exibirá a caixa de seleção Habilitar registro em log de suporte.

  3. Marque a caixa de seleção e clique em Iniciar para recarregar a página e gerar o log detalhado.

    Opção de suporte Habilitada.

    Observe a CorrelationID (exibida na parte superior da ferramenta) e forneça-a ao representante de suporte para permitir que eles coletem informações adicionais sobre a sessão de diagnóstico.

Ajustar o desempenho do SharePoint Online

Ajustar o desempenho do Office 365

Desempenho na experiência moderna do SharePoint

Redes de distribuição de conteúdo

Usar a Rede de Distribuição de Conteúdo (CDN) do Office 365 com o SharePoint Online