Skip to main content
O GitLab unifica issues, code review, CI e CD em uma única interface. Conectar o AppSignal ao GitLab cobre o mesmo terreno que a integração com o GitHub: O GitLab é uma integração pessoal: cada usuário que quiser usá-la precisa concluir a configuração por conta própria em cada app do AppSignal.
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.
Site: https://gitlab.com

Vincular o AppSignal ao seu repositório no GitLab

Passo 1. Crie um personal access token do GitLab

  1. Faça login no GitLab e vá para suas Settings de usuário.
  2. Na barra lateral esquerda, selecione Access tokens e, em seguida, abra Personal access tokens (https://gitlab.com/-/user_settings/personal_access_tokens no GitLab.com).
  3. 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.
  4. 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_repository e api. O AppSignal precisa dos três.
  5. Selecione Create personal access token e copie o token imediatamente. O GitLab mostra apenas uma vez.
Criar uma issue é uma ação de escrita, então os escopos somente leitura não são suficientes por si só. Um token com apenas read_api e read_repository se conecta e vincula o código-fonte, mas o GitLab rejeita a requisição quando você envia um incidente. Adicione api para criar issues do GitLab a partir do AppSignal.O GitLab não permite alterar os escopos de um token depois que ele é criado. Para ajustá-los, crie um novo token e atualize a integração no AppSignal.
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

  1. No AppSignal, abra o app que você deseja conectar.
  2. Vá para App settings → Integrations → GitLab.
  3. 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 exemplo https://gitlab.example.com/your-group/your-project.
  4. Selecione create integration.
Você pode retornar a esta página a qualquer momento para update integration ou remove 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 a revision 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:
  1. Abra a tela de detalhes do incidente de erro.
  2. No painel Actions, selecione Send to GitLab.
O AppSignal cria a issue no projeto GitLab vinculado, e você pode abri-la a partir da página do incidente depois. Criar issues exige um token com o escopo 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ção revision, 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 tem api, 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.

Lista de integrações