dashboards listam, criam e atualizam os dashboards de uma aplicação, e mostram, adicionam e atualizam os gráficos neles.
Cada comando direciona uma aplicação, por nome e ambiente (--app "MyApp" --environment production) ou por ID (--app-id <APP_ID>, o ID hexadecimal longo da aplicação obtido em appsignal-cli apps list). A flag --environment só é necessária quando várias aplicações compartilham um nome. Cada comando usa sua organização padrão, a menos que você passe --org. Veja Aplicações e organizações para saber como as aplicações são identificadas.
Listar dashboards
Shell
Mostrar um dashboard
Para ver os detalhes de um dashboard e seus gráficos, passe o--id do dashboard:
Shell
--output json, os gráficos ficam em dashboard.visuals, cada um com seu id, seu tipo em __typename e suas configurações. add-visual e update-visual retornam a mesma estrutura.
Criar um dashboard
Um novo dashboard precisa de um título e de uma descrição:Shell
Atualizar um dashboard
Passe o--id do dashboard (de dashboards list) junto com o novo título:
Shell
--title é obrigatório mesmo quando você só altera a descrição.
Adicionar um gráfico
Você descreve um gráfico em um arquivo JSON e depois o adiciona comadd-visual. Digamos que você administre uma loja online. Seu dashboard Checkout health deve responder a duas perguntas: o checkout está lento, e ele está falhando?
Para ver o quão lento o checkout está para seus clientes mais lentos, plote seu tempo de resposta no percentil 95 ao longo do tempo. Esse é um gráfico timeseries. Salve-o como checkout-speed.json:
checkout-speed.json
Shell
number, que recebe uma única metric. O nome da métrica e as tags não podem conter um wildcard (*), porque o gráfico mostra uma única série. Salve-o como checkout-errors.json:
checkout-errors.json
Shell
CheckoutsController#create pela action que trata o checkout na sua aplicação. Todo novo gráfico precisa de um title e uma description não vazios. Para ler o JSON da entrada padrão em vez de um arquivo, passe --file -.
A CLI não tenta novamente a criação de um gráfico que falhou. Se
add-visual falhar com um erro de rede, verifique o dashboard com dashboards show antes de tentar novamente. Assim, você evita adicionar o gráfico duas vezes.Atualizar um gráfico
Para alterar um gráfico, passe apenas as configurações que deseja mudar. Tudo o mais permanece como está. Por exemplo, para exibir o tempo de resposta do checkout como um gráfico de área, obtenha o ID do gráfico emdashboards show e execute:
Shell
update-visual usa as mesmas flags de aplicação que add-visual, além de:
Algumas configurações exigem mais atenção:
- Listas e objetos são substituídos por inteiro. Para também plotar a etapa de pagamento, passe
metricscom a métrica do checkout e a nova juntas. Para mover um gráfico, passe os quatro valores delayout. - Para limpar uma configuração, defina-a como
null. Isso funciona paradescription,formatInput,layout,lineLabel,minYAxise ometricde um gráficonumber.formatnão pode ser limpo; defina-o para outro formato em vez disso. - Para remover todas as métricas de um gráfico
timeseries, passe"metrics": []. - Alterar
formatpara algo diferente desizetambém limpaformatInput.
timeseries em um gráfico number. Uma atualização sem configurações é rejeitada.
Configurações do gráfico
O JSON do gráfico usa chaves em camelCase e contém apenas configurações. O ID do dashboard, o ID do gráfico e o tipo de gráfico vão nas flags do comando. Chaves desconhecidas, valores inválidos e configurações do outro tipo de gráfico retornam um erro.
Essas configurações aceitam um conjunto fixo de valores: