Incidents - AppSignal Documentation

A CLI permite que você trabalhe com incidentes sem abrir a interface web. Você pode listar incidentes de todos os tipos ou por tipo, restringi-los por estado, namespace ou ação, abrir os detalhes de um único incidente, atualizar seu estado ou severidade e adicionar notas. Todo comando incidents tem como alvo uma aplicação, identificada por nome e ambiente (--app "MyApp" --environment production) ou por ID (--app-id <APP_ID>, o longo ID hexadecimal do app obtido em appsignal-cli apps list). A flag --environment só é necessária quando várias aplicações compartilham o mesmo nome. Adicione --org para sobrescrever sua organização padrão. Veja Aplicações e organizações para saber como as aplicações são identificadas.

Listar incidentes

Para listar incidentes recentes de todos os tipos de uma aplicação:

Shell

appsignal-cli incidents list --app "MyApp" --environment production --limit 5

Por padrão, os comandos de listagem retornam os 10 incidentes mais recentes, ordenados pela atividade mais recente.

Listar por tipo

Três comandos restringem os resultados a um único tipo de incidente:

Shell

# Exception incidents
appsignal-cli incidents list-exceptions --app "MyApp" --environment production

# Performance incidents
appsignal-cli incidents list-performance --app "MyApp" --environment production

# Anomaly detection incidents
appsignal-cli incidents list-anomalies --app "MyApp" --environment production

Filtrar e pesquisar

Os comandos de listagem compartilham um conjunto de filtros:

Flag	Descrição
`--state <STATE>`	Filtra por estado: `OPEN`, `CLOSED` ou `WIP`
`--order <ORDER>`	Ordena por `LAST` (atividade mais recente, o padrão) ou `ID` (ordem de criação)
`--limit <N>`	Número máximo de resultados (padrão: 10)
`--offset <N>`	Número de resultados a pular, para paginação

incidents list, list-exceptions e list-performance também aceitam:

Flag	Descrição
`--namespaces <list>`	Filtra por namespaces, separados por vírgula (ex.: `web,background`)
`--action <name>`	Filtra pelo nome da ação (ex.: `UsersController#show`)

Incidentes de exceção e desempenho suportam uma busca textual pelo nome ou mensagem do incidente com --query:

Shell

appsignal-cli incidents list-exceptions --app "MyApp" --environment production --query "TimeoutError"

Você pode passar vários filtros em um único comando, e todos serão aplicados em conjunto para restringir os resultados. Por exemplo, listar apenas as exceções abertas no namespace web:

Shell

appsignal-cli incidents list-exceptions --app "MyApp" --environment production \
  --state OPEN --namespaces web

Os comandos de listagem retornam incidentes recentes, então incidentes mais antigos podem não aparecer mesmo que ainda estejam abertos. Para abrir um incidente específico independentemente da idade, use incidents show com seu número.

Mostrar um incidente

Para ver os detalhes completos de um único incidente, passe seu número:

Shell

appsignal-cli incidents show --number 42 --app "MyApp" --environment production

Para incidentes de exception, show também lista as causas dos erros a partir dos dados de sample do incidente. Às vezes um erro envolve outro, como um timeout que aparece como um erro genérico de requisição. Quando isso acontece, as causas subjacentes aparecem ao lado da exception de nível superior, para que você possa encontrar a causa raiz sem abrir um sample na interface web.

Atualizar um incidente

Atualize o estado, a severidade, os responsáveis ou a descrição de um incidente pelo número:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production --state CLOSED

Flag	Descrição
`--state <STATE>`	Novo estado: `OPEN`, `CLOSED` ou `WIP`
`--severity <SEV>`	Nova severidade: `UNTRIAGED`, `CRITICAL`, `HIGH`, `LOW`, `NONE` ou `INFORMATIONAL`
`--assign <NAMES_OR_IDS>`	Nomes de usuários ou IDs a adicionar como responsáveis, separados por vírgula
`--assign-me`	Atribui o incidente ao seu usuário autenticado
`--unassign <NAMES_OR_IDS>`	Nomes de usuários ou IDs a remover dos responsáveis, separados por vírgula
`--description <text>`	Nova descrição

Para alterar vários incidentes de uma vez, passe uma lista de números separada por vírgulas. Atualizações em massa atualmente suportam apenas --state:

Shell

appsignal-cli incidents update --number 41,42,43 --app "MyApp" --environment production --state CLOSED

Atribuir um incidente

Para atribuir um incidente a você mesmo, use --assign-me. Não é necessário um ID de usuário:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production --assign-me

Para atribuir a outras pessoas, passe seus nomes ou IDs de usuário para --assign, separados por vírgula. Um ID de usuário é uma longa string hexadecimal. Encontre nomes e IDs com apps resources users, que lista o nome, ID e e-mail de cada usuário:

Shell

appsignal-cli apps resources users --app "MyApp" --environment production

Em seguida, passe um ou mais para --assign:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production \
  --assign <NAME_OR_ID>

Para remover responsáveis, passe seus nomes ou IDs para --unassign da mesma forma.

Adicionar uma nota

Para registrar o que você descobriu sobre um incidente:

Shell

appsignal-cli incidents add-note --number 42 --app "MyApp" --environment production \
  --content "Root cause identified."

Saída em JSON

Como todo comando, os comandos de incidentes aceitam a flag global --output json (ou --format json), que retorna uma saída legível por máquina para scripts e agentes de IA:

Shell

appsignal-cli --output json incidents list-exceptions --app "MyApp" --environment production --state OPEN

Para retornar um único incidente como JSON, restrinja pelo número com incidents show:

Shell

appsignal-cli --output json incidents show --number 42 --app "MyApp" --environment production

Próximos passos

Os incidentes mostram o que está falhando. Para ver as amostras individuais por trás de um deles, busque seus traces pelo número do incidente. Para ver as linhas de log ao redor, acompanhe ou pesquise seus logs a partir do terminal.

​Listar incidentes

​Listar por tipo

​Filtrar e pesquisar

​Mostrar um incidente

​Atualizar um incidente

​Atribuir um incidente

​Adicionar uma nota

​Saída em JSON

​Próximos passos

Listar incidentes

Listar por tipo

Filtrar e pesquisar

Mostrar um incidente

Atualizar um incidente

Atribuir um incidente

Adicionar uma nota

Saída em JSON

Próximos passos