Pular para o conteúdo principal
Depois de instalar a integração do AppSignal com o GitHub, dar permissão ao AppSignal para ler e escrever issues em seus repositórios do GitHub e conectar seu app no AppSignal ao repo desejado, você pode converter incidentes do AppSignal em issues do GitHub. Você também pode vincular issues e pull requests que já existem e acompanhar o status deles a partir do incidente.

Criar uma issue no GitHub a partir de um incidente

Abra o namespace relevante da sua aplicação no AppSignal, selecione Errors na navegação lateral e depois Issue list. Abra o incidente de erro que você quer enviar para o GitHub. Na aba Summary do incidente, selecione Send to GitHub no painel Actions. Página de resumo de um incidente de erro com a ação Send to GitHub no painel Actions Isso abre uma tela que permite criar uma issue no GitHub. O AppSignal preenche o título e a descrição para você. A descrição inclui um link para o incidente do AppSignal, a mensagem de erro e, quando aplicável, até as últimas 10 linhas do backtrace. Você pode modificar o título e a descrição, mas recomendamos manter o link do incidente e o backtrace. Tela de criação de issue no GitHub com título e descrição pré-preenchidos Selecione Create GitHub issue para criar a issue no repo do GitHub ao qual o namespace da sua aplicação está conectado. A nova issue aparece no painel Actions, e o logbook do incidente registra Sent the issue to GitHub. Se o AppSignal não conseguir criar a issue, a tela de criação informa o motivo. Ou seu app ainda não está vinculado a um repositório do GitHub, ou o app do AppSignal no GitHub não tem a permissão Issues (escrita) ou não tem acesso ao repositório. Para corrigir qualquer um dos casos, veja Vincular o AppSignal ao repositório do seu app no GitHub. Você pode alterar o repo ao qual os namespaces da sua aplicação no AppSignal estão conectados na página de configurações da sua aplicação no AppSignal. Você também pode gerenciar os direitos de acesso do AppSignal nas configurações da sua integração com o GitHub. Muitas vezes a correção já está em andamento: alguém abriu um pull request, ou o bug tem uma issue no GitHub. Coloque o link dela em uma nota, e o AppSignal a acompanha para você. O incidente mostra em que pé está a correção, e ninguém precisa perguntar se ela já foi lançada. Abra a aba Summary do incidente, escreva uma nota na caixa Logbook com a URL da issue do GitHub e selecione Post note. O AppSignal reconhece duas formas de referência em qualquer lugar da nota:
  • Uma URL completa, como https://github.com/acme/shop/issues/123 ou https://github.com/acme/shop/pull/456.
  • A forma abreviada acme/shop#123.
O AppSignal só vincula referências a repositórios da organização do GitHub, ou da conta de usuário, dona do repositório vinculado. Um app vinculado a acme/shop também vincula referências a acme/shop-api, mas ignora referências a outras organizações. Uma issue que já está vinculada não é vinculada de novo, então editar a nota não cria duplicatas. O logbook registra Linked #123 on GitHub, com o número apontando para a issue. A issue também aparece no painel Actions com seu status. Resumo do incidente com uma nota contendo a URL de uma issue do GitHub, a entrada de logbook Linked #6 on GitHub e a ação View #6 in GitHub com um badge Open O servidor MCP do AppSignal vincula issues da mesma forma quando um agente de IA escreve uma nota em um incidente. Para vincular um incidente a partir do GitHub:
  1. Copie a URL do incidente no AppSignal.
  2. Cole-a na descrição de uma issue ou pull request do GitHub, com uma palavra antes dela. Por exemplo: Fixes <incident URL>.
  3. Crie a issue ou o pull request, ou salve sua edição.
A issue ou o pull request agora aparece no painel Actions e no logbook do incidente. Letras maiúsculas e dois-pontos após a palavra, como Fixes:, também funcionam.
O logbook de um incidente no AppSignal com duas entradas adicionadas a partir do GitHub: uma issue referenciada e uma issue vinculada, cada uma com um badge github, acima de um vínculo anterior adicionado a partir de uma nota

Issues vinculadas e referenciadas a partir do GitHub, no logbook do incidente.

Bom saber:
  • A issue ou o pull request deve estar em um repositório da mesma organização do GitHub, ou conta de usuário, que o repositório conectado ao seu app.
  • Remover a URL da descrição não remove o vínculo do incidente.
  • O logbook mostra quem adicionou o vínculo no GitHub.
  • As mesmas palavras funcionam em notas no incidente. Por exemplo, See acme/shop#123 referencia a issue.

Acompanhar issues vinculadas a partir do incidente

O painel Actions mostra um botão para cada issue e pull request vinculado, com o rótulo View #123 in GitHub. Os botões aparecem na ordem em que as issues foram vinculadas. Passe o mouse sobre um botão para ver quando a issue foi vinculada ou referenciada. Selecione-o para abrir a issue no GitHub, ou para recriar a issue. Recriar remove o vínculo e abre a tela de criação novamente. Cada botão mostra o status da issue como um badge: Open, Closed ou, para pull requests, Merged ou Live. O AppSignal lê o status quando você vincula uma issue. Ele atualiza o status quando a issue ou o pull request é fechado, reaberto ou mesclado no GitHub. Toda mudança de status também aparece no logbook do incidente, por exemplo Changed the status of #123 on GitHub from open → merged. A entrada mostra quem fez a mudança no GitHub. Se essa pessoa for membro do seu app no AppSignal e tiver vinculado sua conta do GitHub, a entrada mostra o nome dela no AppSignal. As atualizações de status precisam das permissões Issues e Pull requests do app do AppSignal no GitHub. Quando o AppSignal as solicitar, um proprietário da sua organização do GitHub precisa aprovar as novas permissões no GitHub. Sem elas, a vinculação continua funcionando, mas as issues vinculadas não mostram um badge de status.

Ver quando é feito o deploy de um pull request vinculado

Assim que um deploy entrega um pull request vinculado, seu badge muda de Merged para Live. Passe o mouse sobre o botão para ver a revisão do deploy e quando ele aconteceu, por exemplo Deployed in 9175503 2 minutes ago. O logbook registra a mudança como Changed the status of #20 on GitHub from merged → deployed, feita pelo AppSignal.
A aba Summary de um incidente no AppSignal. O logbook mostra que o AppSignal mudou o status de #20 no GitHub de merged para deployed. No painel Actions, View #20 in GitHub tem um badge Live, e uma dica de ferramenta diz Deployed in 9175503 2 minutes ago

Um pull request vinculado mostra Live assim que um deploy o entrega.

Quando o AppSignal cria um deploy marker para um novo deploy, ele pergunta ao GitHub quais commits foram adicionados desde o deploy anterior no mesmo namespace. Se um pull request vinculado foi mesclado em um desses commits, ele muda para Live. Para que um pull request mostre Live, você precisa de:
  1. Um vínculo, não uma referência. Coloque uma palavra de vínculo, como Fixes, ou nenhuma palavra antes do link, no GitHub ou em uma nota no incidente. Um pull request referenciado, como See acme/shop#123, continua Merged.
  2. Seu app vinculado ao repositório do pull request. Veja Vincular o AppSignal ao repositório do seu app no GitHub.
  3. Um deploy marker para cada deploy, com uma revisão que o GitHub conheça: um SHA de commit, uma tag ou um nome de branch. Veja Escolhendo um valor de revisão.
  4. As permissões Contents, Issues e Pull requests no app do AppSignal no GitHub. Quando o AppSignal solicitar novas permissões, um proprietário da sua organização do GitHub precisa aprová-las no GitHub.
O AppSignal não acompanha:
  • Um pull request que você vincula depois do deploy que o entregou.
  • Um deploy com mais de 1.000 commits.
  • Uma revisão que o GitHub não conhece, como um número de build, ou 1.2.3 quando a tag é v1.2.3.
  • Rollbacks. Um pull request continua Live depois que você faz rollback do deploy que o entregou.
  • O commit exato de um deploy de branch. Se a revisão for um nome de branch, o AppSignal usa o commit mais recente da branch no momento da verificação. Esse commit pode ser mais recente do que aquele que você implantou.
  • O mesmo deploy duas vezes. Se um deploy tiver um deploy marker em vários namespaces, o pull request muda para Live apenas uma vez.
  • Um deploy que o GitHub não consegue comparar. Se o GitHub retornar um erro, o pull request continua Merged, e o AppSignal não mostra o erro.
  • Uma entrada do logbook que falhou. Se salvá-la falhar depois que o pull request mudar para Live, o AppSignal não tenta novamente.

Fechar o incidente quando é feito o deploy da correção

Este recurso está em beta, como parte do AppSignal Labs. Peça ao suporte para ativá-lo na sua organização.
Para que o AppSignal feche um incidente quando a correção for lançada:
  1. Na descrição do pull request no GitHub, escreva Fixes <incident URL>. Você também pode publicar a URL do pull request em uma nota no incidente.
  2. Faça o merge do pull request.
  3. Faça o deploy dele. O AppSignal precisa ver o deploy, para que o pull request mude para Live.
O AppSignal então fecha o incidente. O logbook registra a mudança para Closed com um badge deploy e nomeia o pull request. Bom saber:
  • O incidente precisa estar aberto. Seu estado precisa ser Open ou Work in progress.
  • Vincule o pull request, não o referencie. Cole a URL do incidente na descrição do pull request, ou a URL do pull request em uma nota no incidente. Coloque Fixes, ou nenhuma palavra, antes da URL. Uma palavra como See antes da URL apenas a referencia, e uma referência nunca fecha o incidente.
  • O AppSignal espera por cada pull request mesclado. Se o incidente tiver mais de um, o AppSignal o fecha assim que o último estiver Live. Issues vinculadas e pull requests que ainda não foram mesclados não o mantêm aberto.
  • Erros do código antigo não o reabrem. Enquanto um deploy é distribuído, hosts que ainda executam um deploy mais antigo podem reportar o erro. Esses erros contam para o incidente, mas não o reabrem nem enviam notificações. Um erro do novo deploy, ou de um posterior, o reabre normalmente.
  • Suas mudanças vêm primeiro. Se você reabrir o incidente, fazer o deploy da mesma revisão novamente não o fecha. Assim que o estado do incidente mudar de novo, erros de deploys mais antigos podem reabri-lo, como qualquer outro erro.
O incidente passa a ser o único lugar para verificar uma correção: quais issues e pull requests pertencem a ele e se cada um está aberto, mesclado, fechado ou live. Para pular de uma linha do backtrace para o código que foi lançado, configure em seguida os links de backtrace.
🛟 Se você está tendo problemas para criar issues no GitHub para incidentes do AppSignal, por favor entre em contato, e te ajudaremos mais.