View a markdown version of this page

AWSSupport-TroubleshootOpenSearchHighCPU - AWS Systems Manager Runbook-Referenz für Automation

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWSSupport-TroubleshootOpenSearchHighCPU

Beschreibung

Das AWSSupport-TroubleshootOpenSearchHighCPU Runbook bietet eine automatisierte Lösung zur Erfassung von Diagnosedaten aus einer Amazon OpenSearch Service-Domain, um Probleme mit hoher CPU-Auslastung zu beheben.

Wie funktioniert es?

Das AWSSupport-TroubleshootOpenSearchHighCPU Runbook hilft bei der Behebung einer hohen CPU-Auslastung in der Amazon OpenSearch Service-Domain.

Das Runbook führt die folgenden Schritte aus:

  • Führt die DescribeDomain API für die bereitgestellte Amazon OpenSearch Service-Domain aus, um die Cluster-Metadaten abzurufen.

  • Überprüft, ob die Amazon OpenSearch Service-Domain öffentlich oder Amazon ist VPC-based und erstellt mithilfe von CloudFormation eine öffentliche oder VPC-based AWS Lambda Amazon-Funktion.

  • Die Lambda-Funktion ruft Diagnosedaten aus den Amazon OpenSearch Service-Domänen ab.

  • Verwendet eine AWS Step Functions Zustandsmaschine, um mehrere Lambda-Funktionsausführungen zu orchestrieren und umfassendere Daten zu sammeln.

  • Speichert die gesammelten Daten standardmäßig für 24 Stunden in einer CloudWatch Amazon-Protokollgruppe.

  • Löscht die erstellten Ressourcen mit Ausnahme der CloudWatch Protokollgruppe.

Typ des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

LinuxmacOS, Windows

Parameter

Erforderliche IAM-Berechtigungen

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden.

  • 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

Anmerkung

Die iam:CreateRole Werteiam:DeleteRole, iam:GetRole iam:PutRolePolicyiam:PutRolePolicy, und iam:DeleteRolePolicy sind nur erforderlich, wenn Sie keine vorhandene IAM-Rolle für den Parameter verwenden LambdaInvocationRoleForStepFunctions

Für den LambdaExecutionRole Parameter sind die folgenden Aktionen erforderlich, um das Runbook erfolgreich zu verwenden:

  • es:ESHttpGet

  • ec2:CreateNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DeleteNetworkInterface

  • logs:CreateLogStream

  • logs:PutLogEvents

Die Lambda-Ausführungsrolle gewährt der Funktion die Berechtigung, auf AWS Dienste und Ressourcen zuzugreifen, die für dieses Runbook erforderlich sind. Weitere Informationen finden Sie unter Lambda-Ausführungsrolle.

Anmerkung

Die ec2:DescribeNetworkInterfacesec2:CreateNetworkInterface, und ec2:DeleteNetworkInterface sind nur erforderlich, wenn es sich bei Ihrem OpenSearch Service-Cluster VPC-based um Amazon handelt, damit die Lambda-Funktion die Amazon VPC-Netzwerkschnittstellen erstellen und verwalten kann. Weitere Informationen finden Sie unter Ausgehendes Netzwerk mit Ressourcen in einer Amazon VPC - und Lambda-Ausführungsrolle verbinden.

Der LambdaInvocationRoleForStepFunctions Parameter gewährt der AWS Step Functions Zustandsmaschine die Berechtigungen, die Lambda-Funktion aufzurufen. Im Folgenden finden Sie ein Beispiel für eine IAM-Richtlinie, die Step Functions die Erlaubnis erteilt, die Lambda-Funktion aufzurufen, die Diagnosedaten aus der Service-Domäne abruft. OpenSearch Weitere Informationen finden Sie im Entwicklerhandbuch unter Erstellen einer State-Machine-IAM-Rolle. 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-*"
            ]
        }
    ]
}

Anweisungen

Folgen Sie diesen Schritten, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie AWSSupport-TroubleshootOpenSearchHighCPU in der AWS Systems Manager Konsole zu.

  2. Wählen Sie Execute automation (Automatisierung ausführen).

  3. Geben Sie für die Eingabeparameter Folgendes ein:

    • AutomationAssumeRole (Fakultativ):

      Der Amazon-Ressourcenname (ARN) der AWS Identity and Access Management (IAM) -Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen durchzuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

    • DomainName (Erforderlich):

      Der Name der Amazon OpenSearch Service-Domain, für die Sie Probleme mit hoher CPU-Auslastung beheben möchten.

    • LambdaExecutionRoleForOpenSearch(Erforderlich):

      Der ARN der IAM-Rolle, die an die Lambda-Funktion angehängt werden soll. Die Lambda-Funktion verwendet die Anmeldeinformationen dieser Rolle, um Anfragen an die Amazon OpenSearch Service-Domain zu signieren. Wenn die fein abgestufte Zugriffskontrolle auf der Amazon OpenSearch Service-Domain aktiviert ist, müssen Sie diese Rolle einer OpenSearch Service Dashboards-Backend-Rolle mit mindestens der Berechtigung „cluster_monitor“ zuordnen.

    • LambdaInvocationRoleForStepFunctions(Fakultativ):

      (Optional) Der ARN der IAM-Rolle, die an den Step Functions-Workflow angehängt werden soll. Der State Machine verwendet die Anmeldeinformationen dieser Rolle, um die Lambda-Funktion aufzurufen, die Diagnosedaten aus der Service-Domäne abruft. OpenSearch Wenn keine Rolle angegeben ist, erstellt diese Automatisierung eine IAM-Rolle für Step Functions in Ihrem Konto.

    • DataRetentionDays (Fakultativ):

      Die Anzahl der Tage, für die die von der Amazon OpenSearch Service-Domain gesammelten Diagnosedaten aufbewahrt werden. Standardmäßig werden die Daten für 24 Stunden (einen Tag) aufbewahrt. Sie können wählen, ob die Daten maximal bis zu 30 Tage aufbewahrt werden sollen.

    • NumberOfDataSamples (Fakultativ):

      Die Anzahl der Datenproben, die aus der Amazon OpenSearch Service-Domain erfasst werden sollen. Standardmäßig werden 5 Datenproben gesammelt. Sie können bis zu 10 Proben sammeln und die Lambda-Funktion wird für jede Probenentnahme aufgerufen.

  4. Wenn Sie die feinkörnige Zugriffskontrolle auf einem OpenSearch Service-Cluster aktiviert haben, stellen Sie sicher, dass die LambdaExecutionRole Rolle arn einer Rolle zugeordnet ist, die mindestens über Berechtigungen verfügt. cluster_monitor

    Registerkarte „Berechtigungen“ mit dem Abschnitt „ Cluster Berechtigungen“, für den die Cluster_Monitor-Berechtigung ausgewählt ist.
    Abschnitt „Backend-Rollen“ mit einem ARN für die Lambda Ausführungsrolle mit der Schaltfläche „Entfernen“ und der Option „Zuordnen“.

  5. Wählen Sie Ausführen aus.

  6. Die Automatisierung wird initiiert.

  7. Das Automatisierungs-Runbook führt die folgenden Schritte aus:

    • Überprüfen Sie die Parallelität:

      Stellt sicher, dass dieses Runbook nur einmal ausgeführt wird, das auf die angegebene Amazon OpenSearch Service-Domain abzielt. Wenn das Runbook eine weitere Ausführung findet, die auf denselben Domainnamen abzielt, gibt es einen Fehler zurück und wird beendet.

    • erhalteDomainConfig:

      Ruft die Konfigurationsdetails für die OpenSearch Ziel-Servicedomäne ab.

    • Ressourcen bereitstellen:

      Stellt die Ressourcen für die Datenerfassung mithilfe von bereit. CloudFormation

    • warteForStackCreation:

      Wartet darauf, dass der CloudFormation Stapel abgeschlossen ist.

    • beschreibeStackResources:

      Beschreibt den CloudFormation Stack und ruft den ARN der Zustandsmaschine ab.

    • ausführenStateMachine:

      Ruft die Lambda-Funktion des Datensammlers ein- oder mehrmals auf, indem eine Step Functions-Zustandsmaschine ausgeführt wird.

    • beschreiben Sie: ErrorsFromStackEvents

      Beschreibt Fehler aus dem CloudFormation Stack für Fehler.

    • noch im GangeOpenSearchHighCPUAutomation:

      Löscht den Stapel AWSSupport-TroubleshootOpenSearchHighCPU CloudFormation .

    • beschreibeErrorsFromStackDeletion:

      Beschreibt Fehler, die beim Löschen des CloudFormation Stapels aufgetreten sind.

    • Endgültiger Status:

      Gibt die endgültige Ausgabe des Runbooks zurück. AWSSupport-TroubleshootOpenSearchHighCPU

  8. Wenn Sie fertig sind, finden Sie im Abschnitt Ausgaben die detaillierten Ergebnisse der Ausführung.

    • endgültigStatus.FinalOutput:

      Stellt die CloudWatch Protokollgruppe bereit, in der die Diagnosedaten gespeichert sind.

    Gibt den letzten Abschnitt Status.FinalOutput mit einer Meldung über den Abschluss der Hot-Thread-Datenerfassung und einer Referenz zur CloudWatch Protokollgruppe aus.

Referenzen

Systems Manager Automation

AWS Dokumentation zum Service