Referência de widgets

Sobre esta página

Esta página é para consulta: como cada tipo de widget do CloudWatch é desenhado, em cada tamanho, e exatamente quais partes do JSON de um painel o CloudPeek usa. As predefinições e os widgets de IA são escritos no mesmo JSON, então ela também vale para eles. Para criar widgets, consulte Criar um widget.

A criação de widgets agora tem uma página própria: Criar um widget.

As predefinições agora têm uma página própria: Predefinições.

Os widgets de IA agora têm uma página própria: Widgets de IA.

A aba Widgets agora faz parte de Tela de Início e Tela Bloqueada.

A atualização dos widgets e a idade dos dados agora fazem parte de Como o CloudPeek funciona.

Tipos de widget

Todas as visualizações de widgets de métricas do CloudWatch, além dos widgets de texto e de status do alarme, viram widgets nativos no iPhone, no iPad e no Android, desenhados nas cores do seu painel, com os limites e os mínimos e máximos dos eixos definidos nele.

Quando uma lista não cabe

• Barras: se somar as barras que sobram faz sentido (valores monetários, ou contagens e somas da mesma métrica), a última barra vira uma barra cinza Outros com o total delas. Caso contrário, você vê “Mais N”. As barras mostradas são as mais distantes de zero, ou as mais baixas quando os níveis do widget estão em Abaixo (consulte Níveis de aviso e de alarme).
• Totais: um widget de barras ou de pizza mostra um Total quando o painel tem um, como a linha EstimatedCharges da conta inteira ou uma expressão SUM(METRICS()). Essa linha não é desenhada como uma barra própria. Um widget de valores monetários com várias barras calcula o total sozinho.
• Pizza: todas as fatias são desenhadas; a legenda lista as que couberem e depois “Mais N”. Se o total for maior que a soma das fatias, a diferença vira uma fatia cinza Outros.
• As legendas dos gráficos de linha e de área empilhada listam até quatro séries nos widgets médios (menos com tamanhos de texto maiores) e quatro nos grandes, cada uma com o valor mais recente, e depois “Mais N”. Os widgets pequenos não têm legenda.
• As tabelas e as listas de alarmes mostram as linhas que couberem e depois “Mais N”. Uma tabela com uma linha para cada período mostra as mais recentes e depois “Anteriores: N”.

Tamanhos

Todo widget está disponível em todos os tamanhos. O CloudPeek mostra uma prévia de cada um antes de você adicioná-lo. No Android, você escolhe o tamanho de um widget da tela inicial redimensionando-o, e ele mostra o layout para o espaço que tem: pequeno a partir de 110 × 110 dp, médio a partir de 250 × 110 dp e grande a partir de 250 × 250 dp. Em uma tela inicial com quatro apps de largura, isso equivale a 2 × 2, 4 × 2 e 4 × 4 células.

• Os widgets de tamanho Pequeno não têm legenda nem rodapé. Um widget de alarmes começa pela linha principal, como “1 em alarme”.
• Os widgets de tamanho Médio e maiores acrescentam um botão de atualizar, uma legenda e um rodapé com a janela de tempo e o horário da atualização, como “Últimas 3 horas · Atualizado: 14:05”. As listas de alarmes dizem há quanto tempo cada alarme mudou.
• Os widgets de tamanho Grande acrescentam mais rótulos nos eixos. O Extragrande, no iPad, é o layout grande com mais espaço; no Android, cada layout é desenhado para preencher o espaço que você der a ele.
• Um widget de barras com Total cede um dos seus lugares ao Total nos tamanhos pequeno e médio.
• As linhas que cabem dependem do tamanho do texto; as que sobram são contadas como “Mais N”.
• No iPhone, o modo Em Espera mostra os widgets pequenos, desenhados maiores e sobre fundo preto, e a mesa do Mac mostra os widgets pequenos, médios e grandes do iPhone (consulte Em Espera e No Mac).

Listas de alarmes

Um widget de alarmes lista os alarmes nesta ordem, cada um com o estado dele:

• Dentro de cada estado, os alarmes mantêm a ordem em que o widget os lista ou, com "sortBy": "stateUpdatedTimestamp", a mudança mais recente vem primeiro.
• Os widgets médios e maiores dizem há quanto tempo cada alarme mudou de estado.
• A linha principal, nos widgets pequenos e na Tela Bloqueada, mostra N em alarme em vermelho quando algum alarme está em alarme, Tudo OK em verde quando todos estão OK, Sem dados quando nenhum tem dados suficientes ainda e, nos outros casos, N com estado desconhecido, contando os que estão sem dados ou não foram encontrados.
• Já a predefinição Resumo de alarmes conta os alarmes em cada estado, como “2 falhando, 4 com dados insuficientes, 14 OK”: consulte Predefinições.
• Uma predefinição de alarmes de todas as contas dá uma linha a cada conta, da mais grave para a menos grave, com o símbolo do estado mais grave dela, como “prod: 2 falhando”; Alarmes lista abaixo dela os alarmes da conta que não estão OK. Consulte Alarmes em todas as contas.

Tela Bloqueada

Os widgets da Tela Bloqueada, no iPhone e no iPad, mostram um valor principal, para você ler sem desbloquear. Os celulares Android não têm widgets da Tela Bloqueada.

• Retangular: o título, o valor e a série ou barra de onde ele veio (ou um aviso, se estiver desatualizado).
• Circular: o valor e uma legenda de cerca de 8 caracteres tirada do título.
• Em linha, acima do relógio: o valor e o título, cortado em palavras inteiras com cerca de 18 caracteres.
• Níveis: um valor que passou do nível de aviso ou de alarme do widget tem o símbolo desse nível ao lado, já que a Tela Bloqueada desenha em uma só cor (consulte Níveis de aviso e de alarme).

Widgets Visão geral

Um widget Visão geral mostra de dois a quatro dos seus widgets pelos valores mais recentes deles (consulte Vários valores em um widget): dois em um widget pequeno, quatro nos médios e maiores e, no iPhone e no iPad, o primeiro na Tela Bloqueada.

• O valor é o valor principal de cada widget na Tela Bloqueada, da tabela acima. Um widget de alarmes, inclusive a predefinição Resumo de alarmes, mostra a linha principal, como “1 em alarme” em vermelho com um triângulo vermelho, “Tudo OK” em verde com uma marca de verificação verde, ou “Nenhum alarme” quando não tem nenhum. Já um widget de alarmes de todas as contas mostra a linha da conta mais grave que precisa de atenção, como “prod: 2 falhando” ou “dev: faça login para atualizar”, para que uma conta que não pôde ser lida não fique escondida atrás do “Tudo OK” das outras.
• Níveis: um valor que passou do nível de aviso do widget fica âmbar com um “!” em um círculo e, se passou do nível de alarme, vermelho com um triângulo, como no próprio widget (consulte Níveis de aviso e de alarme). O que é medido é o valor mostrado; um total de barras, que não é medido, assume o pior nível que qualquer uma das barras tenha passado.
• A tendência, uma seta e uma porcentagem como “+12%”, é quanto o valor mudou desde o ponto anterior: para um número, quando o widget dele mostra a tendência, um medidor e um gráfico de linhas ou de área empilhada. Barras, pizzas, tabelas, alarmes e gráficos desenhados como colunas não têm tendência: uma coluna costuma ser um período ainda em andamento, como os gastos de hoje até agora.
• Os widgets de texto não têm valor, por isso o Visão geral não os oferece.
• Um widget que não pôde ser atualizado mantém o último valor e diz por quê no lugar da tendência, em laranja: “Faça login para atualizar”, “Conta não adicionada” ou “Sem atualização desde 14:05”; sem valor para manter, “Acesso negado”, “Sem conexão com a AWS” e mensagens parecidas. Dados com mais de um dia ficam esmaecidos.

Configurações de painel que o CloudPeek usa

O CloudPeek lê o JSON do painel e faz as consultas do mesmo jeito que o console do CloudWatch. As predefinições e os widgets de IA são escritos no mesmo JSON, então tudo isto também vale para eles.

Compatíveis

• Métricas: linhas de métrica com as abreviações "." e "..."; expressões de matemática de métricas, SEARCH e Metrics Insights (SELECT … FROM SCHEMA(…)); "visible": false para entradas que não devem ser desenhadas.
• Por métrica: id, label (inclusive rótulos dinâmicos como ${PROP('Dim.ServiceName')} e ${LAST}), color, stat, period, region, accountId e yAxis.
• Por widget: title, view, stacked, stat (Average, se não for definido), period, region, accountId, start, end, setPeriodToTimeRange, sparkline, trend, min e max do eixo y nos dois lados, annotations horizontais (valor, cor, eixo e visible) e "legend": {"position": "hidden"}.
• Eixo y direito: as métricas com "yAxis": "right" são desenhadas na sua própria escala, com rótulos à direita.
• Por painel: start, end e periodOverride.
• Widgets de alarme: alarms e sortBy.

Não usados

• Rótulos de anotações e rótulos do eixo y (as linhas e os limites são desenhados, sem o texto), faixas de anotação (só a primeira borda é desenhada) e anotações verticais.
• Posições de legenda diferentes de hidden, liveData, singleValueFullPrecision e as opções de resumo de tabela.
• Variáveis de painel: os widgets usam os valores salvos no painel.

Intervalo de tempo e período

• Intervalo de tempo: o start do widget, se houver; caso contrário, o do painel; caso contrário, as últimas 3 horas. Funcionam tanto intervalos relativos, como -PT3H ou -P7D, quanto timestamps absolutos. Todo widget mostra a janela de tempo que cobre, como “Últimas 3 horas”.
• Período: o period da métrica; caso contrário, o do widget; caso contrário, 5 minutos. Como o console, o CloudPeek aumenta o período quando o intervalo precisaria de pontos demais (mais de 300, ou 1.440 com "periodOverride": "inherit"), passando por 1 minuto, 5 minutos, 15 minutos, 1 hora, 3 horas, 6 horas, 1 dia, 1 semana e 30 dias.
• Dados mais antigos têm resolução menor no CloudWatch, então intervalos que começam há mais de 15 dias usam períodos de pelo menos 5 minutos, e os que começam há mais de 63 dias, de pelo menos 1 hora.
• setPeriodToTimeRange faz os widgets de número, medidor, barra, pizza e tabela usarem um único período para o intervalo inteiro, como no console.

Como os valores são mostrados

• Os números têm três algarismos significativos, com K, M, B e T para milhares, milhões, bilhões e trilhões: 1.23K, 45.6M. Um valor que, com três algarismos, seria arredondado para um número redondo enganoso mantém mais algarismos, então 99,96 não aparece como 100. As unidades do CloudWatch não são mostradas, então coloque a unidade no rótulo, como “Latência (s)”.
• Moeda: quando todas as métricas de um widget são AWS/Billing EstimatedCharges na mesma moeda, os valores são mostrados como dinheiro: com centavos abaixo de 100, valores inteiros até 10.000 e, acima disso, de forma compacta, como $12.3K. Um SEARCH de AWS/Billing que não indica uma Currency é mostrado em dólares americanos, a única moeda em que a AWS publica as cobranças.
• Os nomes dos serviços nos widgets de faturamento são abreviados: AmazonEC2 vira EC2 e AWSLambda vira Lambda.
• Rótulos: uma métrica sem rótulo recebe o nome da métrica, ou dos valores de dimensão que a diferenciam das outras do widget.
• As tendências nos números comparam o ponto de dados mais recente com o anterior.
• Cores: o seu color em cada métrica; caso contrário, a paleta padrão do CloudWatch.
• Níveis de aviso e de alarme: o valor mais recente de um número, medidor, barra ou gráfico que passa de um nível definido no CloudPeek fica âmbar ou vermelho, com um símbolo (consulte Níveis de aviso e de alarme). O CloudPeek grava seus níveis no widget como anotações horizontais marcadas com "cloudPeekLevel", que os gráficos desenham como linhas tracejadas. As anotações do seu próprio painel também são desenhadas como linhas, mas nunca colorem um valor.

Contas, regiões e limites

• Regiões: cada métrica usa a própria region, depois a do widget, depois a região padrão da conta no CloudPeek. Um widget pode misturar regiões; o CloudPeek consulta cada uma em paralelo.
• Contas: cada widget é atualizado com a conta para a qual foi criado. Para mostrar métricas de outra conta em um widget, use accountId na métrica com a observabilidade entre contas do CloudWatch, ou adicione essa conta ao CloudPeek e crie o widget para ela.
• Os alarmes são procurados na conta para a qual o widget foi criado, na região de cada ARN. As predefinições de alarmes leem até 1.000 alarmes na região em que foram adicionadas (só aqueles cujo nome começa com o texto escolhido em Mostrar, se houver um); acima disso, os mantidos são os que estão em ALARM.
• Tamanho: um widget pode solicitar até 500 métricas por região de uma vez e mantém até 400 pontos por linha. Os gráficos desenham no máximo 30 séries: um gráfico de linhas mostra as 30 com os maiores valores, e um gráfico empilhado soma o resto em Outros.

Widgets de texto

Os widgets de texto são úteis para uma nota de runbook ao lado dos gráficos. O CloudPeek mostra:

• Negrito, itálico, code e links.
• Títulos, como linhas em negrito.
• Listas com marcadores (*, - ou +), como marcadores.
• Os botões do CloudWatch, [button:Label](https://…), como links simples.

As linhas horizontais são omitidas, e sequências de linhas em branco são reduzidas. Tabelas, imagens e blocos de código ficam melhor no painel, no console. Um widget de texto sem título recebe o nome da primeira linha.