Sobre os logs do sistema do GitHub Enterprise Server
Para rastrear, analisar e solucionar problemas de atividades e exceções em sua instância do GitHub Enterprise Server, você pode analisar os logs do sistema. Sua instância armazena os dois tipos de logs do sistema apresentados a seguir.
- Arquivos de log de texto sem formatação em disco, armazenados pelo syslog ou por serviços específicos
- Arquivos de log binários, armazenados pelo journald
Por padrão, o GitHub Enterprise Server renova os logs do sistema automaticamente a cada 24 horas e retém esses logs por sete dias. Os logs do sistema incluem eventos no nível do sistema, logs de aplicativos e dados sobre eventos do Git. Como os arquivos de log são gravados com frequência e podem ser grandes, convém extrair e analisar as entradas de log em um host separado da sua instância do GitHub Enterprise Server.
As pessoas que têm acesso administrativo por SSH a uma instância do GitHub Enterprise Server podem acessar e ler os logs do sistema. Para saber mais, confira Acesar o shell administrativo (SSH).
Você pode encaminhar logs do sistema e logs de auditoria para um sistema externo para análise ou retenção prolongada. Para saber mais, confira Encaminhamento de logs e Como transmitir o log de auditoria para sua empresa.
Além de analisar os logs do sistema, é possível monitorar a atividade na instância de outras maneiras. Por exemplo, você pode analisar logs de auditoria e logs de push ou configurar webhooks globais. Para saber mais, confira Monitorar atividades na sua empresa.
Note
As listas de logs a seguir não pretendem ser abrangentes.
Arquivos de log do sistema
O GitHub Enterprise Server grava várias categorias de logs do sistema no disco da instância em texto simples. As pessoas com acesso SSH administrativo à instância podem analisar esses arquivos usando ferramentas de linha de comando do Linux, como cat, tail, head, less e more.
- Arquivos de log para bancos de dados
- Arquivos de log para o aplicativo GitHub
- Arquivos de log para o servidor HTTP
- Arquivos de log para o Console de Gerenciamento
- Arquivos de log para configuração de instância
- Arquivos de log para pesquisa
- Arquivos de log para serviços do sistema
Arquivos de log para bancos de dados
Os arquivos de log a seguir registram eventos de serviços de banco de dados na instância.
| Caminho | Descrição |
|---|---|
/var/log/mysql/mysql.log | Registra eventos relacionados ao banco de dados MySQL da instância. |
/var/log/mysql/mysql.err | Registra erros relacionados ao banco de dados MySQL da instância. |
/data/user/mssql/log/errorlog | Registra erros relacionados ao banco de dados MSSQL da instância. Consulte Logs de diário para bancos de dados mais adiante neste artigo para outros eventos. |
Arquivos de log para o aplicativo GitHub
Os arquivos de log apresentados a seguir registram eventos do aplicativo GitHub na instância.
| Caminho | Descrição |
|---|---|
/var/log/github/audit.log | Registra eventos do sistema, dos usuários e do repositório para atividades no aplicativo GitHub na instância. Você pode filtrar entradas no log ao usar a palavra-chave github_audit. |
/var/log/github/exceptions.log | Registra exceções encontradas pelo aplicativo GitHub. |
/var/log/github/gitauth.log | Registra solicitações de autenticação do Git usando HTTPS ou SSH. O serviço babeld processa todas as solicitações de autenticação e atividades do Git. |
/var/log/github/production.log | Registra eventos internos para o aplicativo GitHub. Para solicitações ao site, inclui a ação do controlador que respondeu. Pode conter entradas com estruturas diferentes, dependendo da origem do trabalho ou da solicitação. |
Arquivos de log para o servidor HTTP
Os arquivos de log a seguir registram eventos do servidor HTTP da instância.
| Caminho | Descrição |
|---|---|
/var/log/nginx/error.log* | Registra erros para solicitações da Web. |
/var/log/nginx/gist.log | Registra solicitações HTTP relacionadas a gists. Para saber mais, confira Criar gists. |
/var/log/nginx/gist.error.log | Registra erros relacionados a solicitações HTTP para gists. |
/var/log/nginx/github.log | Registra solicitações HTTP para o aplicativo GitHub. |
/var/log/nginx/github.error.log | Registra erros associados a solicitações HTTP. |
/var/log/nginx/pages.log | Registra solicitações HTTP associadas ao GitHub Pages. Para saber mais, confira What is GitHub Pages?. |
/var/log/nginx/pages.error.log | Registra erros relacionados a solicitações HTTP para o GitHub Pages. |
Arquivos de log para o Console de Gerenciamento
Os arquivos de log apresentados a seguir contêm eventos do Console de Gerenciamento da instância. Para saber mais, confira Sobre o console de gerenciamento.
| Caminho | Descrição |
|---|---|
/var/log/enterprise-manage/audit.log | Registra atividades no Console de Gerenciamento da instância. |
/var/log/enterprise-manage/unicorn.log | Registra as operações HTTP e HTTPS que os administradores executam no Console de Gerenciamento ao usar a interface do usuário da Web ou a API REST. |
Arquivos de log para configuração de instância
Os arquivos de log a seguir contêm eventos relacionados à configuração da instância.
| Caminho | Descrição |
|---|---|
/data/user/common/ghe-config.log | Registra eventos associados à execução de configuração mais recente. Se uma execução de configuração falhar, a saída para o log será interrompida. O log também registra informações sobre migrações executadas durante o processo de atualização do software da instância. Para saber mais, confira Utilitários de linha de comando. |
/data/user/config-apply/logs/YYYYMMDD/* | Armazena arquivos de log para execuções de configuração anteriores. A instância armazena os arquivos em um diretório que reflete a data, e cada nome de arquivo reflete o nó e a ID da execução. |
Arquivos de log para pesquisa
Os arquivos de log apresentados a seguir contêm eventos de serviços que fornecem funcionalidade de pesquisa para a instância.
| Caminho | Descrição |
|---|---|
/var/log/elasticsearch/github-enterprise.log | Registra eventos associados ao serviço Elasticsearch, que a instância usa para fornecer serviços de pesquisa. |
Arquivos de log para serviços do sistema
Os logs a seguir contêm eventos de serviços do sistema na instância.
| Caminho | Descrição |
|---|---|
/var/log/coredumps.log | Registra informações sobre processos do sistema que são encerrados inesperadamente. |
/var/log/boot.log | Registra informações sobre o processo de inicialização da instância. |
/var/log/chrony/ | O diretório contém logs relacionados à sincronização do protocolo NTP (Network Time Protocol) e ao relógio do sistema da instância. Para saber mais, confira Configurar a sincronização de hora. |
/var/log/haproxy.log | Registra todas as solicitações da Web e de API para a instância. Para conexões HTTP, as entradas incluem a URL solicitada pelo cliente, bem como o método HTTP para a solicitação. |
/var/log/ssh-console-audit.log | Registra comandos que os administradores executam ao usar o shell administrativo (SSH). Para saber mais, confira Acesar o shell administrativo (SSH). |
/var/log/mail-replies/metroplex.log | Registra informações sobre emails que a instância recebe. Para saber mais, confira Configurar notificações de e-mail. |
Logs do sistema no diário do systemd
Vários serviços do GitHub Enterprise Server são conteinerizados, como o serviço babeld. O GitHub Enterprise Server grava logs do sistema para esses serviços no diário systemd em um formato binário.
As pessoas com acesso SSH administrativo à instância podem analisar esses logs usando o comando journalctl. Para obter mais informações, consulte journalctl(1) nas páginas de manual online do Linux.
Para visualizar os logs no diário do systemd, execute o comando a seguir, substituindo SERVICE-NAME por um nome de serviço da lista de logs a seguir. Para exibir logs de todos os outros serviços em contêineres, execute nomad job status e use o ID como SERVICE-NAME.
journalctl -t SERVICE-NAME
Logs de diário para o aplicativo GitHub
Os logs a seguir registram eventos do aplicativo GitHub na instância.
| Nome do serviço | Descrição |
|---|---|
github-resqued | Registra eventos relacionados a trabalhos em segundo plano. Se o trabalho envolver autenticação interna ou externa, esse log incluirá informações sobre a solicitação. Se a instância usar autenticação LDAP e a sincronização LDAP estiver habilitada, os eventos de sincronização LDAP aparecerão nesse log. Para saber mais, confira Usando o LDAP. |
github-unicorn | Registra as operações HTTP e HTTPS que os usuários realizam na interface do usuário da Web da instância ou ao usar APIs. Se a operação envolver autenticação interna ou externa, esse log incluirá informações sobre a solicitação. Se o log de depuração estiver habilitado para a autenticação LDAP ou SAML, as informações de nível de depuração para as solicitações autenticadas aparecerão nesse log. Para obter mais informações, confira Usando o LDAP ou Autenticação SAML. |
Logs de diário para Git
Os logs a seguir contêm eventos relacionados à atividade do Git na instância.
| Nome do serviço | Descrição |
|---|---|
babeld | Registra eventos para todas as atividades do Git na instância, incluindo a autenticação para acessar o repositório. |
codeload | Registra eventos de atividades relacionadas à geração ou à recuperação de arquivos de código para repositórios na instância. |
gpgverify | Registra eventos relacionados à verificação de assinatura de confirmação. Para saber mais, confira Sobre a verificação de assinatura de commit. |
Logs de diário para armazenamento
Os logs apresentados a seguir contêm eventos de serviços que armazenam ou recuperam dados na instância.
| Nome do serviço | Descrição |
|---|---|
alambic | Registra eventos relacionados ao armazenamento e à recuperação de arquivos, como objetos Git LFS, imagens de avatar, anexos de arquivos de comentários na interface do usuário da Web e arquivos de lançamento. |
Logs de diário para bancos de dados
Os logs a seguir contêm eventos relacionados a serviços de banco de dados na instância.
| Nome do serviço | Descrição |
|---|---|
mysql | Registra eventos relacionados ao banco de dados MySQL da instância. |
mssql | Registra eventos relacionados ao banco de dados MSSQL da instância. |
Logs de diário para webhooks
Os arquivos de log a seguir contêm eventos relacionados aos webhooks que sua instância envia.
| Nome do serviço | Descrição |
|---|---|
hookshot-go | Registro de eventos para todas as atividades de webhook na instância, incluindo webhooks acionados, entregas e falhas. |
Sobre logs do sistema em pacotes de suporte
Se você gerar um pacote de suporte, o arquivo incluirá logs do sistema. Para saber mais, confira Fornecer dados para o GitHub Support.