View a markdown version of this page

AWSSupport-TroubleshootCloudWatchAgent - AWS Systems Manager Riferimento al runbook dell’automazione

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

AWSSupport-TroubleshootCloudWatchAgent

Descrizione

Il AWSSupport-TroubleshootCloudWatchAgent runbook automatizza la risoluzione dei problemi di Amazon CloudWatch Agent sulle tue istanze Amazon Elastic Compute Cloud (Amazon EC2). Il runbook esegue questa risoluzione dei problemi attraverso una serie di controlli di base e (opzionali) estesi.

I controlli di base includono quanto segue:

  • Verifica la presenza di un profilo di istanza AWS Identity and Access Management (IAM)

  • Verifica se le autorizzazioni IAM di Amazon CloudWatch Agent necessarie sono associate all'istanza Amazon EC2

I controlli estesi vengono eseguiti solo se l'ID dell'istanza Amazon EC2 fornito è un'istanza gestita da Systems Manager. Questi controlli estesi includono quanto segue:

  • Verifica lo stato dell'Amazon CloudWatch Agent sull'istanza

  • Analizza i log di Amazon CloudWatch Agent per individuare i problemi più comuni e le relative fasi di risoluzione

  • Comprimi i log e i file di configurazione pertinenti sull'istanza Amazon EC2 e, facoltativamente, caricali in un bucket Amazon Simple Storage Service (Amazon S3) a tua scelta

  • Esegui un controllo di connettività tra l'istanza e gli endpoint richiesti

Importante

Quando il RunVpcReachabilityAnalyzer parametro è impostato sutrue, questo runbook determinerà se è necessario chiamare il runbook figlio,. AWSSupport-AnalyzeAWSEndpointReachabilityFromEC2 Il runbook secondario utilizza VPC Reachability Analyzer che ha un costo associato. Per ulteriori informazioni sui prezzi, consulta la documentazione sui prezzi di Amazon VPC.

Importante

Questo runbook verifica solo il ruolo del profilo dell'istanza IAM per le autorizzazioni necessarie. Se invece ti affidi alle credenziali definite in un .aws/credentials file, i risultati del verifyIamPermissions passaggio potrebbero essere imprecisi.

Come funziona?

Il runbook esegue i seguenti passaggi:

  • get InstanceProfile: verifica se all'istanza Amazon EC2 fornita è associato un profilo di istanza IAM.

  • verifica IamPermissions: controlla il profilo dell'istanza associato all'istanza per determinare se vengono applicate le autorizzazioni IAM necessarie.

  • get InstanceInformation: controlla se l'istanza ha un agente Systems Manager attivo e recupera il tipo di sistema operativo dell'istanza.

  • get AgentStatus: verifica lo stato dell'Amazon CloudWatch Agent sull'istanza (controllo esteso).

  • analyzeLogs/analyzeLogsWindows: analizza e restituisce i risultati dei log di Amazon CloudWatch Agent in base al tipo di sistema operativo.

  • collectLogs/collectLogsWindows: raggruppa ed emette i file pertinenti per la risoluzione dei problemi di Amazon CloudWatch Agent in base al tipo di sistema operativo.

  • checkEndpointReachability/checkEndpointReachabilityWindows: controlla se l'istanza può raggiungere gli endpoint richiesti in base al tipo di sistema operativo.

  • analyze AwsEndpointReachabilityFromEC2: chiama il runbook di automazione secondario per verificare la raggiungibilità dell'istanza selezionata agli endpoint richiesti (se abilitata).

Esegui questa automazione (console)

Tipo di documento

Automazione

Proprietario

Amazon

Piattaforme

/

Autorizzazioni IAM richieste

Il AutomationAssumeRole parametro richiede le seguenti azioni per utilizzare correttamente il runbook.

  • ec2: DescribeInstances

  • sono: GetInstanceProfile

  • sono: GetRole

  • sono: ListAttachedRolePolicies

  • sono: ListRolePolicies

  • sono: GetRolePolicy

  • sono: GetPolicy

  • sono: GetPolicyVersion

  • sono: SimulatePrincipalPolicy

  • sms: DescribeInstanceInformation

  • sms: SendCommand

  • sms: GetCommandInvocation

  • sms: DescribeInstanceAssociationsStatus

  • sms: StartAutomationExecution

Esempio di politica: 

{
        "Version": "2012-10-17",
        "Statement": [
            {
            "Effect": "Allow",
            "Action": [
                "ec2:DescribeInstances",
                "iam:GetInstanceProfile",
                "iam:GetRole",
                "iam:ListAttachedRolePolicies",
                "iam:ListRolePolicies",
                "iam:GetRolePolicy",
                "iam:GetPolicy",
                "iam:GetPolicyVersion",
                "iam:SimulatePrincipalPolicy",
                "ssm:DescribeInstanceInformation",
                "ssm:SendCommand",
                "ssm:GetCommandInvocation",
                "ssm:DescribeInstanceAssociationsStatus",
                "ssm:StartAutomationExecution"
            ],
            "Resource": "*"
            }
        ]
        }

Istruzioni

Segui questi passaggi per configurare l'automazione:

  1. Accedi AWSSupport-TroubleshootCloudWatchAgent a Systems Manager in Documenti.

  2. Seleziona Execute automation (Esegui automazione).

  3. Per i parametri di input, inserisci quanto segue:

    • AutomationAssumeRole (Facoltativo):

      • Descrizione: (Facoltativo) L'ARN del ruolo IAM che consente a Systems Manager Automation di eseguire le azioni per conto dell'utente. Se non viene specificato alcun ruolo, Systems Manager Automation utilizza le autorizzazioni dell'utente che avvia questo runbook.

      • Tipo: AWS::IAM::Role::Arn

    • InstanceId (Obbligatorio):

      • Descrizione: (Obbligatorio) L'ID dell'istanza Amazon EC2 su cui vuoi risolvere i problemi con Amazon CloudWatch Agent.

      • Tipo: AWS::EC2::Instance::Id

      • Pattern di autorizzazione: ^i-[0-9a-f]{8,17}$

    • S3UploadBucket (Facoltativo):

      • Descrizione: (Facoltativo) Il nome di un bucket Amazon S3 per caricare i log di Amazon CloudWatch Agent raccolti. Il profilo dell'istanza Amazon EC2 deve disporre delle autorizzazioni corrette per caricare i file in questo bucket. Ciò richiede inoltre che l'istanza Amazon EC2 di destinazione sia un'istanza gestita da Systems Manager.

      • Tipo: AWS::S3::Bucket::Name

      • Permetti modello: ^$|^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$

      • Impostazione predefinita: ""

    • S3BucketOwnerAccountId (Facoltativo):

      • Descrizione: (Facoltativo) Il numero di AWS account proprietario del bucket Amazon S3 in cui desideri caricare i log di Amazon CloudWatch Agent. Se non modifichi questo parametro, i runbook utilizzano l'ID dell' AWS account dell'utente o del ruolo in cui viene eseguita l'automazione.

      • Tipo: String

      • Permetti modello: ^\\{\\{ global:ACCOUNT_ID \\}\\}$|^[0-9]{12}$

      • Impostazione predefinita: {{ global:ACCOUNT_ID }}

    • CheckEC2Endpoint (opzionale):

      • Descrizione: (Facoltativo) Specifica true se la configurazione dell'agente utilizza l'opzione append_dimensions per aggiungere le dimensioni delle metriche di Amazon EC2 alle metriche raccolte dall'agente. Quando append_dimensions viene utilizzato, Amazon CloudWatch Agent richiede la connettività all'endpoint dell'API Amazon EC2, pertanto verranno eseguiti ulteriori test di connettività tramite i controlli estesi.

      • Tipo: String

      • Valori consentiti: [true, false]

      • Impostazione predefinita: false

    • RunVpcReachabilityAnalyzer (Facoltativo):

      • Descrizione: (Facoltativo) Specifica di true eseguire l'automazione AWSSupport-AnalyzeAWSEndpointReachabilityFromEC2 secondaria se un problema di rete è determinato dai controlli estesi o se l'ID dell'istanza specificato non è un'istanza gestita.

      • Tipo: Boolean

      • Impostazione predefinita: false

    • RetainVpcReachabilityAnalysis (Facoltativo):

      • Descrizione: (Facoltativo) Rilevante solo se lo RunVpcReachabilityAnalyzer ètrue. Specifica true di conservare il percorso di analisi della rete e le relative analisi create da VPC Reachability Analyzer. Per impostazione predefinita, tali risorse vengono eliminate dopo l'esito positivo dell'analisi.

      • Tipo: Boolean

      • Impostazione predefinita: false

  4. Seleziona Esegui.

  5. L'automazione viene avviata.

  6. Il documento esegue i seguenti passaggi:

    • ottieni InstanceProfile:

      Verifica se all'istanza Amazon EC2 fornita è associato un profilo di istanza IAM.

    • filiale: OnInstanceProfileStatus

      Suddivide l'automazione per verificare le autorizzazioni necessarie per il profilo dell'istanza se il profilo dell'istanza è collegato all'istanza.

    • verifica IamPermissions:

      Controlla il profilo dell'istanza associato all'istanza per determinare se vengono applicate le autorizzazioni IAM necessarie.

    • ottieni: InstanceInformation

      Verifica se l'istanza ha un agente Systems Manager attivo e recupera il tipo di sistema operativo dell'istanza.

    • filiale OnManagedInstance:

      Suddivide l'automazione per eseguire controlli estesi se l'istanza è gestita.

    • ottieni AgentStatus:

      Verifica lo stato dell'Amazon CloudWatch Agent sull'istanza.

    • filiale OnInstanceOsType:

      Suddivide l'automazione per eseguire un collection/analysis comando di registro specifico in base al sistema operativo.

    • analyzeLogs/analyzeLogsWindows:

      Analizza e restituisce i risultati dei log di Amazon CloudWatch Agent in base al tipo di sistema operativo.

    • collectLogs/collectLogsWindows:

      Raggruppa ed emette i file pertinenti per la risoluzione dei problemi di Amazon CloudWatch Agent in base al tipo di sistema operativo.

    • checkEndpointReachability/checkEndpointReachabilityWindows:

      Verifica se l'istanza può raggiungere gli endpoint richiesti in base al tipo di sistema operativo.

    • filiale OnRunVpcReachabilityAnalyzer:

      Distribuisce l'automazione per eseguire l'analisi della raggiungibilità del VPC, se abilitata e vengono rilevati problemi di rete.

    • Genera endpoint:

      Genera un endpoint da verificare in base agli errori di controllo estesi e al valore di. CheckEC2Endpoint

    • analizza: AwsEndpointReachabilityFromEC2

      Chiama il runbook di automazione, AWSSupport-AnalyzeAWSEndpointReachabilityFromEC2 per verificare la raggiungibilità dell'istanza selezionata agli endpoint richiesti.

    • Risultati dell'output:

      Emette i risultati delle fasi di esecuzione dell'automazione.

  7. Dopo il completamento, consulta la sezione Output per i risultati dettagliati dell'esecuzione.

Riferimenti

Systems Manager Automation