Skip to main content

Fornecendo dados para GitHub suporte

Como Suporte do GitHub não tem acesso ao seu ambiente, às vezes exigimos algumas informações adicionais de você.

Quem pode usar esse recurso?

Site administrators and enterprise owners can provide data to Suporte do GitHub.

Sobre os arquivos de diagnóstico e pacotes de suporte

Para ajudá-lo a solucionar problemas com uma GitHub Enterprise Server instância em seu ambiente, Suporte do GitHub pode solicitar um ou mais tipos de dados.

DadosFormato de arquivoDescrição
Arquivo de diagnósticoTexto sem formataçãoContém informações sobre as configurações e o ambiente da instância.
Pacote de suporteArquivosPor padrão, contém um arquivo de diagnóstico e os arquivos de log corrigidos dos últimos dois dias.
Pacote de suporte estendidoArquivosContém um arquivo de diagnóstico e os arquivos de log corrigidos dos últimos oito dias.

Sobre a sanitização de arquivos de log

Os tokens de autenticação, chaves e segredos são removidos dos arquivos de registro nos seguintes diretórios de registro contidos em um pacote de suporte ou arquivo de diagnóstico:

  • alambic-logs
  • babeld-logs
  • codeload-logs
  • enterprise-manage-logs
  • github-logs
  • hookshot-logs
  • lfs-server-logs
  • semiotic-logs
  • task-dispatcher-logs
  • pages-logs
  • registry-logs
  • render-logs
  • svn-bridge-logs

Criar e compartilhar arquivos de diagnóstico

Os arquivos de diagnóstico são uma visão geral das configurações e do ambiente de uma GitHub Enterprise Server instância que contêm:

  • Informações da licença do cliente, incluindo o nome da empresa, data de validade e número de licenças de usuário
  • Números de versão e SHAs;
  • Arquitetura de VMs;
  • Nome de host, modo privado, configurações de SSL;
  • Carregar e processar listagens
  • Configurações de rede
  • Método e detalhes de autenticação;
  • Número de repositórios, usuários e outros dados de instalação.

Você pode baixar o diagnóstico para sua instância do Console de Gerenciamento ou executando o utilitário de linha de comando ghe-diagnostics.

Criando um arquivo de diagnóstico do Console de Gerenciamento

Você pode criar um arquivo de diagnóstico a partir do Console de Gerenciamento se não tiver acesso ao SSH no momento.

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

  2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

  3. Na barra lateral " Site admin", clique em Console de Gerenciamento.

  4. Se você tiver criado várias contas de usuário do Console de Gerenciamento, selecione Administrador do site raiz ou usuário do Console de Gerenciamento . Para obter mais informações sobre as contas de usuário do Console de Gerenciamento, confira Como gerenciar o acesso ao Console de Gerenciamento.

  5. Digite suas credenciais do Console de Gerenciamento. Em seguida, clique em Continuar.

  6. Na barra de navegação superior, clique em Suporte.

    Captura de tela do cabeçalho do Console de Gerenciamento. Uma guia, rotulada como "Suporte", é realçada com um contorno laranja.

  7. Clique em Baixar informações de diagnóstico.

Criar um arquivo de diagnóstico usando SSH

Você pode usar esse método sem entrar no Console de Gerenciamento.

Use o utilitário de linha de comando ghe-diagnostics para recuperar o diagnóstico para sua instância.

ssh -p122 admin@HOSTNAME -- 'ghe-diagnostics' > diagnostics.txt

Criar e compartilhar pacotes de suporte

Depois do envio da sua solicitação de suporte, podemos pedir que você compartilhe um pacote de suporte com a nossa equipe. O pacote de suporte é um arquivo tar compactado com gzip que inclui diagnósticos e logs importantes da sua instância, como:

  • Logs relacionados à autenticação que podem ser úteis na solução de problemas de erros de autenticação, ou na configuração de LDAP, CAS ou SAML;

  •         Console de Gerenciamento Registro
    
  •         `github-logs/exceptions.log`: Informações sobre 500 erros encontrados no site
    
  •         `github-logs/audit.log`: GitHub Enterprise Server logs de auditoria
    
  •         `babeld-logs/babeld.log`: Logs de proxy do Git
    
  •         `system-logs/haproxy.log`: logs do HAProxy
    
  •         `elasticsearch-logs/github-enterprise.log`: logs do Elasticsearch
    
  •         `configuration-logs/`: GitHub Enterprise Server logs de configuração
    
  •         `collectd/logs/collectd.log`: logs do Collectd
    
  •         `mail-logs/mail.log`: logs de entrega de email SMTP
    

Para saber mais, confira Log de auditoria para uma empresa.

Por padrão, os pacotes de suporte incluem os logs dos últimos dois dias. Você pode especificar uma duração exata em dias. Para fornecer os logs dos últimos oito dias, baixe um pacote de suporte estendido. Para obter mais informações, confira Como criar e compartilhar pacotes de suporte estendido.

Dica

Ao entrar em contato com Suporte do GitHub, você receberá um email de confirmação contendo um link de referência do ticket. Se Suporte do GitHub solicitar o carregamento de um pacote de suporte, você pode usar o link de referência do ticket para carregá-lo.

Criar um pacote de suporte a partir do Console de Gerenciamento

Você pode usar essas etapas para criar e compartilhar um pacote de suporte se puder acessar a Console de Gerenciamento baseada na web e tiver acesso de saída à Internet.

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

  2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

  3. Na barra lateral " Site admin", clique em Console de Gerenciamento.

  4. Se você tiver criado várias contas de usuário do Console de Gerenciamento, selecione Administrador do site raiz ou usuário do Console de Gerenciamento . Para obter mais informações sobre as contas de usuário do Console de Gerenciamento, confira Como gerenciar o acesso ao Console de Gerenciamento.

  5. Digite suas credenciais do Console de Gerenciamento. Em seguida, clique em Continuar.

  6. Na barra de navegação superior, clique em Suporte.

    Captura de tela do cabeçalho do Console de Gerenciamento. Uma guia, rotulada como "Suporte", é realçada com um contorno laranja.

  7. Clique em Baixar pacote de suporte.

  8. Se um engenheiro de suporte forneceu um link de carregamento para o pacote de suporte, use esse link. Caso contrário, acesse https://support.github.com/ e entre (se solicitado) em uma conta corporativa com direito a suporte.

  9. Acesse https://support.github.com/uploads e carregue seu pacote de suporte.

Criar um pacote de suporte usando SSH

Você pode usar estas etapas para criar e compartilhar um pacote de suporte se tiver acesso SSH a sua instância do GitHub Enterprise Server e acesso à Internet externa.

Observação

Se o sua instância do GitHub Enterprise Server estiver em uma configuração de replicação geográfica ou se a sua instância for um cluster, use o comando ghe-cluster-support-bundle para recuperar o pacote de suporte. Para saber mais, confira Utilitários de linha de comando.

  1. Baixe o pacote de suporte via SSH:

    ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz
    

    Para obter mais informações sobre o comando ghe-support-bundle, confira Utilitários de linha de comando.

  2. Se um engenheiro de suporte forneceu um link de carregamento para o pacote de suporte, use esse link. Caso contrário, acesse https://support.github.com/ e entre (se solicitado) em uma conta corporativa com direito a suporte.

  3. Acesse https://support.github.com/uploads e carregue seu pacote de suporte.

Carregar um pacote de suporte usando sua conta corporativa

  1. Navegue até GitHub Enterprise Cloud.

  2. No canto superior direito do GitHub, selecione sua foto de perfil.

  3. Dependendo do seu ambiente, clique em Enterprise ou clique em Empresas e, em seguida, clique na empresa que você deseja exibir.

  4. No lado esquerdo da página, na barra lateral da conta empresarial, clique em Settings.

  5. Em Configurações, clique em Licença.

  6. Em "GitHub Enterprise Ajuda", clique em Carregar um pacote de suporte.

    Captura de tela da seção "ajuda do GitHub Enterprise" da página de configurações da empresa. A opção "Carregar um link de pacote de suporte" está destacado em laranja.

  7. Em "Selecione uma conta corporativa", use o menu suspenso para selecionar a conta associada ao pacote de suporte.

  8. Em "Carregar um pacote de suporte para Suporte do GitHub Enterprise", para selecionar seu pacote de suporte, clique em Escolher arquivo ou arraste seu arquivo de pacote de suporte para Escolher arquivo.

  9. Clique em Carregar.

Fazer upload de um pacote de suporte usando SSH

Você pode fazer upload diretamente de um pacote de suporte para o nosso servidor nas seguintes situações:

  • Você tem acesso SSH a sua instância do GitHub Enterprise Server.
  • As conexões HTTPS de saída pela porta TCP 443 são permitidas de sua instância do GitHub Enterprise Server para enterprise-bundles.github.com e esbtoolsproduction.blob.core.windows.net.
  1. Faça upload do pacote para o nosso servidor de pacotes de suporte:

    ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u'
    

Criar e compartilhar pacotes de suporte estendidos

Por padrão, os pacotes de suporte incluem os logs dos últimos dois dias, enquanto os pacotes de suporte estendidos incluem os logs dos últimos oito dias. Se os eventos que Suporte do GitHub estão investigando ocorreram há mais de dois dias, podemos pedir que você compartilhe um pacote de suporte estendido. Você precisará de acesso SSH para baixar um pacote estendido– não é possível baixar um pacote estendido do Console de Gerenciamento.

Para evitar que fiquem grandes demais, os pacotes só têm logs que não passaram por rotação nem compactação. GitHub Enterprise Server A rotação de logs ocorre em várias frequências (diárias ou semanais) para diferentes arquivos de log, dependendo do tamanho esperado dos logs.

Criar um pacote de suporte estendido usando SSH

Você pode usar estas etapas para criar e compartilhar um pacote de suporte estendido se tiver acesso SSH a sua instância do GitHub Enterprise Server e acesso à Internet.

  1. Baixe o pacote de suporte estendido por meio do SSH adicionando o sinalizador -x ao comando ghe-support-bundle:

    ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz
    
  2. Se um engenheiro de suporte forneceu um link de carregamento para o pacote de suporte, use esse link. Caso contrário, acesse https://support.github.com/ e entre (se solicitado) em uma conta corporativa com direito a suporte.

  3. Acesse https://support.github.com/uploads e carregue seu pacote de suporte.

Fazer upload de um pacote de suporte estendido diretamente usando SSH

Você pode fazer upload diretamente de um pacote de suporte para o nosso servidor nas seguintes situações:

  • Você tem acesso SSH a sua instância do GitHub Enterprise Server.
  • As conexões HTTPS de saída pela porta TCP 443 são permitidas de sua instância do GitHub Enterprise Server para enterprise-bundles.github.com e esbtoolsproduction.blob.core.windows.net.
  1. Faça upload do pacote para o nosso servidor de pacotes de suporte:

    ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x'
    

Leitura adicional

  •         [AUTOTITLE](/support/learning-about-github-support/about-github-support)
    
  •         [AUTOTITLE](/enterprise-server@latest/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise)