Nota

Este complemento es parte del colección community.aws (versión 1.3.0).

Para instalarlo use: ansible-galaxy collection install community.aws.

Para usarlo en un libro de jugadas, especifique: community.aws.ec2_metric_alarm.

Nuevo en la versión 1.0.0: de community.aws

  • Sinopsis
  • Requisitos
  • Parámetros
  • Notas
  • Ejemplos de

Sinopsis

  • Puede crear o eliminar alarmas métricas de AWS.
  • Las métricas sobre las que desea activar la alarma ya deben existir.

Requisitos

Los siguientes requisitos son necesarios en el host que ejecuta este módulo.

  • pitón> = 2.6
  • boto

Parámetros

Parámetro Opciones / Valores predeterminados Comentarios
alarmas_accioneslista / elementos =string Una lista de las acciones de nombres tomadas cuando la alarma está en el alarm estado, indicado como nombres de recursos de Amazon.
aws_access_keystring Clave de acceso de AWS. Si no se establece, se utiliza el valor de la variable de entorno AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY o EC2_ACCESS_KEY. perfil se establece este parámetro se ignora. aws_access_key y perfil options al mismo tiempo ha quedado obsoleto y las opciones se harán mutuamente excluyentes después del 2022-06-01.
alias: ec2_access_key, access_key
aws_ca_bundlesendero La ubicación de un paquete de CA para usar al validar certificados SSL. Solo se usa para módulos basados ​​en boto3. Nota: El paquete de CA se lee en el lado del ‘módulo’ y es posible que deba copiarse explícitamente del controlador si no se ejecuta localmente.
aws_configdiccionario Un diccionario para modificar la configuración de botocore. Los parámetros se pueden encontrar en https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.ConfigSolo se utiliza la clave ‘user_agent’ para los módulos boto. Ver http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto para más configuración de boto.
aws_secret_keystring Clave secreta de AWS. Si no se establece, se utiliza el valor de la variable de entorno AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY o EC2_SECRET_KEY. perfil se establece este parámetro se ignora. aws_secret_key y perfil options al mismo tiempo ha quedado obsoleto y las opciones se harán mutuamente excluyentes después del 2022-06-01.
alias: ec2_secret_key, secret_key
comparaciónstring
    Opciones:

  • GreaterThanOrEqualToThreshold
  • Mayor que el umbral
  • LessThanThreshold
  • LessThanOrEqualToThreshold
  • <=
  • <
  • > =
  • >
 Determina cómo se compara el valor de umbral Los operadores de comparación simbólica han quedado obsoletos y se eliminarán después del 22 de junio de 2022.
debug_botocore_endpoint_logsbooleano
    Opciones:

  • no ←
  • sí
 Utilice un registrador botocore.endpoint para analizar las llamadas API “resource: action” únicas (en lugar de totales) realizadas durante una tarea, generando el conjunto en la clave resource_actions en los resultados de la tarea. Utilice la devolución de llamada aws_resource_action para generar la lista total realizada durante un libro de jugadas. También se puede utilizar la variable de entorno ANSIBLE_DEBUG_BOTOCORE_LOGS.
descripciónstring Una descripción más larga de la alarma.
dimensionesdiccionario Un diccionario que describe a qué métrica se aplica la alarma. Para obtener más información, consulte la documentación de AWS:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension
ec2_urlstring Url que se utilizará para conectarse a EC2 o su nube Eucalyptus (de forma predeterminada, el módulo utilizará puntos finales EC2). Ignorado para módulos donde se requiere región. Debe especificarse para todos los demás módulos si no se utiliza la región. Si no se establece, se utiliza el valor de la variable de entorno EC2_URL, si existe.
alias: aws_endpoint_url, endpoint_url
periodos_de_evaluaciónentero El número de veces que se evalúa la métrica antes del cálculo final.
acciones_de_datos_ insuficienteslista / elementos =string Una lista de los nombres de las acciones que se deben realizar cuando la alarma insufficient_data estado.
métricostring Nombre de la métrica monitoreada (p. Ej. CPUUtilization) .La métrica ya debe existir.
nombrestring / requerido Nombre único de la alarma.
espacio de nombresstring Nombre del espacio de nombres apropiado (AWS/EC2, System/Linux, etc.), que determina la categoría bajo la que aparecerá en Cloudwatch.
ok_actionslista / elementos =string Una lista de los nombres de las acciones a realizar cuando la alarma está en ok estado, indicado como nombres de recursos de Amazon.
períodoentero El tiempo (en segundos) entre evaluaciones métricas.
perfilstring Utiliza un perfil de boto. Solo funciona con boto> = 2.24.0. perfil anulará aws_access_key, aws_secret_key y token de seguridad y apoyo para pasarlos al mismo tiempo que perfil ha quedado obsoleto.aws_access_key, aws_secret_key y token de seguridad se hará mutuamente excluyente con perfil después de 2022-06-01.
alias: aws_profile
regiónstring La región de AWS que se utilizará. Si no se especifica, se utiliza el valor de la variable de entorno AWS_REGION o EC2_REGION, si corresponde. Ver http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
alias: aws_region, ec2_region
token de seguridadstring Token de seguridad de AWS STS. Si no se establece, se utiliza el valor de la variable de entorno AWS_SECURITY_TOKEN o EC2_SECURITY_TOKEN. perfil se establece este parámetro se ignora. token de seguridad y perfil options al mismo tiempo ha quedado obsoleto y las opciones se harán mutuamente excluyentes después del 2022-06-01.
alias: aws_security_token, access_token
estadostring
    Opciones:

  • regalo ←
  • ausente
 Registre o cancele el registro de la alarma.
estadísticastring
    Opciones:

  • SampleCount
  • Promedio
  • Suma
  • Mínimo
  • Máximo
 Operación aplicada a la métrica Funciona junto con período y periodos_de_evaluación para determinar el valor de comparación.
umbralflotador Establece el límite mínimo / máximo para activar la alarma.
treat_missing_datastring
    Opciones:

  • violar
  • no violar
  • ignorar
  • desaparecido ←
 Establece cómo gestiona la alarma los puntos de datos faltantes.
unidadstring
    Opciones:

  • Segundos
  • Microsegundos
  • Milisegundos
  • Bytes
  • Kilobytes
  • Megabytes
  • Gigabytes
  • Terabytes
  • Bits
  • Kilobits
  • Megabits
  • Gigabits
  • Terabits
  • Por ciento
  • Contar
  • Bytes / segundo
  • Kilobytes / segundo
  • Megabytes / segundo
  • Gigabytes / segundo
  • Terabytes / segundo
  • Bits / segundo
  • Kilobits / segundo
  • Megabits / segundo
  • Gigabits / segundo
  • Terabits / segundo
  • Cuenta / segundo
  • Ninguno
 La unidad de medida del umbral.
validate_certsbooleano
    Opciones:

  • no
  • sí ←
 Cuando se establece en “no”, los certificados SSL no se validarán para las versiones de boto> = 2.6.0.

Notas

Nota

  • Si los parámetros no se establecen dentro del módulo, las siguientes variables de entorno se pueden usar en orden decreciente de precedencia AWS_URL o EC2_URL, AWS_PROFILE o AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID o AWS_ACCESS_KEY o EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY o AWS_SECRET_KEY o EC2_SECRET_KEY, AWS_SECURITY_TOKEN o EC2_SECURITY_TOKEN, AWS_REGION o EC2_REGION, AWS_CA_BUNDLE
  • Ansible usa el archivo de configuración boto (típicamente ~ / .boto) si no se proporcionan credenciales. Ver https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION o EC2_REGION se puede usar normalmente para especificar la región de AWS, cuando sea necesario, pero esto también se puede configurar en el archivo de configuración boto

Ejemplos de

-name: create alarm
  community.aws.ec2_metric_alarm:state: present
    region: ap-southeast-2name:"cpu-low"metric:"CPUUtilization"namespace:"AWS/EC2"statistic: Average
    comparison:"LessThanOrEqualToThreshold"threshold:5.0period:300evaluation_periods:3unit:"Percent"description:"This will alarm when a bamboo slave's cpu usage average is lower than 5% for 15 minutes "dimensions:'InstanceId':'i-XXX'alarm_actions:["action1","action2"]-name: Create an alarm to recover a failed instance
  community.aws.ec2_metric_alarm:state: present
    region: us-west-1name:"recover-instance"metric:"StatusCheckFailed_System"namespace:"AWS/EC2"statistic:"Minimum"comparison:">="threshold:1.0period:60evaluation_periods:2unit:"Count"description:"This will recover an instance when it fails"dimensions:"InstanceId":'i-XXX'alarm_actions:["arn:aws:automate:us-west-1:ec2:recover"]

Autores

  • Zacharie Eakin (@Zeekin)