Sobre os arquivos de diagnóstico e pacotes de suporte
Para ajudar você a solucionar problemas com uma instância do GitHub Enterprise Server em seu ambiente, o Suporte do GitHub pode solicitar um ou mais tipos de dados.
Dados | Formato de arquivo | Descrição |
---|---|---|
Arquivo de diagnóstico | Texto sem formatação | Contém informações sobre as configurações e o ambiente da instância. |
Pacote de suporte | Arquivos | Por padrão, contém um arquivo de diagnóstico e os arquivos de log corrigidos dos últimos dois dias. |
Pacote de suporte estendido | Arquivos | Contém um arquivo de diagnóstico e os arquivos de log corrigidos dos últimos oito dias. |
Sobre o arquivo de registro sanitização
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 instância de GitHub Enterprise Server 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;
- Listagens de carga e processo;
- Configurações de rede
- Método e detalhes de autenticação;
- Número de repositórios, usuários e outros dados de instalação.
Baixe o diagnóstico para sua instância do Console de Gerenciamento ou executando o utilitário de linha de comando ghe-diagnostics
.
Criar um arquivo de diagnóstico no Console de Gerenciamento
Você pode criar um arquivo de diagnóstico do Console de Gerenciamento se não tiver acesso SSH no momento.
-
Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .
-
Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.
-
Na barra lateral " Administrador do site", clique em Console de Gerenciamento .
-
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."
-
Digite suas credenciais do Console de Gerenciamento. Em seguida, clique em Continuar.
-
Na barra de navegação superior, clique em Suporte.
-
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;
- Log do Console de Gerenciamento;
github-logs/exceptions.log
: informações sobre os erros 500 encontrados no sitegithub-logs/audit.log
: logs de auditoria do GitHub Enterprise Serverbabeld-logs/babeld.log
: logs de proxy do Gitsystem-logs/haproxy.log
: logs do HAProxyelasticsearch-logs/github-enterprise.log
: logs do Elasticsearchconfiguration-logs/ghe-config.log
: logs de configuração GitHub Enterprise Servercollectd/logs/collectd.log
: logs do Collectdmail-logs/mail.log
: logs de entrega de email SMTP
Para obter mais informações, confira "Sobre o log de auditoria da sua 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 o Suporte do GitHub, você receberá um email de confirmação que conterá um link de referência do tíquete. Se o Suporte do GitHub solicitar o upload de um pacote de suporte, você pode usar o link de referência do tíquete para fazer o upload requisitado.
Criar um pacote de suporte no Console de Gerenciamento
Você pode usar essas etapas para criar e compartilhar um pacote de suporte se conseguir acessar o Console de Gerenciamento e se tiver acesso à internet.
-
Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .
-
Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.
-
Na barra lateral " Administrador do site", clique em Console de Gerenciamento .
-
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."
-
Digite suas credenciais do Console de Gerenciamento. Em seguida, clique em Continuar.
-
Na barra de navegação superior, clique em Suporte.
-
Clique em Baixar pacote de suporte.
-
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.
-
Acesse https://support.github.com/uploads e carregue seu pacote de suporte.
Criar um pacote de suporte usando SSH
Será possível seguir essas etapas para criar e compartilhar um pacote de suporte se você tiver acesso via SSH ao sua instância do GitHub Enterprise Server e acesso de saída à Internet.
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 obter mais informações, confira "Utilitários de linha de comando".
-
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". -
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.
-
Acesse https://support.github.com/uploads e carregue seu pacote de suporte.
Carregar um pacote de suporte usando sua conta corporativa
-
Navegue até GitHub Enterprise Cloud.
-
No canto superior direito do GitHub, clique na sua foto de perfil e em Suas empresas.
-
Na lista de empresas, clique na empresa que você deseja visualizar.
-
Do lado esquerdo da página, na barra lateral da conta empresarial, clique em Configurações.
-
Em Configurações, clique em Licença.
-
Em "Ajuda do GitHub Enterprise", clique em Carregar um pacote de suporte.
-
Em "Selecione uma conta corporativa", use o menu suspenso para selecionar a conta associada ao pacote de suporte.
-
Em "Carregar um pacote de suporte para o Suporte do GitHub Enterprise", para selecionar o pacote de suporte, clique em Escolher arquivo ou arraste o arquivo de pacote de suporte para Escolher arquivo.
-
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 via SSH ao sua instância do GitHub Enterprise Server.
- Conexões HTTPS de saída pela porta TCP 443 são permitidas do sua instância do GitHub Enterprise Server com enterprise-bundles.github.com e esbtoolsproduction.blob.core.windows.net.
-
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 o Suporte do GitHub está investigando tiverem ocorrido há mais de dois dias, poderemos solicitar que você compartilhe um pacote de suporte estendido. Você precisará do acesso SSH para baixar um pacote estendido, e não é possível fazer o download de um pacote estendido no 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. A rotação de arquivos de registro no GitHub Enterprise Server acontece em várias frequências (diária ou semanalmente) para diferentes arquivos, dependendo das expectativas de tamanho dos registros.
Criar um pacote de suporte estendido usando SSH
Será possível seguir essas etapas para criar e compartilhar um pacote de suporte estendido se você tiver acesso via SSH ao sua instância do GitHub Enterprise Server e acesso de saída à Internet.
-
Baixe o pacote de suporte estendido por meio do SSH adicionando o sinalizador
-x
ao comandoghe-support-bundle
:ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz
-
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.
-
Acesse https://support.github.com/uploads e carregue seu pacote de suporte.
Fazer upload de um pacote de suporte estendido usando SSH
Você pode fazer upload diretamente de um pacote de suporte para o nosso servidor nas seguintes situações:
- Você tem acesso via SSH ao sua instância do GitHub Enterprise Server.
- Conexões HTTPS de saída pela porta TCP 443 são permitidas do sua instância do GitHub Enterprise Server com enterprise-bundles.github.com e esbtoolsproduction.blob.core.windows.net.
-
Faça upload do pacote para o nosso servidor de pacotes de suporte:
ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x'