CloudWatch Exemples de produits Synthetics utilisant AWS CLI

Pour associer un canary avec un groupe

L’exemple associate-resource suivant associe un canary à un groupe nommé demo_group.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour créer un canary

L’exemple create-canary suivant crée un canary nommé 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

Sortie :

{
    "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": {}
    }
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour créer un groupe

L’exemple create-group suivant crée un groupe nommé demo_group.

aws synthetics create-group \
    --name demo_group

Sortie :

{
    "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"
    }
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour supprimer définitivement un canary

L’exemple delete-canary suivant supprime un canary nommé demo_canary.

aws synthetics delete-canary \
    --name demo_canary

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour supprimer un groupe

L’exemple delete-group suivant supprime un groupe nommé demo_group.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour consulter des informations relatives à la dernière exécution de chaque canary

L’exemple describe-canaries-last-run suivant renvoie la dernière exécution de chaque canary que vous avez créé.

aws synthetics describe-canaries-last-run

Sortie :

{
    "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"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour répertorier les scripts Canary de votre compte

L’exemple describe-canaries suivant répertorie des informations sur les canaries de votre compte.

aws synthetics describe-canaries

Sortie :

{
    "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"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour renvoyer une liste des versions d’exécution de canaris synthétiques

L’exemple describe-runtime-versions suivant renvoie la liste des versions d’exécution de canaris synthétiques.

aws synthetics describe-runtime-versions

Sortie :

{
    "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"
        }
    ]
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour supprimer un canary d’un groupe

L’exemple disassociate-resource suivant supprime un canary du groupe nommé demo_group.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour extraire une liste d’exécutions pour un canary spécifié

L’exemple get-canary-runs suivant extrait une liste d’exécutions pour le canary nommé demo_canary.

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

Sortie :

{
    "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"
        }
    ]
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour extraire des informations complètes sur un canary

L’exemple get-canary suivant extrait des informations complètes sur le canary nommé demo_canary.

aws synthetics get-canary \
    --name demo_canary

Sortie :

{
    "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"
        }
    }
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour renvoyer des informations sur un groupe

L’exemple get-group suivant renvoie des informations sur le groupe nommé demo_group.

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

Sortie :

{
    "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"
    }
}

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour renvoyer une liste de groupes

L’exemple list-associated-groups suivant renvoie une liste des groupes associés au canary nommé demo_canary.

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

Sortie :

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

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour renvoyer une liste ARNs des canaris associés au groupe spécifié

L'list-group-resourcesexemple suivant renvoie une liste ARNs des canaris associés au groupe nommédemo_group.

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

Sortie :

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

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour renvoyer la liste de tous les groupes du compte

L’exemple list-groups suivant renvoie une liste de tous les groupes du compte.

aws synthetics list-groups

Sortie :

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

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Exemple 1 : pour afficher les balises associées à un canary

L’exemple list-tags-for-resource suivant renvoie les balises associées à un canary nommé demo_canary.

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

Sortie :

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

Exemple 2 : pour afficher les balises associés à un groupe

L’exemple list-tags-for-resource suivant renvoie les balises associées à un groupe nommé demo_group.

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

Sortie :

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

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour exécuter un canary

L’exemple start-canary suivant exécute un canary nommé demo_canary.

aws synthetics start-canary \
    --name demo_canary

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour arrêter un canary

L’exemple stop-canary suivant arrête le canary nommé demo_canary.

aws synthetics stop-canary \
    --name demo_canary

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Exemple 1 : pour attribuer une balise au canary

L’exemple tag-resource suivant attribue une balise au canary nommé demo_canary.

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

Cette commande ne produit aucune sortie.

Exemple 2 : pour attribuer une balise au groupe

L’exemple tag-resource suivant attribue une balise au groupe nommé demo_group.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Exemple 1 : pour supprimer une balise du canary

L’exemple untag-resource suivant supprime une balise du canary nommé demo_canary.

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

Cette commande ne produit aucune sortie.

Exemple 2 : pour supprimer une balise du groupe

L’exemple untag-resource suivant supprime une balise du groupe nommé demo_group.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.

Pour mettre à jour un canary

L’exemple update-canary suivant met à jour la configuration d’un canary nommé demo_canary.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance synthétique (canaris) dans le guide de l' CloudWatch utilisateur Amazon.