Referencia de widgets

Acerca de esta página

Esta página es de consulta: cómo se dibuja cada tipo de widget de CloudWatch, en cada tamaño, y qué partes exactas del JSON de un panel usa CloudPeek. Las plantillas y los widgets de IA se escriben en el mismo JSON, así que también se aplica a ellos. Para crear widgets, consulta Crear un widget.

La creación de widgets tiene ahora su propia página: Crear un widget.

Las plantillas tienen ahora su propia página: Plantillas.

Los widgets de IA tienen ahora su propia página: Widgets de IA.

La pestaña Widgets forma parte ahora de Pantalla de inicio y pantalla bloqueada.

La actualización y la antigüedad de los datos forman parte ahora de Cómo funciona CloudPeek.

Tipos de widget

Todas las vistas de los widgets de métricas de CloudWatch, además de los widgets de texto y de estado de alarma, se convierten en widgets nativos en el iPhone, el iPad y Android, dibujados con los colores de tu panel, sus umbrales y los límites de sus ejes.

Cuando una lista no cabe

• Barras: si tiene sentido sumar las barras que sobran (importes, o recuentos y sumas de la misma métrica), la última barra pasa a ser una barra gris Otros con su total. Si no, verás «+N más». Las barras que se muestran son las más alejadas de cero, o las más bajas cuando los niveles del widget son Por debajo (consulta Niveles de aviso y de alarma).
• Totales: un widget de barras o circular muestra un Total cuando el panel tiene uno, como la fila EstimatedCharges de toda la cuenta o una expresión SUM(METRICS()). Esa fila no se dibuja como una barra propia. Un widget de importes con varias barras calcula su total él mismo.
• Circular: se dibujan todas las porciones; la leyenda muestra todas las que caben y luego «+N más». Si el total es mayor que la suma de las porciones, la diferencia es una porción gris Otros.
• Las leyendas de los gráficos de líneas y de áreas apiladas muestran hasta cuatro series en los widgets medianos (menos con tamaños de texto más grandes) y cuatro en los grandes, cada una con su último valor, y luego «+N más». Los widgets pequeños no tienen leyenda.
• Las tablas y las listas de alarmas muestran todas las filas que caben y luego «+N más». Una tabla con una fila por período muestra las más recientes y luego «+N de antes».

Tamaños

Todos los widgets están disponibles en todos los tamaños. CloudPeek muestra una vista previa de cada uno antes de que lo añadas. En Android, eliges el tamaño de un widget de la pantalla de inicio redimensionándolo, y muestra el diseño que corresponde al espacio que tiene: pequeño a partir de 110 × 110 dp, mediano a partir de 250 × 110 dp y grande a partir de 250 × 250 dp. En una pantalla de inicio de cuatro apps de ancho, son 2 × 2, 4 × 2 y 4 × 4 celdas.

• Los widgets pequeños no tienen leyenda ni pie. Un widget de alarmas empieza con su resumen, como «1 en alarma».
• Los widgets medianos y más grandes añaden un botón de actualizar, una leyenda y un pie con el intervalo de tiempo y cuándo se actualizó, como «Últimas 3 horas · Actualizado 14:05». Las listas de alarmas indican hace cuánto cambió cada alarma.
• Los widgets grandes añaden más etiquetas en los ejes. El tamaño extragrande, en el iPad, es el diseño grande con más espacio; en Android, cada diseño se dibuja para llenar el espacio que le des.
• Un widget de barras con Total cede al Total uno de sus huecos en los widgets pequeños y medianos.
• Las filas que caben dependen del tamaño del texto; las demás se cuentan como «+N más».
• En el iPhone, el modo StandBy muestra los widgets pequeños, dibujados más grandes y sobre fondo negro, y el escritorio de un Mac muestra los pequeños, medianos y grandes del iPhone (consulta Modo StandBy y En el Mac).

Listas de alarmas

Un widget de alarmas muestra las alarmas en este orden, cada una con su estado:

• Dentro de cada estado, las alarmas mantienen el orden en que las enumera el widget o, con "sortBy": "stateUpdatedTimestamp", el cambio más reciente va primero.
• Los widgets medianos y más grandes indican hace cuánto cambió de estado cada alarma.
• El resumen, en los widgets pequeños y en la pantalla bloqueada, dice N en alarma en rojo cuando alguna alarma está en alarma, Todo OK en verde cuando todas están OK, Sin datos cuando ninguna tiene aún datos suficientes y, en otro caso, N sin estado, contando las que no tienen datos o no se encuentran.
• La plantilla Resumen de alarmas, en cambio, cuenta las alarmas en cada estado, como «2 en alarma, 4 con datos insuficientes, 14 OK»: consulta Plantillas.
• Una plantilla de alarmas de todas las cuentas dedica una línea a cada cuenta, de la más grave a la menos grave, con el símbolo de su estado más grave, como «prod: 2 en alarma»; Alarmas muestra debajo las alarmas de la cuenta que no están OK. Consulta Alarmas en todas las cuentas.

Pantalla bloqueada

Los widgets de la pantalla bloqueada, en el iPhone y el iPad, muestran un valor principal para que puedas leerlo sin desbloquear. Los teléfonos Android no tienen widgets de la pantalla bloqueada.

• Rectangular: el título, el valor y la serie o la barra de la que procede (o un aviso si está desactualizado).
• Circular: el valor y un rótulo de unos 8 caracteres tomado del título.
• En línea, encima del reloj: el valor y el título, recortado a palabras completas de unos 18 caracteres.
• Niveles: un valor que supera el nivel de aviso o de alarma del widget lleva al lado el símbolo de ese nivel, ya que la pantalla bloqueada dibuja en un solo color (consulta Niveles de aviso y de alarma).

Widgets Vista general

Un widget Vista general muestra de dos a cuatro de tus widgets con sus últimos valores (consulta Varios valores en un widget): dos en un widget pequeño, cuatro en los medianos y más grandes y, en el iPhone y el iPad, el primero en la pantalla bloqueada.

• El valor es el valor principal de cada widget en la pantalla bloqueada, de la tabla anterior. Un widget de alarmas, y también la plantilla Resumen de alarmas, muestra su resumen, como «1 en alarma» en rojo con un triángulo rojo, «Todo OK» en verde con una marca de verificación verde o «Sin alarmas» cuando no tiene ninguna. Un widget de alarmas de todas las cuentas muestra en su lugar la línea de la cuenta más grave que requiere atención, como «prod: 2 en alarma» o «dev: inicia sesión para actualizar», para que una cuenta que no se ha podido leer no quede oculta tras el «Todo OK» de las demás.
• Niveles: un valor que supera el nivel de aviso de su widget aparece en ámbar con un «!» en un círculo y, si supera el de alarma, en rojo con un triángulo, como en el propio widget (consulta Niveles de aviso y de alarma). Lo que se mide es el valor mostrado; un total de barras, que no se mide, toma el peor nivel que supere cualquiera de sus barras.
• La tendencia, una flecha y un porcentaje como «+12 %», es cuánto ha cambiado el valor desde el punto anterior: en un número cuando su widget muestra la tendencia, en un indicador y en un gráfico de líneas o de áreas apiladas. Las barras, los gráficos circulares, las tablas, las alarmas y los gráficos dibujados como columnas no la tienen: una columna suele ser un período aún en curso, como el gasto de hoy hasta ahora.
• Los widgets de texto no tienen valor, así que un widget Vista general no los ofrece.
• Un widget que no se ha podido actualizar conserva su último valor y dice por qué en lugar de su tendencia, en naranja: «Inicia sesión para actualizar», «Cuenta no añadida» o «Sin actualizar desde 14:05»; si no tiene ningún valor que conservar, «Acceso denegado», «Sin conexión con AWS» y similares. Los datos de más de un día aparecen atenuados.

Ajustes del panel que usa CloudPeek

CloudPeek lee el JSON del panel y lo consulta como lo hace la consola de CloudWatch. Las plantillas y los widgets de IA se escriben en el mismo JSON, así que todo esto también se aplica a ellos.

Qué se admite

• Métricas: filas de métricas con las abreviaturas "." y "..."; expresiones de matemáticas de métricas, SEARCH y Metrics Insights (SELECT … FROM SCHEMA(…)); "visible": false para entradas que no deben dibujarse.
• Por métrica: id, label (incluidas etiquetas dinámicas como ${PROP('Dim.ServiceName')} y ${LAST}), color, stat, period, region, accountId y yAxis.
• Por widget: title, view, stacked, stat (Average si no se define), period, region, accountId, start, end, setPeriodToTimeRange, sparkline, trend, min y max del eje Y en cualquiera de los dos lados, annotations horizontales (valor, color, eje y visible) y "legend": {"position": "hidden"}.
• Eje Y derecho: las métricas con "yAxis": "right" se dibujan en su propia escala, con etiquetas a la derecha.
• Por panel: start, end y periodOverride.
• Widgets de alarmas: alarms y sortBy.

Qué no se usa

• Las etiquetas de las anotaciones y del eje Y (las líneas y los límites se dibujan, sin su texto), las bandas de anotación (solo se dibuja su primer borde) y las anotaciones verticales.
• Las posiciones de la leyenda distintas de oculta, liveData, singleValueFullPrecision y las opciones de resumen de las tablas.
• Las variables del panel: los widgets usan los valores guardados en el panel.

Intervalo de tiempo y período

• Intervalo de tiempo: el start del widget, si lo tiene; si no, el del panel; si no, las últimas 3 horas. Funcionan tanto los intervalos relativos, como -PT3H o -P7D, como las marcas de tiempo absolutas. Cada widget muestra el intervalo que abarca, como «Últimas 3 horas».
• Período: el period de la métrica; si no, el del widget; si no, 5 minutos. Como la consola, CloudPeek lo aumenta cuando el intervalo necesitaría demasiados puntos (más de 300, o 1440 con "periodOverride": "inherit"), pasando por 1 minuto, 5 minutos, 15 minutos, 1 hora, 3 horas, 6 horas, 1 día, 1 semana y 30 días.
• Los datos más antiguos tienen menos resolución en CloudWatch, así que los intervalos que empiezan hace más de 15 días usan períodos de al menos 5 minutos, y los que empiezan hace más de 63 días, de al menos 1 hora.
• setPeriodToTimeRange hace que los widgets de número, indicador, barras, circular y tabla usen un solo período para todo el intervalo, como en la consola.

Cómo se muestran los valores

• Los números tienen tres cifras significativas, con K, M, B y T para miles, millones, miles de millones y billones: 1.23K, 45.6M. Un valor que con tres cifras se redondearía a un número engañosamente redondo conserva más, así que 99,96 no se muestra como 100. Las unidades de CloudWatch no se muestran, así que pon la unidad en la etiqueta, como «Latencia (s)».
• Moneda: cuando todas las métricas de un widget son EstimatedCharges de AWS/Billing en la misma moneda, los valores se muestran como importes: con centavos por debajo de 100, cantidades enteras hasta 10 000 y, a partir de ahí, en formato compacto, como $12.3K. Una expresión SEARCH de AWS/Billing que no indica una Currency se muestra en dólares estadounidenses, la única moneda en la que AWS publica los cargos.
• Los nombres de servicio de los widgets de facturación se acortan: AmazonEC2 pasa a ser EC2 y AWSLambda, Lambda.
• Etiquetas: una métrica sin etiqueta recibe el nombre de la métrica, o el de los valores de dimensión que la distinguen de las demás del widget.
• Las tendencias de los números comparan el último punto de datos con el anterior.
• Colores: tu color en cada métrica; si no, la paleta predeterminada de CloudWatch.
• Niveles de aviso y de alarma: el último valor de un número, un indicador, una barra o un gráfico que supera un nivel que has definido en CloudPeek aparece en ámbar o en rojo, con un símbolo (consulta Niveles de aviso y de alarma). CloudPeek escribe sus niveles en el widget como anotaciones horizontales marcadas con "cloudPeekLevel", que los gráficos dibujan como líneas discontinuas. Las anotaciones propias de tu panel también se dibujan como líneas, pero nunca colorean un valor.

Cuentas, regiones y límites

• Regiones: cada métrica usa su propia region; si no, la del widget; si no, la región predeterminada de la cuenta en CloudPeek. Un widget puede mezclar regiones; CloudPeek consulta cada una en paralelo.
• Cuentas: cada widget se actualiza con la cuenta para la que se creó. Para mostrar las métricas de otra cuenta en un widget, usa accountId en la métrica con la observabilidad entre cuentas de CloudWatch, o añade esa cuenta a CloudPeek y crea el widget para ella.
• Las alarmas se buscan en la cuenta para la que se creó el widget, en la región de cada ARN. Las plantillas de alarmas leen hasta 1000 alarmas en la región en la que se añadieron (solo aquellas cuyo nombre empieza por el texto elegido en Mostrar, si se eligió uno); por encima de esa cifra, se conservan las que están en ALARM.
• Tamaño: un widget puede solicitar hasta 500 métricas por región a la vez y conserva hasta 400 puntos por línea. Los gráficos dibujan como máximo 30 series: un gráfico de líneas muestra las 30 con los valores más altos, y un gráfico apilado suma el resto como Otros.

Widgets de texto

Los widgets de texto son útiles para dejar una nota del manual de operaciones junto a los gráficos. CloudPeek muestra:

• Negrita, cursiva, code y enlaces.
• Encabezados, como líneas en negrita.
• Listas con viñetas (*, - o +), como viñetas.
• Los botones de CloudWatch, [button:Label](https://…), como enlaces normales.

Las líneas horizontales se omiten y las líneas en blanco seguidas se reducen. Es mejor dejar las tablas, las imágenes y los bloques de código para el panel en la consola. Un widget de texto sin título recibe el nombre de su primera línea.