View a markdown version of this page

AWSSupport-TroubleshootOpenSearchHighCPU - AWS Systems Manager Referencia del manual de procedimientos de Automatización

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AWSSupport-TroubleshootOpenSearchHighCPU

Descripción

El AWSSupport-TroubleshootOpenSearchHighCPU manual proporciona una solución automatizada para recopilar datos de diagnóstico de un dominio de Amazon OpenSearch Service con el fin de solucionar problemas de uso excesivo de la CPU.

¿Cómo funciona?

El AWSSupport-TroubleshootOpenSearchHighCPU manual ayuda a solucionar problemas de uso excesivo de la CPU en el dominio de Amazon Service. OpenSearch

El runbook lleva a cabo los siguientes pasos:

  • Ejecuta la DescribeDomain API en el dominio de Amazon OpenSearch Service proporcionado para obtener los metadatos del clúster.

  • Comprueba si el dominio de Amazon OpenSearch Service es público o de Amazon VPC-based y, con la ayuda de CloudFormation, crea una VPC-based AWS Lambda función pública o de Amazon.

  • La función Lambda obtiene datos de diagnóstico de los dominios de Amazon OpenSearch Service.

  • Utiliza una máquina de AWS Step Functions estados para organizar varias ejecuciones de funciones de Lambda a fin de recopilar datos más completos.

  • De forma predeterminada, almacena los datos recopilados en un grupo de CloudWatch registros de Amazon durante 24 horas.

  • Elimina los recursos creados, excepto el grupo de CloudWatch registros.

Tipo de documento

Automatización

Propietario

Amazon

Plataformas

Linux, macOS, Windows

Parámetros

Permisos de IAM necesarios

El parámetro AutomationAssumeRole requiere las siguientes acciones para utilizar el manual de procedimientos correctamente.

  • cloudformation:CreateStack

  • cloudformation:CreateStack

  • cloudformation:DescribeStacks

  • cloudformation:DescribeStackEvents

  • cloudformation:DeleteStack

  • lambda:CreateFunction

  • lambda:DeleteFunction

  • lambda:InvokeFunction

  • lambda:GetFunction

  • lambda:TagResource

  • es:DescribeDomain

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

  • ec2:DescribeInstances

  • ec2:AttachNetworkInterface

  • ec2:DeleteNetworkInterface

  • logs:CreateLogGroup

  • logs:PutRetentionPolicy

  • logs:TagResource

  • states:CreateStateMachine

  • states:DeleteStateMachine

  • states:StartExecution

  • states:TagResource

  • states:DescribeStateMachine

  • states:DescribeExecution

  • iam:PassRole

  • iam:CreateRole

  • iam:DeleteRole

  • iam:GetRole

  • iam:PutRolePolicy

  • iam:DeleteRolePolicy

  • ssm:DescribeAutomationExecutions

  • ssm:GetAutomationExecution

nota

Losiam:CreateRole, iam:DeleteRole iam:GetRole iam:PutRolePolicyiam:PutRolePolicy, y solo iam:DeleteRolePolicy son necesarios si no está utilizando un rol de IAM existente como parámetro LambdaInvocationRoleForStepFunctions

El LambdaExecutionRole parámetro requiere las siguientes acciones para utilizar correctamente el runbook:

  • es:ESHttpGet

  • ec2:CreateNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DeleteNetworkInterface

  • logs:CreateLogStream

  • logs:PutLogEvents

La función de ejecución de Lambda concede a la función permiso para acceder a AWS los servicios y recursos que requiere este libro de ejecución. Para obtener más información, consulte Rol de ejecución de Lambda.

nota

Solo ec2:DeleteNetworkInterface son necesarios si su clúster de OpenSearch servicios es Amazon VPC-based para permitir que la función Lambda cree y administre las interfaces de red de Amazon VPC. ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface Para obtener más información, consulte Conectar las redes salientes a los recursos en una función de ejecución de Amazon VPC y Lambda.

El LambdaInvocationRoleForStepFunctions parámetro otorga los permisos para que la máquina de AWS Step Functions estado invoque la función Lambda. El siguiente es un ejemplo de política de IAM que concede a Step Functions permiso para invocar la función Lambda que obtiene los datos de diagnóstico del dominio de servicio. OpenSearch Para obtener más información, consulta Cómo crear un rol de IAM en una máquina de estados en la Guía para desarrolladores. AWS Step Functions

JSON
{
    "Version":"2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "lambda:InvokeFunction",
            "Resource": [
                "arn:aws:lambda:us-east-1:111122223333:function:AWSSupport-HighCPU-*"
            ]
        }
    ]
}

Instrucciones

Siga estos pasos para configurar la automatización:

  1. Navegue hasta AWSSupport-TroubleshootOpenSearchHighCPU la AWS Systems Manager consola.

  2. Elija Execute automation (Ejecutar automatización).

  3. Para los parámetros de entrada, introduzca lo siguiente:

    • AutomationAssumeRole (Opcional):

      El nombre de recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que permite a Systems Manager Automation realizar las acciones en su nombre. Si no se especifica ningún rol, Systems Manager Automation utiliza los permisos del usuario que comienza este manual de procedimientos.

    • DomainName (Obligatorio):

      El nombre del dominio de Amazon OpenSearch Service que quieres solucionar por problemas de alto consumo de CPU.

    • LambdaExecutionRoleForOpenSearch(Obligatorio):

      El ARN del rol de IAM que se va a adjuntar a la función Lambda. La función Lambda usa las credenciales de este rol para firmar las solicitudes en el dominio de Amazon Service. OpenSearch Si el control de acceso detallado está habilitado en el dominio de Amazon OpenSearch Service, debes asignar este rol a un rol de backend de OpenSearch Service Dashboards con un permiso mínimo de «cluster_monitor».

    • LambdaInvocationRoleForStepFunctions(Opcional):

      (Opcional) El ARN del rol de IAM que se va a adjuntar al flujo de trabajo de Step Functions. La máquina de estado usa las credenciales de este rol para invocar la función Lambda que obtiene los datos de diagnóstico del dominio de servicio. OpenSearch Si no se especifica ningún rol, esta automatización creará un rol de IAM para Step Functions en su cuenta.

    • DataRetentionDays (Opcional):

      El número de días para conservar los datos de diagnóstico recopilados del dominio de Amazon OpenSearch Service. De forma predeterminada, los datos se conservan durante 24 horas (un día). Puede optar por conservar los datos durante un máximo de 30 días.

    • NumberOfDataSamples (Opcional):

      El número de muestras de datos que se van a recopilar del dominio OpenSearch de Amazon Service. De forma predeterminada, se recopilan 5 muestras de datos. Puede recopilar hasta 10 muestras y la función Lambda se invocará para cada recopilación de muestras.

  4. Si ha habilitado un control de acceso detallado en un clúster de OpenSearch servicios, asegúrese de que el LambdaExecutionRole rol arn esté asignado a un rol con al menos permiso. cluster_monitor

    La pestaña de permisos muestra la sección de Clúster permisos con el permiso cluster_monitor seleccionado.
    La sección de roles de backend muestra un ARN de rol de Lambda ejecución con el botón Eliminar y la opción de mapa.

  5. Seleccione Ejecutar.

  6. Se inicia la automatización.

  7. El manual de procedimientos de automatización realiza los siguientes pasos:

    • Compruebe la simultaneidad:

      Garantiza que solo haya una ejecución de este manual dirigida al dominio de Amazon OpenSearch Service especificado. Si el runbook encuentra otra ejecución dirigida al mismo nombre de dominio, devuelve un error y finaliza.

    • obtenerDomainConfig:

      Obtiene los detalles de configuración del dominio de OpenSearch servicio de destino.

    • Recursos de aprovisionamiento:

      Aprovisiona los recursos para la recopilación de datos mediante CloudFormation.

    • esperaForStackCreation:

      Espera a que se complete la CloudFormation pila.

    • describeStackResources:

      Describe la CloudFormation pila y obtiene el ARN de la máquina de estados.

    • ejecutarStateMachine:

      Invoca la función Lambda del recopilador de datos una o más veces mediante la ejecución de una máquina de estados de Step Functions.

    • describe: ErrorsFromStackEvents

      Describe los errores de la CloudFormation pila en busca de errores.

    • desmontarOpenSearchHighCPUAutomation:

      Elimina la pila. AWSSupport-TroubleshootOpenSearchHighCPU CloudFormation

    • describeErrorsFromStackDeletion:

      Describe los errores encontrados al eliminar la CloudFormation pila.

    • Estado final:

      Devuelve el resultado final del libro de ejercicios. AWSSupport-TroubleshootOpenSearchHighCPU

  8. Una vez finalizada, consulte la sección de resultados para ver los resultados detallados de la ejecución.

    • finalStatus.FinalOutput:

      Proporciona el grupo de CloudWatch registros en el que se almacenan los datos de diagnóstico.

    La sección de resultados muestra la final Status.FinalOutput con el mensaje de finalización de la recopilación de datos del subproceso actual y la referencia al grupo de CloudWatch registros.

Referencias

Automatización de Systems Manager

AWS documentación de servicio