CloudWatch Esempi di Synthetics utilizzando AWS CLI - AWS Esempi di codice SDK
Azioni

Sono disponibili altri esempi AWS SDK nel repository AWS Doc SDK Examples. GitHub

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à.

CloudWatch Esempi di Synthetics utilizzando AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with CloudWatch Synthetics.

Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come utilizzareassociate-resource.

AWS CLI

Associare un canarino a un gruppo

L'associate-resourceesempio seguente associa un canarino a un gruppo denominato. demo_group

aws synthetics associate-resource \
    --group-identifier demo_group \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarecreate-canary.

AWS CLI

Per creare un canarino

L'create-canaryesempio seguente crea un canarino denominato. demo_canary

aws synthetics create-canary \
    --name demo_canary \
    --code '{"S3Bucket": "artifacts3bucket", "S3Key":"demo_canary.zip", "Handler": "index.lambda_handler"}' \
    --artifact-s3-location s3://amzn-s3-demo-bucket/demo_canary.zip \
    --execution-role-arn arn:aws:iam::123456789012:role/demo_canary_role \
    --schedule Expression="rate(10 minutes)" \
    --runtime-version syn-nodejs-puppeteer-9.1

Output:

{
    "Canary": {
        "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
        "Name": "demo_canary",
        "Code": {
            "Handler": "index.lambda_handler"
        },
        "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role",
        "Schedule": {
            "Expression": "rate(10 minutes)",
            "DurationInSeconds": 0
        },
        "RunConfig": {
            "TimeoutInSeconds": 600,
            "MemoryInMB": 1000,
            "ActiveTracing": false
        },
        "SuccessRetentionPeriodInDays": 31,
        "FailureRetentionPeriodInDays": 31,
        "Status": {
            "State": "CREATING",
            "StateReasonCode": "CREATE_PENDING"
        },
        "Timeline": {
            "Created": "2024-10-15T19:03:08.826000+05:30",
            "LastModified": "2024-10-15T19:03:08.826000+05:30"
        },
        "ArtifactS3Location": "amzn-s3-demo-bucket/demo_canary.zip",
        "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
        "Tags": {}
    }
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarecreate-group.

AWS CLI

Per creare un gruppo

L'create-groupesempio seguente crea un gruppo denominatodemo_group.

aws synthetics create-group \
    --name demo_group

Output:

{
    "Group": {
        "Id": "example123",
        "Name": "demo_group",
        "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123",
        "Tags": {},
        "CreatedTime": "2024-10-15T14:47:23.811000+05:30",
        "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30"
    }
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzaredelete-canary.

AWS CLI

Per eliminare definitivamente un canarino

L'delete-canaryesempio seguente elimina un canarino denominato. demo_canary

aws synthetics delete-canary \
    --name demo_canary

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzaredelete-group.

AWS CLI

Per eliminare un gruppo

L'delete-groupesempio seguente elimina un gruppo denominatodemo_group.

aws synthetics delete-group \
    --group-identifier demo_group

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-canaries-last-run.

AWS CLI

Per visualizzare le informazioni relative alla tiratura più recente di ogni canarino

L'describe-canaries-last-runesempio seguente restituisce la sequenza più recente di ogni canarino che avete creato.

aws synthetics describe-canaries-last-run

Output:

{
    "CanariesLastRun": [
        {
            "CanaryName": "demo_canary",
            "LastRun": {
                "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
                "Name": "demo_canary",
                "Status": {
                    "State": "PASSED",
                    "StateReason": "",
                    "StateReasonCode": ""
                },
                "Timeline": {
                    "Started": "2024-10-15T19:20:39.691000+05:30",
                    "Completed": "2024-10-15T19:20:58.211000+05:30"
                },
                "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690"
            }
        }
    ]
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-canaries.

AWS CLI

Per elencare i canarini nel tuo account

L'describe-canariesesempio seguente elenca i dettagli dei canarini presenti nel tuo account.

aws synthetics describe-canaries

Output:

{
    "Canaries": [
        {
            "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
            "Name": "demo_canary",
            "Code": {
                "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example11111b8:1",
                "Handler": "pageLoadBlueprint.handler"
            },
            "ExecutionRoleArn": "arn:aws:iam::123456789012:role/service-role/CloudWatchSyntheticsRole-demo_canary-a12-a123bc456789",
            "Schedule": {
                "Expression": "rate(5 minutes)",
                "DurationInSeconds": 0
            },
            "RunConfig": {
                "TimeoutInSeconds": 300,
                "MemoryInMB": 1000,
                "ActiveTracing": false
            },
            "SuccessRetentionPeriodInDays": 31,
            "FailureRetentionPeriodInDays": 31,
            "Status": {
            "State": "RUNNING"
            },
            "Timeline": {
                "Created": "2024-10-15T18:55:15.168000+05:30",
                "LastModified": "2024-10-15T18:55:40.540000+05:30",
                "LastStarted": "2024-10-15T18:55:40.540000+05:30"
            },
            "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789",
            "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
            "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
            "Tags": {
                "blueprint": "heartbeat"
            }
        }
    ]
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-runtime-versions.

AWS CLI

Per restituire un elenco di versioni sintetiche di Canary Runtime

L'describe-runtime-versionsesempio seguente restituisce l'elenco delle versioni di synthetics Canary Runtime.

aws synthetics describe-runtime-versions

Output:

{
    "RuntimeVersions": [
        {
            "VersionName": "syn-nodejs-puppeteer-9.1",
            "Description": "Security fixes and bug fix for date range error in har. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126",
            "ReleaseDate": "2024-10-02T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-9.0",
            "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126",
            "ReleaseDate": "2024-07-22T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-8.0",
            "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.10.0, Chromium 125.0.6422.112",
            "ReleaseDate": "2024-06-21T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-7.0",
            "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 18.x, Puppeteer-core 21.9.0, Chromium 121.0.6167.139",
            "ReleaseDate": "2024-03-08T05:30:00+05:30"
            },
        {
            "VersionName": "syn-nodejs-puppeteer-6.2",
            "Description": "Updated shared libraries for Chromium and added ephemeral storage monitoring. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2024-02-02T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-6.1",
            "Description": "Added puppeteer launch retry. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-11-13T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-6.0",
            "Description": "Reduced X-Ray traces of a canary run, improved duration metric and upgraded to NodeJS 18.x. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-09-15T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-5.2",
            "Description": "Updated shared libraries for Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2024-02-01T05:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-5.1",
            "Description": "Fixes a bug about missing request headers in har. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-08-09T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-5.0",
            "Description": "Upgraded Puppeteer and Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146",
            "ReleaseDate": "2023-07-21T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        },
        {
            "VersionName": "syn-nodejs-puppeteer-4.0",
            "Description": "Upgraded to NodeJS 16.x. Dependencies: Node JS 16.x, Puppeteer-core 5.5.0, Chromium 92.0.4512.0",
            "ReleaseDate": "2023-05-01T05:30:00+05:30",
            "DeprecationDate": "2024-03-08T13:30:00+05:30"
        }
    ]
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzaredisassociate-resource.

AWS CLI

Per rimuovere un canarino da un gruppo

L'disassociate-resourceesempio seguente rimuove un canarino dal gruppo denominato. demo_group

aws synthetics disassociate-resource \
    --group-identifier demo_group \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzareget-canary-runs.

AWS CLI

Per recuperare un elenco di percorsi per un canarino specificato

L'get-canary-runsesempio seguente recupera un elenco di percorsi per il canarino denominato. demo_canary

aws synthetics get-canary-runs \
    --name demo_canary

Output:

{
    "CanaryRuns": [
        {
            "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
            "Name": "demo_canary",
            "Status": {
                "State": "PASSED",
                "StateReason": "",
                "StateReasonCode": ""
            },
            "Timeline": {
                "Started": "2024-10-16T10:38:57.013000+05:30",
                "Completed": "2024-10-16T10:39:25.793000+05:30"
            },
            "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690"
        }
    ]
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzareget-canary.

AWS CLI

Per recuperare informazioni complete su un canarino

L'get-canaryesempio seguente recupera informazioni complete sul canarino denominato. demo_canary

aws synthetics get-canary \
    --name demo_canary

Output:

{
    "Canary": {
        "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
        "Name": "demo_canary",
        "Code": {
            "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
            "Handler": "pageLoadBlueprint.handler"
        },
        "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role",
        "Schedule": {
            "Expression": "rate(10 minutes)",
            "DurationInSeconds": 0
        },
        "RunConfig": {
            "TimeoutInSeconds": 300,
            "MemoryInMB": 1000,
            "ActiveTracing": false
        },
        "SuccessRetentionPeriodInDays": 31,
        "FailureRetentionPeriodInDays": 31,
        "Status": {
            "State": "RUNNING"
        },
        "Timeline": {
            "Created": "2024-10-15T18:55:15.168000+05:30",
            "LastModified": "2024-10-15T18:55:40.540000+05:30",
            "LastStarted": "2024-10-15T18:55:40.540000+05:30"
        },
        "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789",
        "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1",
        "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
        "Tags": {
            "blueprint": "heartbeat"
        }
    }
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzareget-group.

AWS CLI

Per restituire informazioni su un gruppo

L'get-groupesempio seguente restituisce informazioni sul gruppo denominatodemo_group.

aws synthetics get-group \
    --group-identifier demo_group

Output:

{
    "Group": {
        "Id": "example123",
        "Name": "demo_group",
        "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123",
        "Tags": {},
        "CreatedTime": "2024-10-15T14:47:23.811000+05:30",
        "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30"
    }
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarelist-associated-groups.

AWS CLI

Per restituire un elenco dei gruppi

L'list-associated-groupsesempio seguente restituisce un elenco dei gruppi associati al canarino denominatodemo_canary.

aws synthetics list-associated-groups \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary

Output:

{
    "Groups": [
        {
            "Id": "example123",
            "Name": "demo_group",
            "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
        }
    ]
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarelist-group-resources.

AWS CLI

Per restituire un elenco ARNs dei canarini associati al gruppo specificato

L'list-group-resourcesesempio seguente restituisce un elenco ARNs dei canarini associati al gruppo denominato. demo_group

aws synthetics list-group-resources \
    --group-identifier demo_group

Output:

{
    "Resources": [
        "arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary"
    ]
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarelist-groups.

AWS CLI

Per restituire un elenco di tutti i gruppi dell'account

L'list-groupsesempio seguente restituisce un elenco di tutti i gruppi dell'account.

aws synthetics list-groups

Output:

{
    "Groups": [
        {
            "Id": "example123",
            "Name": "demo_group",
            "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123"
        }
    ]
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Esempio 1: Per visualizzare i tag associati a un canarino

L'list-tags-for-resourceesempio seguente restituisce i tag associati a un canarino denominato. demo_canary

aws synthetics list-tags-for-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary

Output:

{
    "Tags": {
        "blueprint": "heartbeat"
    }
}

Esempio 2: Per visualizzare i tag associati a un gruppo

L'list-tags-for-resourceesempio seguente restituisce i tag associati a un gruppo denominatodemo_group.

aws  synthetics list-tags-for-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123

Output:

{
    "Tags": {
        "team": "Devops"
    }
}

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarestart-canary.

AWS CLI

Gestire un canarino

L'start-canaryesempio seguente esegue un canarino denominato. demo_canary

aws synthetics start-canary \
    --name demo_canary

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzarestop-canary.

AWS CLI

Fermare un canarino

L'stop-canaryesempio seguente interrompe il canarino denominato. demo_canary

aws synthetics stop-canary \
    --name demo_canary

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Esempio 1: assegnare un tag al canarino

L'tag-resourceesempio seguente assegna un tag al canarino denominato. demo_canary

aws synthetics tag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
    --tags blueprint=heartbeat

Questo comando non produce alcun output.

Esempio 2: assegnare un tag al gruppo

L'tag-resourceesempio seguente assegna un tag al gruppo denominato. demo_group

aws synthetics tag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
    --tags team=Devops

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Esempio 1: rimuovere un tag dal canarino

L'untag-resourceesempio seguente rimuove un tag dal canarino denominato. demo_canary

aws synthetics untag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \
    --tag-keys blueprint

Questo comando non produce alcun output.

Esempio 2: Per rimuovere un tag dal gruppo

L'untag-resourceesempio seguente assegna un tag di rimozione dal gruppo denominatodemo_group.

aws synthetics untag-resource \
    --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \
    --tag-keys team

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.

Il seguente esempio di codice mostra come utilizzareupdate-canary.

AWS CLI

Per aggiornare un canarino

L'update-canaryesempio seguente aggiorna la configurazione di un canarino denominato. demo_canary

aws synthetics update-canary \
    --name demo_canary \
    --schedule Expression="rate(15 minutes)"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Synthetic monitoring (canaries) nella Amazon CloudWatch User Guide.