Sobre pacotes de suporte para o GitHub Enterprise Server

Sobre pacotes de suporte

Um pacote de suporte é um arquivo compactado contendo dados de diagnóstico da sua instância do GitHub Enterprise Server. Você pode usar pacotes de suporte para trabalhar com o Suporte do GitHub em problemas e para gerar relatórios de verificação de integridade, que resumem a configuração, a integridade e a atividade da sua instância.

Quando gerar um pacote de suporte

Gere um pacote de suporte em vários cenários:

Investigação de tíquete de suporte

Suporte do GitHub pode solicitar um pacote de suporte ao investigar problemas de desempenho, interrupções de serviço, problemas de autenticação ou outros problemas operacionais. Primeiro, abra um ticket de suporte, depois gere o pacote e inclua o número do ticket para associá-lo ao seu caso. Para obter detalhes, consulte Utilitários de linha de comando.

Análise de verificação de integridade

Você pode gerar um pacote de suporte para criar um relatório de Check-Up de Saúde. As Verificações de Integridade analisam os dados do pacote de suporte e relatam a integridade, a segurança, as operações do Git e o uso da API da sua instância. Para obter mais informações, consulte Gerar um diagnóstico de saúde para sua empresa.

Conteúdo de um pacote de suporte

Os pacotes de suporte contêm várias categorias de dados de sua instância. O conteúdo exato depende da sua versão e da configuração do GitHub Enterprise Server.

Informações do sistema e da instância

Os pacotes de suporte incluem dados de diagnóstico sobre as configurações e o ambiente da instância, como informações de versão, configuração do sistema, detalhes da licença e a saída do ghe-diagnostics comando. Para obter uma lista completa de informações de diagnóstico, consulte Fornecendo dados para GitHub suporte.

Arquivos de log

Os pacotes de suporte incluem arquivos de log dos serviços, aplicativos e bancos de dados do sistema da sua instância. A quantidade de dados de log coletados depende do tipo de pacote. Para saber mais sobre os arquivos de log disponíveis, consulte Sobre os logs do sistema.

Pacotes padrão e estendidos

Há dois tipos de pacotes de suporte. Um pacote padrão é menor e mais rápido de gerar, enquanto um pacote estendido fornece dados mais abrangentes para solução de problemas detalhada.

	Pacote padrão	Pacote estendido (sinalizador `-x`)

          **Duração do log** | 2 dias | 8 dias |

Suporte do GitHub informará qual tipo de bundle gerar. Em caso de dúvida, gere um pacote estendido para garantir que todos os dados de diagnóstico estão disponíveis. Você também pode especificar uma duração de log personalizada usando o --period sinalizador (por exemplo, --period '4 days').

Status e métricas do serviço

Os pacotes de suporte incluem status de integridade do serviço atual, informações de processo, métricas de desempenho e arquivos de configuração para serviços de chave em execução em sua instância.

Informações de alta disponibilidade

Se sua instância usa alta disponibilidade ou clustering, os pacotes de suporte incluem:

Informações de status e de retardo de replicação
Configuração do nó de cluster
Detalhes da réplica de cache

Privacidade de dados e segurança

Os pacotes de suporte são projetados para ajudar a diagnosticar problemas enquanto protegem informações confidenciais:

        **Limpeza**: dados confidenciais, como senhas, tokens e chaves privadas, são removidos ou ofuscados antes da coleta.

        **Nenhum conteúdo do repositório**: os pacotes de suporte não incluem o conteúdo de seus repositórios Git, como código-fonte, dados de confirmação ou conteúdo de arquivo.

        **Dados do usuário**: os pacotes de suporte não incluem informações de perfil do usuário além do que aparece nos logs do sistema.

        **Informações de licença**: o pacote inclui o nome da sua organização e a referência de licença para que Suporte do GitHub possam identificar sua instância.

Ao fornecer um pacote de suporte para Suporte do GitHub, GitHub usa os dados apenas para atender à sua solicitação de suporte. Para obter detalhes sobre como GitHub manipula seus dados, consulte a GitHub Política de Privacidade.

Tamanho do pacote de suporte e tempo de geração

O tamanho do pacote de suporte e o tempo de geração variam de acordo com:

Tamanho da instância e nível de atividade
Número e tamanho de repositórios
Tempo desde a última rotação de logs
Se a instância usa clustering ou alta disponibilidade

Os pacotes de suporte típicos variam de algumas centenas de MB a vários GB. A geração de um pacote pode levar de alguns minutos para instâncias menores a mais de uma hora para instâncias muito grandes ou muito carregadas.

Grandes pacotes de suporte podem afetar o desempenho da instância durante a geração. Considere o seguinte:

        **Carga do sistema**: a geração de um pacote de suporte usa recursos de E/S de CPU, memória e disco.

        **Tempo**: se possível, gere pacotes de suporte durante o horário de menor movimento.

        **Modo de manutenção**: se sua instância tiver graves problemas de desempenho, considere habilitar o modo de manutenção antes de gerar um pacote de suporte para garantir que ele seja concluído com êxito. Para obter mais informações, consulte [AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode).

Reduzindo o impacto no desempenho

O ghe-support-bundle comando é executado automaticamente na prioridade de E/S e CPU mais baixa, de modo que as cargas de trabalho de produção têm precedência. Para reduzir ainda mais o uso de recursos durante a geração, você pode usar estes sinalizadores:

        `--no-async` (`-n`): Executa coleções sequencialmente em vez de em paralelo, reduzindo a contenção de recursos.

        `--num-jobs 1` (`-l 1`): limita o paralelismo a um único thread de coleção. O padrão é um terço do número de CPUs disponíveis.

Por exemplo, para gerar e carregar um pacote estendido com impacto mínimo no desempenho:

ghe-support-bundle -x -u --no-async --num-jobs 1

Relação com outras ferramentas de diagnóstico

Os pacotes de suporte funcionam junto com outros recursos de monitoramento e diagnóstico:

Arquivos de diagnóstico

O ghe-diagnostics comando gera um arquivo de diagnóstico menor que contém um subconjunto de informações de um pacote de suporte completo. Os arquivos de diagnóstico são úteis para verificações rápidas de saúde ou quando você não pode gerar um pacote de suporte completo. A saída de diagnóstico também é incluída em todos os pacotes de suporte.

Monitorar painéis de controle

A página Monitor no Console de Gerenciamento fornece métricas em tempo real e históricas sobre sua instância. Para obter mais informações, consulte Sobre o painel do monitor.

Você pode gerar e compartilhar pacotes de suporte usando o Console de Gerenciamento ou a linha de comando. Para obter instruções detalhadas, confira Fornecendo dados para GitHub suporte.

Considerações para clustering

Se você usar o clustering GitHub Enterprise Server, poderá gerar:

        **Pacotes por nó**: pacotes de suporte para nós individuais do cluster.

        **Pacotes de cluster**: um único pacote combinado de todos os nós de cluster usando `ghe-cluster-support-bundle`.

Suporte do GitHub indicará qual tipo de pacote gerar com base no problema em investigação.

Falha na geração de pacote de suporte

A causa mais comum da geração de pacote com falha é o espaço livre em disco insuficiente em /data/user/tmp. Os pacotes de suporte são montados neste diretório antes da compactação, portanto, ele precisa de espaço suficiente para manter os dados descompactados. Verifique o espaço disponível antes de gerar um pacote:

df -h /data/user/tmp

Se a geração falhar ou demorar muito tempo, libere espaço /data/user/tmp e tente novamente. Se os problemas persistirem, entre em contato com Suporte do GitHub para obter assistência. Como alternativa, você pode gerar um arquivo de diagnóstico menor usando o ghe-diagnostics comando.

Leitura adicional

        [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs)

        [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-support-bundle)

        [AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support)

Sobre pacotes de suporte para o GitHub Enterprise Server

Neste artigo