Ejemplo: alarmas de producción

Qué vas a crear

Vas a crear un panel de CloudWatch llamado CloudPeek-Alarms con un widget de Estado de alarma que enumera tus alarmas de producción. Las alarmas en ALARM siempre aparecen primero, así que la que te necesita es la que ves. En CloudPeek se ve así:

Se tarda unos cinco minutos si tus alarmas ya existen.

Antes de empezar

• Alarmas de CloudWatch que vigilar: alarmas de métricas o alarmas compuestas, en cualquier región de una cuenta.
• Acceso para CloudPeek. La política CloudPeek de Primeros pasos ya incluye cloudwatch:DescribeAlarms, que necesitan los widgets de alarmas. Si ya la has configurado, puedes empezar.
• Un acceso que pueda crear paneles de CloudWatch, como el de un administrador.

1. Crear el panel

aws cloudwatch describe-alarms \
  --region us-east-1 \
  --alarm-name-prefix prod- \
  --query '[MetricAlarms[].AlarmArn, CompositeAlarms[].AlarmArn][]' \
  --output json

aws cloudwatch put-dashboard \
  --region us-east-1 \
  --dashboard-name CloudPeek-Alarms \
  --dashboard-body file://production-alarms.json

aws cloudwatch describe-alarms \
  --region us-east-1 \
  --alarm-name-prefix prod- \
  --query '[MetricAlarms[].AlarmArn, CompositeAlarms[].AlarmArn][]' \
  --output json |
jq '{widgets: [{type: "alarm", x: 0, y: 0, width: 12, height: 6,
  properties: {title: "Production alarms", sortBy: "stateUpdatedTimestamp", alarms: .}}]}' \
  > production-alarms.json

aws cloudwatch put-dashboard \
  --region us-east-1 \
  --dashboard-name CloudPeek-Alarms \
  --dashboard-body file://production-alarms.json

  AlarmsDashboard:
    Type: AWS::CloudWatch::Dashboard
    Properties:
      DashboardName: CloudPeek-Alarms
      DashboardBody: !Sub |
        {
          "widgets": [
            {
              "type": "alarm", "x": 0, "y": 0, "width": 12, "height": 6,
              "properties": {
                "title": "Production alarms",
                "sortBy": "stateUpdatedTimestamp",
                "alarms": [
                  "${ApiErrorsAlarm.Arn}",
                  "${QueueDepthAlarm.Arn}"
                ]
              }
            }
          ]
        }

Resources:
  # sortBy puts the most recent change first within each state; CloudPeek always lists alarms in
  # ALARM first. The ARNs are joined into a JSON array of strings.
  Dashboard:
    Type: AWS::CloudWatch::Dashboard
    Properties:
      DashboardName: !Ref DashboardName
      DashboardBody: !Sub
        - |
          {
            "widgets": [
              {
                "type": "alarm",
                "x": 0,
                "y": 0,
                "width": 12,
                "height": 6,
                "properties": {
                  "title": "${WidgetTitle}",
                  "sortBy": "stateUpdatedTimestamp",
                  "alarms": [ "${Alarms}" ]
                }
              }
            ]
          }
        - Alarms: !Join ['", "', !Ref AlarmArns]

aws cloudformation deploy \
  --stack-name CloudPeek-Alarms \
  --template-file cloudpeek-alarms.yaml \
  --parameter-overrides 'AlarmArns=arn:aws:cloudwatch:us-east-1:123456789012:alarm:prod-api-5xx-errors,arn:aws:cloudwatch:us-east-1:123456789012:alarm:prod-worker-queue-depth'

resource "aws_cloudwatch_dashboard" "alarms" {
  dashboard_name = "CloudPeek-Alarms"
  dashboard_body = jsonencode({
    widgets = [{
      type = "alarm", x = 0, y = 0, width = 12, height = 6
      properties = {
        title  = "Production alarms"
        sortBy = "stateUpdatedTimestamp"
        alarms = [
          aws_cloudwatch_metric_alarm.api_5xx.arn,
          aws_cloudwatch_metric_alarm.queue_depth.arn,
        ]
      }
    }]
  })
}

variable "alarm_arns" {
  description = "The ARNs of the alarms to list. Each ARN names its own region, so one widget can list alarms from several regions."
  type        = list(string)

  validation {
    condition     = length(var.alarm_arns) > 0
    error_message = "List at least one alarm ARN."
  }
}

# sortBy puts the most recent change first within each state; CloudPeek always lists alarms in
# ALARM first.
resource "aws_cloudwatch_dashboard" "alarms" {
  dashboard_name = var.dashboard_name
  dashboard_body = jsonencode({
    widgets = [
      {
        type   = "alarm"
        x      = 0
        y      = 0
        width  = 12
        height = 6
        properties = {
          title  = var.widget_title
          sortBy = "stateUpdatedTimestamp"
          alarms = var.alarm_arns
        }
      },
    ]
  })
}

alarm_arns = [
  "arn:aws:cloudwatch:us-east-1:123456789012:alarm:prod-api-5xx-errors",
  "arn:aws:cloudwatch:us-east-1:123456789012:alarm:prod-worker-queue-depth",
]

terraform init
terraform apply

2. Añadir la cuenta y fijar el widget

1. Abre CloudPeek y añade la cuenta con tus alarmas en la pestaña Cuentas, con una clave de acceso o con IAM Identity Center. Consulta Primeros pasos, paso 2.
2. En la pestaña Cuentas, abre la cuenta, después el panel CloudPeek-Alarms, y toca Fijar en Production alarms.
3. Añade CloudPeek a tu pantalla de inicio (consulta Pantalla de inicio y pantalla bloqueada). Empieza mostrando Production alarms, el último widget que fijaste. El tamaño mediano muestra cuándo cambió cada alarma por última vez; el pequeño va bien para un recuento rápido.
4. Toca el widget para ver cada alarma con el motivo de su estado según CloudWatch y desde cuándo está así, y para abrir cualquiera de ellas en la consola de AWS. En un widget mediano o grande, toca una alarma para ir directamente a ella en la consola.

Resultado: el widget enumera tus alarmas, con las que están en alarma arriba. En la pantalla bloqueada del iPhone y el iPad, muestra el resumen, como «1 en alarma» o «Todo OK».

El panel, explicado

Uses la herramienta que uses, el panel acaba así, con los ARN de tus propias alarmas:

{
  "widgets": [
    {
      "type": "alarm",
      "x": 0,
      "y": 0,
      "width": 12,
      "height": 6,
      "properties": {
        "title": "Production alarms",
        "sortBy": "stateUpdatedTimestamp",
        "alarms": [
          "arn:aws:cloudwatch:us-east-1:123456789012:alarm:prod-api-5xx-errors",
          "arn:aws:cloudwatch:us-east-1:123456789012:alarm:prod-worker-queue-depth",
          "arn:aws:cloudwatch:us-east-1:123456789012:alarm:prod-api-high-cpu"
        ]
      }
    }
  ]
}

• Un widget alarm enumera alarmas por su ARN, tantas como quieras.
• "sortBy": "stateUpdatedTimestamp" muestra primero el cambio más reciente dentro de cada estado, en CloudPeek y en la consola de CloudWatch.
• Cada ARN indica su región, y CloudPeek busca cada alarma en su propia región, así que un widget puede enumerar alarmas de varias regiones.

Cómo se ordenan las alarmas

• Las alarmas en ALARM siempre van primero en CloudPeek, después las alarmas sin datos suficientes, luego las que no encuentra y, por último, las que están en OK. Si tienes más alarmas de las que caben, se muestran las que te necesitan.
• Sin sortBy, la consola ordena las alarmas por nombre, y CloudPeek mantiene el orden en que aparecen, siempre con las alarmas en ALARM primero.
• Un widget pequeño muestra su resumen y las tres o cuatro primeras alarmas. Los widgets medianos y más grandes muestran tantas como quepan, aproximadamente una docena en uno grande, cada una con hace cuánto cambió de estado. Las demás se cuentan como +N más.
• El resumen, en los widgets pequeños y en la pantalla bloqueada, dice N en alarma en rojo, Todo OK en verde cuando todas las alarmas están en OK, Sin datos cuando ninguna tiene aún datos suficientes, o N sin estado cuando algunas no tienen datos o no se encuentran.
• El símbolo de cada alarma muestra su estado: consulta Listas de alarmas.

Recibir un aviso cuando se active una alarma

CloudPeek puede enviar una notificación cuando una de las alarmas de un widget de alarmas pasa a ALARM, con el nombre de la alarma y el motivo que da CloudWatch, como «Threshold Crossed: 1 datapoint [12.0] was greater than the threshold (10.0).» Funciona con cualquier widget de alarmas: uno fijado desde un panel, como Production alarms, o las plantillas Alarmas y Resumen de alarmas, incluida una que cubra todas tus cuentas, que avisa cuando una alarma empieza a activarse en cualquiera de ellas (consulta Alarmas en todas las cuentas).

1. En la pestaña Widgets, toca Production alarms para abrir su propia pantalla.
2. Activa Avisar cuando se active una alarma, debajo de la lista de alarmas.
3. La primera vez, tu teléfono pregunta si CloudPeek puede enviarte notificaciones (en Android, a partir de Android 13): toca Permitir.

Resultado: el interruptor está activado. Cuando una actualización encuentra en alarma una de las alarmas del widget que no lo estaba en la actualización anterior, recibes una notificación como «prod-api-5xx-errors está en alarma». Tócala para abrir la pantalla del widget, con el motivo de cada alarma y un enlace a cada una en la consola de AWS.

Las notificaciones proceden de las actualizaciones del widget: las de los widgets de la pantalla de inicio que lo muestran (y de la pantalla bloqueada, en el iPhone y el iPad), incluido un widget Vista general que lo incluya, y las de la app. Mantén el widget en tu pantalla de inicio, como en el paso 2, o solo se actualizará mientras tengas CloudPeek abierto.

• Cada alarma se notifica una vez cada vez que pasa a estado de alarma, independientemente de cuántas actualizaciones o widgets la encuentren. Una que ya esté en alarma cuando activas las notificaciones se notifica la próxima vez que se active. Una que pasa de OK a datos insuficientes no se está activando, así que no se notifica.
• Hasta tres alarmas que empiecen a activarse a la vez reciben una notificación cada una. Si son más, llegan en una sola notificación que las nombra todas, como «4 alarmas están en alarma».
• Una alarma con el mismo nombre que otra de las que enumera el widget se nombra con su región y, entre cuentas, con el ID de su cuenta de AWS cuando es eso lo que las distingue, como «api-5xx (us-east-1, 222222222222) está en alarma».
• Las notificaciones se generan en tu teléfono o tablet a partir de lo que ha obtenido el widget. No se envía nada a CloudPeek ni a ningún servicio de notificaciones push, y no necesitan ningún permiso de AWS que el widget no tenga ya.
• Al eliminar el widget se desactivan sus notificaciones, y Deshacer las vuelve a activar.
• Si las notificaciones de CloudPeek están desactivadas en los Ajustes del teléfono, la pantalla del widget dice «Las notificaciones de CloudPeek están desactivadas. Permítelas en Ajustes para recibir avisos.» En el iPhone y el iPad, toca Abrir Ajustes, activa Permitir notificaciones y vuelve a CloudPeek. En Android, toca Abrir Ajustes, que abre los ajustes de notificaciones de CloudPeek, actívalas y vuelve.

Solución de problemas

Una alarma muestra un círculo discontinuo

CloudPeek no la ha encontrado. Comprueba que el nombre, la región y la cuenta del ARN coinciden exactamente con la alarma: los nombres de las alarmas distinguen entre mayúsculas y minúsculas. CloudPeek busca las alarmas en la cuenta desde la que fijaste el widget, así que no puede encontrar una alarma de otra cuenta de AWS; ponla en un panel de esa cuenta y añade esa cuenta a CloudPeek.

Una alarma muestra un signo de interrogación

Aún no tiene datos suficientes para que CloudWatch la evalúe, igual que en la consola. Aparece después de las alarmas en ALARM.

CloudPeek dice que el acceso está denegado

El acceso necesita cloudwatch:DescribeAlarms. Está en la política CloudPeek y en la política administrada por AWS CloudWatchReadOnlyAccess.

No llegan las notificaciones

Comprueba que Avisar cuando se active una alarma está activado para el widget, que su pantalla no dice que las notificaciones están desactivadas y que el widget está en tu pantalla de inicio (o, en el iPhone y el iPad, en tu pantalla bloqueada), cuyas actualizaciones las envían. Solo llegan con la frecuencia con que se actualiza el widget, y una alarma que ya estaba en alarma se notifica la próxima vez que se active. Consulta Recibir un aviso cuando se active una alarma.

El orden en la consola es distinto

Sin "sortBy": "stateUpdatedTimestamp", la consola de CloudWatch ordena las alarmas por nombre. Añádelo a las propiedades del widget para que coincida con CloudPeek.

Otro problema

Consulta Solución de problemas o escribe a support@cloudpeek.app. Nunca nos envíes tu clave de acceso secreta.