Folha de consulta de comandos - AppSignal Documentation

Esta página lista todos os comandos da AppSignal CLI em um só lugar, para que você possa procurar rapidamente o que precisa em vez de seguir um tutorial guiado. Para uma explicação mais completa de qualquer área, siga o link no topo de cada seção.

Configuração e conta

Conecte a CLI à sua conta do AppSignal. Veja Autenticação e Configuração para detalhes.

Comando	O que faz
`appsignal-cli about`	Mostra uma visão geral da sua configuração: versão, endpoint, organização padrão e status de autenticação
`appsignal-cli --version`	Exibe a versão instalada da CLI
`appsignal-cli auth login`	Autenticar no AppSignal via OAuth
`appsignal-cli auth logout`	Remover credenciais armazenadas
`appsignal-cli auth status`	Mostrar o status de autenticação atual
`appsignal-cli project init`	Criar ou atualizar a configuração local do projeto `.appsignal.toml`

Apps

Liste e inspecione os apps da sua organização. Veja Apps.

Comando	O que faz
`appsignal-cli apps list`	Listar todas as aplicações da organização atual
`appsignal-cli apps info --app-id <APP_ID>`	Mostrar detalhes de uma aplicação pelo ID
`appsignal-cli apps find --name <NAME>`	Encontrar uma aplicação pelo nome e ambiente opcional
`appsignal-cli apps set-org --org <ORG>`	Definir o slug da organização padrão
`appsignal-cli apps show-org`	Mostrar a organização padrão atual
`appsignal-cli apps resources <RESOURCE> --app <APP>`	Mostrar recursos do app: `all`, `users`, `notifiers`, `namespaces`, `dashboards` ou `deploy-markers`

Incidents

Liste incidentes, abra seus detalhes e os atualize. Veja Incidents.

Comando	O que faz
`appsignal-cli incidents list --app <APP>`	Listar incidentes de todos os tipos de um app
`appsignal-cli incidents list-exceptions --app <APP>`	Listar incidentes de exceção, com suporte a busca textual
`appsignal-cli incidents list-performance --app <APP>`	Listar incidentes de performance, com suporte a busca textual
`appsignal-cli incidents list-anomalies --app <APP>`	Listar incidentes de Anomaly detection
`appsignal-cli incidents show --number <NUMBER> --app <APP>`	Mostrar detalhes de um incidente pelo número
`appsignal-cli incidents update --number <NUMBER> --app <APP>`	Atualizar o estado, severidade ou responsáveis de um incidente
`appsignal-cli incidents add-note --number <NUMBER> --content <CONTENT> --app <APP>`	Adicionar uma nota a um incidente

Logs

Transmita, pesquise e inspecione dados de log. Veja Logs e a referência de sintaxe de consulta.

Comando	O que faz
`appsignal-cli logs tail --app <APP>`	Acompanhar (transmitir) linhas de log em tempo real, com filtros opcionais
`appsignal-cli logs search --app <APP>`	Pesquisar linhas de log com uma consulta única
`appsignal-cli logs views --app <APP>`	Listar as log views salvas (predefinições de filtro) de um app
`appsignal-cli logs sources --app <APP>`	Listar as fontes de log de um app

Métricas derivadas de logs

Comando	O que faz
`appsignal-cli logs metrics list --app <APP>`	Listar métricas derivadas de log de um app
`appsignal-cli logs metrics create --name <NAME> --query <QUERY> --app <APP>`	Criar uma nova métrica derivada de log
`appsignal-cli logs metrics update --id <ID> --app <APP>`	Atualizar uma métrica derivada de log
`appsignal-cli logs metrics delete --id <ID> --app <APP>`	Excluir uma métrica derivada de log

Gatilhos baseados em logs

Comando	O que faz
`appsignal-cli logs triggers list --app <APP>`	Listar gatilhos baseados em log de um app
`appsignal-cli logs triggers create --name <NAME> --query <QUERY> --app <APP>`	Criar um novo gatilho baseado em log
`appsignal-cli logs triggers update --id <ID> --app <APP>`	Atualizar um gatilho baseado em log existente
`appsignal-cli logs triggers delete --id <ID> --app <APP>`	Excluir um gatilho baseado em log

Traces

Busque e inspecione performance samples e error traces. Veja Traces. samples e sample são aliases de traces.

Comando	O que faz
`appsignal-cli traces list --namespace <NAMESPACE> --action <ACTION_NAME> --app <APP>`	Listar performance samples de uma action
`appsignal-cli traces incident --number <NUMBER> --app <APP>`	Listar performance samples de um incident
`appsignal-cli traces errors --digest <DIGEST> --app <APP>`	Listar error traces de um exception digest
`appsignal-cli traces show --namespace <NAMESPACE> --action <ACTION_NAME> --trace-id <TRACE_ID> --app <APP>`	Mostrar a span tree de um performance sample
`appsignal-cli traces show-error --digest <DIGEST> --trace-id <TRACE_ID> --app <APP>`	Mostrar a span tree de um error trace
`appsignal-cli traces show-incident --number <NUMBER> --trace-id <TRACE_ID> --app <APP>`	Mostrar um trace a partir de um incident, sem informar namespace, action ou digest

Dashboards

Liste, crie e atualize dashboards. Veja Dashboards.

Comando	O que faz
`appsignal-cli dashboards list --app <APP>`	Listar dashboards de um app
`appsignal-cli dashboards create --title <TITLE> --app <APP>`	Criar um novo dashboard
`appsignal-cli dashboards update --id <ID> --title <TITLE> --app <APP>`	Atualizar um dashboard existente

Gatilhos de Anomaly detection

Gerencie gatilhos de Anomaly detection. Veja Triggers.

Comando	O que faz
`appsignal-cli triggers list --app <APP>`	Listar gatilhos de um app
`appsignal-cli triggers create --app <APP>`	Criar um novo gatilho. Requer `--metric-name`, `--kind`, `--field`, `--comparison-operator`, `--condition-value`, `--warmup-duration` e `--cooldown-duration`
`appsignal-cli triggers update --id <ID> --app <APP>`	Atualizar um gatilho criando uma nova versão vinculada ao existente
`appsignal-cli triggers archive --id <ID> --app <APP>`	Arquivar um gatilho e fechar seus alertas e incidentes associados

Habilidade do agente

Instale e gerencie a AppSignal skill incluída para agentes de IA. Veja Habilidade do agente.

Comando	O que faz
`appsignal-cli skill install`	Instalar a habilidade AppSignal incluída no diretório de habilidades de um agente
`appsignal-cli skill update`	Atualizar uma habilidade AppSignal instalada para a versão incluída
`appsignal-cli skill status`	Mostrar se as habilidades AppSignal instaladas estão atualizadas

Feedback

Comando	O que faz
`appsignal-cli feedback "<MESSAGE>"`	Enviar feedback sobre a CLI para o AppSignal. Adicione `--email <EMAIL>` para incluir um endereço de contato

Convenções gerais

Algumas coisas se aplicam a todos os comandos:

Obtenha ajuda para qualquer comando adicionando --help (-h), por exemplo appsignal-cli logs tail --help. Isso lista os subcomandos, argumentos e opções.
Escolha o formato de saída com --output json (-o json) para JSON legível por máquina, ou deixe de fora para saída legível por humanos. --format é um sinônimo.
Direcione um app em comandos que leem ou alteram dados do app, passando --app <APP> (opcionalmente com --environment <ENVIRONMENT>) ou --app-id <APP_ID>. Defina uma organização padrão uma vez com appsignal-cli apps set-org --org <ORG> para poder omitir --org.

Nas tabelas acima, apenas os argumentos obrigatórios são mostrados. Execute um comando com --help para ver o conjunto completo de opções.

​Configuração e conta

​Apps

​Incidents

​Logs

​Métricas derivadas de logs

​Gatilhos baseados em logs

​Traces

​Dashboards

​Gatilhos de Anomaly detection

​Habilidade do agente

​Feedback

​Convenções gerais