- Vincular o AppSignal ao seu repositório no GitLab, para que o AppSignal saiba onde seu código está.
- Vincular backtraces a revisões e linhas, para que cada linha de backtrace abra o código que foi implantado.
- Criar issues do GitLab para incidentes, direto da tela de detalhes de um incidente.
O GitLab oferece várias formas de se conectar a ferramentas de terceiros. O
AppSignal se conecta usando um personal access token do GitLab e a URL do
seu projeto, o que é suportado no GitLab.com, no GitLab Self-Managed e no
GitLab Dedicated. O GitLab também oferece aplicações OAuth, mas o AppSignal
ainda não suporta a conexão ao GitLab via OAuth.
Vincular o AppSignal ao seu repositório no GitLab
Passo 1. Crie um personal access token do GitLab
- Faça login no GitLab e vá para suas Settings de usuário.
- Na barra lateral esquerda, selecione Access tokens e, em seguida, abra Personal access tokens (
https://gitlab.com/-/user_settings/personal_access_tokensno GitLab.com). - Selecione Add new token. O GitLab permite criar um personal access token fine-grained ou legacy. Escolha legacy, porque seus escopos correspondem diretamente ao que o AppSignal precisa.
- Preencha:
- Token name:
AppSignal - Expiration date: escolha uma data que esteja de acordo com a política da sua organização.
- Scopes: selecione
read_api,read_repositoryeapi. O AppSignal precisa dos três.
- Token name:
- Selecione Create personal access token e copie o token imediatamente. O GitLab mostra apenas uma vez.
Tokens fine-grained também podem funcionar, mas suas permissões de recursos
são bem mais granulares, e não é óbvio qual combinação selecionar. Estamos
planejando migrar esta integração para as aplicações OAuth do GitLab, a forma
mais recente de conectar ferramentas de terceiros ao GitLab.
Passo 2. Adicione a integração no AppSignal
- No AppSignal, abra o app que você deseja conectar.
- Vá para App settings → Integrations → GitLab.
- Preencha o formulário:
- Token: cole o personal access token que você criou no Passo 1.
- GitLab URL: a URL completa do projeto GitLab, por exemplo
https://gitlab.com/your-namespace/your-project. Para GitLab Self-Managed, use o hostname da sua instância, por exemplohttps://gitlab.example.com/your-group/your-project.
- Selecione create integration.
Passo 3. Repita para cada usuário
Como esta é uma integração pessoal, cada colega de equipe que quiser que os links de fonte, os links de backtrace ou a criação de issues funcionem em sua própria conta AppSignal precisa repetir os Passos 1 e 2 com seu próprio token do GitLab.Vincular backtraces a revisões e linhas
O código muda o tempo todo, então um backtrace é mais útil quando aponta para a revisão que estava implantada no momento em que o erro aconteceu. Conectar o GitLab preenche a Repo URL do seu app, então você não precisa configurá-la manualmente. Você pode confirmar isso em App settings → General, onde o campo contém a URL do seu projeto GitLab. O AppSignal detecta o provedor a partir dessa URL e monta os links de backtrace e comparação correspondentes. Assim que os marcadores de deploy reportarem arevision implantada, o AppSignal vincula cada linha de backtrace à revisão, ao caminho e à linha correspondentes no seu repositório GitLab, para que você possa ir de um erro até o código que foi implantado. Para a configuração completa, veja a documentação de links de backtrace.
Criar issues do GitLab para incidentes
O AppSignal não cria issues do GitLab automaticamente, para evitar sobrecarga de stories. Para criar uma para um incidente de erro:- Abra a tela de detalhes do incidente de erro.
- No painel Actions, selecione Send to GitLab.
api além dos escopos de leitura, descritos no Passo 1.
Marcadores de deploy do GitLab CI/CD
Para reportar deploys ao AppSignal a partir de um pipeline do GitLab CI/CD, veja a documentação de marcadores de deploy para a abordagem recomendada da opção de configuraçãorevision, ou o exemplo da Markers API se sua stack não incluir uma integração do AppSignal.
Solução de problemas
O envio de um incidente para o GitLab falha. Um token com escopos somente leitura se conecta com sucesso, mas não consegue criar issues. Confirme que o token temapi, além de read_api e read_repository. Como os escopos não podem ser editados depois que um token é criado, crie um novo token legacy com os três e atualize a integração no AppSignal.
O AppSignal reporta a integração com o GitLab como inválida.
Verifique quais escopos o token realmente tem. read_registry e read_repository ficam lado a lado na lista de escopos do GitLab, e um token que concede read_registry em vez de read_api não consegue ler seu projeto.
Os links de fonte no AppSignal não abrem o arquivo correto.
Reabra App settings → Integrations → GitLab no AppSignal e confirme que a GitLab URL aponta para a raiz do projeto (ex. https://gitlab.com/namespace/project) e não para um subpath, branch ou URL .git.