View a markdown version of this page

CloudWatch Contoh sintetis menggunakan AWS CLI - AWS Command Line Interface
Tindakan

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

CloudWatch Contoh sintetis menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan menerapkan skenario umum dengan menggunakan AWS Command Line Interface dengan CloudWatch Synthetics.

Tindakan merupakan kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

Contoh kode berikut menunjukkan cara menggunakanassociate-resource.

AWS CLI

Untuk mengaitkan kenari dengan grup

associate-resourceContoh berikut mengaitkan kenari dengan grup bernamademo_group.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakancreate-canary.

AWS CLI

Untuk membuat kenari

create-canaryContoh berikut membuat kenari bernamademo_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": {}
    }
}

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat CreateCanary di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-group.

AWS CLI

Untuk membuat grup

create-groupContoh berikut membuat grup bernamademo_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"
    }
}

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat CreateGroup di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-canary.

AWS CLI

Untuk menghapus kenari secara permanen

delete-canaryContoh berikut menghapus kenari bernamademo_canary.

aws synthetics delete-canary \
    --name demo_canary

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat DeleteCanary di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-group.

AWS CLI

Untuk menghapus grup

delete-groupContoh berikut menghapus grup bernamademo_group.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat DeleteGroup di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-canaries-last-run.

AWS CLI

Untuk melihat informasi dari putaran terbaru dari setiap kenari

describe-canaries-last-runContoh berikut mengembalikan run terbaru dari setiap kenari yang telah Anda buat.

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

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakandescribe-canaries.

AWS CLI

Untuk membuat daftar burung kenari di akun Anda

describe-canariesContoh berikut mencantumkan detail burung kenari di akun Anda.

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

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakandescribe-runtime-versions.

AWS CLI

Untuk mengembalikan daftar versi runtime canary sintetis

describe-runtime-versionsContoh berikut mengembalikan daftar versi runtime canary sintetis.

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

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakandisassociate-resource.

AWS CLI

Untuk menghapus kenari dari grup

disassociate-resourceContoh berikut menghapus kenari dari grup bernamademo_group.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakanget-canary-runs.

AWS CLI

Untuk mengambil daftar run untuk kenari tertentu

get-canary-runsContoh berikut mengambil daftar run untuk burung kenari bernamademo_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"
        }
    ]
}

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakanget-canary.

AWS CLI

Untuk mengambil informasi lengkap tentang satu kenari

get-canaryContoh berikut mengambil informasi lengkap tentang kenari bernamademo_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"
        }
    }
}

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat GetCanary di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-group.

AWS CLI

Untuk mengembalikan informasi tentang satu grup

get-groupContoh berikut mengembalikan informasi tentang grup bernamademo_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"
    }
}

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat GetGroup di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-associated-groups.

AWS CLI

Untuk mengembalikan daftar grup

list-associated-groupsContoh berikut mengembalikan daftar grup yang terkait dengan nama kenaridemo_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"
        }
    ]
}

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-group-resources.

AWS CLI

Untuk mengembalikan daftar ARN kenari yang terkait dengan grup yang ditentukan

list-group-resourcesContoh berikut mengembalikan daftar ARN dari burung kenari yang terkait dengan grup bernama. demo_group

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

Output:

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

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-groups.

AWS CLI

Untuk mengembalikan daftar semua grup di akun

list-groupsContoh berikut mengembalikan daftar semua grup dalam akun.

aws synthetics list-groups

Output:

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

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat ListGroups di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-tags-for-resource.

AWS CLI

Contoh 1: Untuk menampilkan tag yang terkait dengan kenari

list-tags-for-resourceContoh berikut mengembalikan tag yang terkait dengan nama kenaridemo_canary.

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

Output:

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

Contoh 2: Untuk menampilkan tag yang terkait dengan grup

list-tags-for-resourceContoh berikut mengembalikan tag yang terkait dengan grup bernamademo_group.

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

Output:

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

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakanstart-canary.

AWS CLI

Untuk menjalankan kenari

start-canaryContoh berikut menjalankan kenari bernamademo_canary.

aws synthetics start-canary \
    --name demo_canary

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat StartCanary di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanstop-canary.

AWS CLI

Untuk menghentikan kenari

stop-canaryContoh berikut menghentikan kenari bernamademo_canary.

aws synthetics stop-canary \
    --name demo_canary

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat StopCanary di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakantag-resource.

AWS CLI

Contoh 1: Untuk menetapkan tag ke kenari

tag-resourceContoh berikut memberikan tag ke burung kenari bernamademo_canary.

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

Perintah ini tidak menghasilkan output.

Contoh 2: Untuk menetapkan tag ke grup

tag-resourceContoh berikut menetapkan tag ke grup bernamademo_group.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat TagResource di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanuntag-resource.

AWS CLI

Contoh 1: Untuk menghapus tag dari kenari

untag-resourceContoh berikut menghapus tag dari burung kenari bernamademo_canary.

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

Perintah ini tidak menghasilkan output.

Contoh 2: Untuk menghapus tag dari grup

untag-resourceContoh berikut menetapkan menghapus tag dari grup bernamademo_group.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

Contoh kode berikut menunjukkan cara menggunakanupdate-canary.

AWS CLI

Untuk memperbarui kenari

update-canaryContoh berikut memperbarui konfigurasi burung kenari bernamademo_canary.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Pemantauan sintetis (burung kenari) di Panduan CloudWatch Pengguna Amazon.

  • Untuk detail API, lihat UpdateCanary di Refer AWS CLI ensi Perintah.