AWSSupport-TroubleshootOpenSearchHighCPU - AWS Systems Manager Guide de référence du manuel d'automatisation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWSSupport-TroubleshootOpenSearchHighCPU

Description

Le AWSSupport-TroubleshootOpenSearchHighCPU runbook fournit une solution automatisée pour collecter des données de diagnostic à partir d'un domaine Amazon OpenSearch Service afin de résoudre les problèmes les plus courants. CPU

Comment fonctionne-t-il ?

Le AWSSupport-TroubleshootOpenSearchHighCPU runbook permet de résoudre les problèmes d'CPUutilisation élevée dans le domaine Amazon OpenSearch Service.

Le runbook exécute les étapes suivantes :

  • Exécute DescribeDomainAPIle sur le domaine Amazon OpenSearch Service fourni pour obtenir les métadonnées du cluster.

  • Vérifie si le domaine Amazon OpenSearch Service est public ou VPC basé sur Amazon et, à l'aide de AWS CloudFormation, crée une AWS Lambda fonction publique ou VPCbasée sur Amazon.

  • La fonction Lambda récupère les données de diagnostic depuis les domaines Amazon OpenSearch Service.

  • Utilise une machine à AWS Step Functions états pour orchestrer plusieurs exécutions de fonctions Lambda afin de recueillir des données plus complètes.

  • Stocke les données collectées dans un groupe de CloudWatch journaux Amazon pendant 24 heures par défaut.

  • Supprime les ressources créées, à l'exception du groupe de CloudWatch journaux.

Type de document

 Automatisation

Propriétaire

Amazon

Plateformes

LinuxmacOS, Windows

Paramètres

IAMAutorisations requises

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook.

  • 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

Le LambdaExecutionRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook :

  • es:ESHttpGet

  • ec2:CreateNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DeleteNetworkInterface

  • logs:CreateLogStream

  • logs:PutLogEvents

Le rôle d'exécution Lambda accorde à la fonction l'autorisation d'accéder aux AWS services et aux ressources requis par ce runbook. Pour plus d’informations, consultez Rôle d’exécution Lambda.

Note

Les ec2:DescribeNetworkInterfacesec2:CreateNetworkInterface, et ne ec2:DeleteNetworkInterface sont nécessaires que si votre cluster de OpenSearch services est VPCbasé sur Amazon pour permettre à la fonction Lambda de créer et de gérer les interfaces VPC réseau Amazon. Pour plus d'informations, consultez Connecter le réseau sortant aux ressources dans un rôle d'exécution Amazon VPC et Lambda.

Instructions

Pour configurer l'automatisation, procédez comme suit :

  1. Accédez au AWSSupport- TroubleshootOpenSearchHigh CPU dans la AWS Systems Manager console.

  2. Sélectionnez Execute automation (Exécuter l'automatisation).

  3. Pour les paramètres d'entrée, entrez ce qui suit :

    • AutomationAssumeRole (Facultatif) :

      Le nom de ressource Amazon (ARN) du rôle AWS Identity and Access Management (IAM) qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui lance ce runbook.

    • DomainName (Obligatoire) :

      Le nom du domaine Amazon OpenSearch Service que vous souhaitez résoudre en cas de CPU problème majeur.

    • LambdaExecutionRoleForOpenSearch(Obligatoire) :

      Le ARN IAM rôle à associer à la fonction Lambda. La fonction Lambda utilise les informations d'identification de ce rôle pour signer les demandes adressées au domaine Amazon OpenSearch Service. Si le contrôle d'accès détaillé est activé sur le domaine Amazon OpenSearch Service, vous devez associer ce rôle à un rôle principal de OpenSearch Service Dashboards avec une autorisation minimale de « cluster_monitor ».

    • DataRetentionDays (Facultatif) :

      Le nombre de jours pendant lesquels les données de diagnostic collectées à partir du domaine Amazon OpenSearch Service sont conservées. Par défaut, les données sont conservées pendant 24 heures (un jour). Vous pouvez choisir de conserver les données pendant une durée maximale de 30 jours.

    • NumberOfDataSamples (Facultatif) :

      Le nombre d'échantillons de données à collecter à partir du domaine Amazon OpenSearch Service. Par défaut, 5 échantillons de données sont collectés. Vous pouvez collecter jusqu'à 10 échantillons et la fonction Lambda sera invoquée pour chaque collecte d'échantillons.

    Input parameters form for AWS Systems Manager Automation with fields for roles and settings.

  4. Si vous avez activé le contrôle d'accès détaillé sur un cluster de OpenSearch services, assurez-vous que l'ARN du LambdaExecutionRole rôle est mappé à un rôle disposant d'au moins une autorisation. cluster_monitor

    Cluster permissions section showing cluster_monitor permission granted.
    Backend roles interface showing an AWSIAM role for Lambda execution and options to remove or add roles.

  5. Sélectionnez Exécuter.

  6. L'automatisation démarre.

  7. Le runbook d'automatisation exécute les étapes suivantes :

    • checkConcurrency:

      Garantit qu'il n'y a qu'une seule exécution de ce runbook ciblant le domaine Amazon OpenSearch Service spécifié. Si le runbook trouve une autre exécution ciblant le même nom de domaine, il renvoie une erreur et se termine.

    • getDomainConfig:

      Obtient les détails de configuration pour le domaine OpenSearch de service cible.

    • provisionResources:

      Fournit les ressources nécessaires à la collecte de données à l'aide de AWS CloudFormation.

    • waitForStackCréation :

      Attend que la AWS CloudFormation pile soit terminée.

    • describeStackResources:

      Décrit la AWS CloudFormation pile et obtient le nom ARN de la machine à états.

    • runStateMachine:

      Invoque la fonction Lambda du collecteur de données une ou plusieurs fois en exécutant une machine d'état Step Functions.

    • describeErrorsFromStackEvents:

      Décrit les erreurs provenant de la AWS CloudFormation pile pour détecter les erreurs.

    • unstageOpenSearchH ighCPUAutomation :

      Supprime la AWSSupport-TroubleshootOpenSearchHighCPU AWS CloudFormation pile.

    • describeErrorsFromStackDeletion:

      Décrit les erreurs rencontrées lors de la suppression de la AWS CloudFormation pile.

    • finalStatus:

      Renvoie le résultat final du AWSSupport-TroubleshootOpenSearchHighCPU runbook.

  8. Une fois terminé, consultez la section Sorties pour connaître les résultats détaillés de l'exécution.

    • finalStatus.FinalOutput:

      Fournit le groupe de CloudWatch journaux dans lequel les données de diagnostic sont stockées.

    Output message indicating hot thread data collection completed with log group details.

Références

Systems Manager Automation

AWS documentation de service