Konfigurasikan AWS IoT logging - AWS IoT Core

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

Konfigurasikan AWS IoT logging

Anda harus mengaktifkan logging dengan menggunakan AWS IoT konsol, CLI, atau API sebelum Anda dapat memantau dan mencatat AWS IoT aktivitas.

Anda dapat mengaktifkan pencatatan untuk semua AWS IoT atau hanya grup hal tertentu. Anda dapat mengonfigurasi AWS IoT logging dengan menggunakan AWS IoT konsol, CLI, atau API; namun, Anda harus menggunakan CLI atau API untuk mengonfigurasi logging untuk grup hal tertentu.

Saat mempertimbangkan cara mengonfigurasi AWS IoT logging Anda, konfigurasi logging default menentukan bagaimana AWS IoT aktivitas akan dicatat kecuali ditentukan lain. Memulai, Anda mungkin ingin mendapatkan log terperinci dengan tingkat log default INFO atauDEBUG. Setelah meninjau log awal, Anda dapat mengubah level log default ke level yang kurang bertele-tele seperti WARN atau ERROR dan menetapkan tingkat log spesifik sumber daya yang lebih bertele-tele pada sumber daya yang mungkin memerlukan perhatian lebih. Level log dapat diubah kapan pun Anda mau.

Topik ini mencakup login sisi cloud. AWS IoT Untuk informasi tentang pencatatan dan pemantauan sisi perangkat, lihat Mengunggah log sisi perangkat ke. CloudWatch

Untuk informasi tentang pencatatan dan pemantauan AWS IoT Greengrass, lihat Logging dan monitoring in AWS IoT Greengrass. Pada 30 Juni 2023, perangkat lunak AWS IoT Greengrass Core telah bermigrasi ke. AWS IoT Greengrass Version 2

Konfigurasikan peran dan kebijakan pencatatan

Sebelum mengaktifkan login AWS IoT, Anda harus membuat peran IAM dan kebijakan yang memberikan AWS izin untuk memantau AWS IoT aktivitas atas nama Anda. Anda juga dapat membuat peran IAM dengan kebijakan yang diperlukan di bagian Log AWS IoT konsol.

catatan

Sebelum mengaktifkan AWS IoT logging, pastikan Anda memahami izin akses CloudWatch Log. Pengguna dengan akses ke CloudWatch Log dapat melihat informasi debugging dari perangkat Anda. Untuk informasi selengkapnya, lihat Otentikasi dan Kontrol Akses untuk CloudWatch Log Amazon.

Jika Anda mengharapkan pola lalu lintas tinggi AWS IoT Core karena pengujian beban, pertimbangkan untuk mematikan pencatatan IoT untuk mencegah pelambatan. Jika lalu lintas tinggi terdeteksi, layanan kami dapat menonaktifkan login di akun Anda.

Berikut ini menunjukkan cara membuat peran dan kebijakan logging untuk AWS IoT Core sumber daya.

Buat peran logging

Untuk membuat peran logging, buka hub Peran konsol IAM dan pilih Buat peran.

  1. Di bawah Pilih entitas tepercaya, pilih AWS Layanan. Kemudian pilih IoT di bawah Kasus penggunaan. Jika Anda tidak melihat IoT, masukkan dan cari IoT dari menu tarik-turun Kasus penggunaan untuk AWS layanan lain:. Pilih Selanjutnya.

  2. Pada halaman Tambahkan izin, Anda akan melihat kebijakan yang secara otomatis dilampirkan ke peran layanan. Pilih Selanjutnya.

  3. Pada halaman Nama, tinjau, dan buat, masukkan nama Peran dan Deskripsi peran untuk peran tersebut, lalu pilih Buat peran.

  4. Dalam daftar Peran, temukan peran yang Anda buat, buka, dan salin ARN Peran (logging-role-arn) untuk digunakan saat Anda. Konfigurasikan logging default di AWS IoT (konsol)

Kebijakan peran pencatatan

Dokumen kebijakan berikut menyediakan kebijakan peran dan kebijakan kepercayaan yang memungkinkan AWS IoT untuk mengirimkan entri log atas nama Anda. CloudWatch Jika Anda juga mengizinkan LoRa WAN AWS IoT Core untuk mengirimkan entri log, Anda akan melihat dokumen kebijakan yang dibuat untuk Anda yang mencatat kedua aktivitas tersebut.

catatan

Dokumen-dokumen ini dibuat untuk Anda saat Anda membuat peran logging. Dokumen memiliki variabel,, ${partition}${region}, dan ${accountId}, yang harus Anda ganti dengan nilai-nilai Anda.

Kebijakan peran:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents", "logs:PutMetricFilter", "logs:PutRetentionPolicy", "iot:GetLoggingOptions", "iot:SetLoggingOptions", "iot:SetV2LoggingOptions", "iot:GetV2LoggingOptions", "iot:SetV2LoggingLevel", "iot:ListV2LoggingLevels", "iot:DeleteV2LoggingLevel" ], "Resource": [ "arn:${partition}:logs:${region}:${accountId}:log-group:AWSIotLogsV2:*" ] } ] }

Kebijakan kepercayaan untuk mencatat AWS IoT Core aktivitas saja:

{ "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "iot.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }

Konfigurasikan logging default di AWS IoT (konsol)

Bagian ini menjelaskan cara menggunakan AWS IoT konsol untuk mengonfigurasi logging untuk semua AWS IoT. Untuk mengonfigurasi logging hanya untuk grup hal tertentu, Anda harus menggunakan CLI atau API. Untuk informasi tentang mengonfigurasi logging untuk grup hal tertentu, lihatKonfigurasikan login khusus sumber daya (CLI) AWS IoT.

Untuk menggunakan AWS IoT konsol untuk mengonfigurasi logging default untuk semua AWS IoT
  1. Masuk ke AWS IoT konsol. Untuk informasi selengkapnya, lihat Buka AWS IoT konsol.

  2. Pada panel navigasi kiri, pilih Pengaturan. Di bagian Log pada halaman Pengaturan, pilih Kelola log.

    Halaman Log menampilkan peran logging dan tingkat verbositas yang digunakan oleh semua. AWS IoT

    Halaman Log menampilkan peran log dan tingkat verbositas.
  3. Pada halaman Log, pilih Pilih peran untuk menentukan peran yang Anda buatBuat peran logging, atau Buat Peran untuk membuat peran baru yang akan digunakan untuk pencatatan.

    Halaman Log menampilkan peran log dan tingkat log.
  4. Pilih tingkat Log yang menjelaskan tingkat detail entri log yang ingin Anda tampilkan di CloudWatch log.

  5. Pilih Perbarui untuk menyimpan perubahan.

Setelah mengaktifkan logging, kunjungi Melihat AWS IoT log di CloudWatch konsol untuk mempelajari lebih lanjut tentang melihat entri log.

Konfigurasikan login default AWS IoT (CLI)

Bagian ini menjelaskan cara mengonfigurasi pencatatan global AWS IoT dengan menggunakan CLI.

catatan

Anda memerlukan Nama Sumber Daya Amazon (ARN) dari peran yang ingin Anda gunakan. Jika Anda perlu membuat peran yang akan digunakan untuk logging, lihat Buat peran logging sebelum melanjutkan.

Prinsipal yang digunakan untuk memanggil API harus memiliki Melewati izin peran peran logging Anda.

Anda juga dapat melakukan prosedur ini dengan API dengan menggunakan metode di AWS API yang sesuai dengan perintah CLI yang ditampilkan di sini.

Untuk menggunakan CLI untuk mengonfigurasi logging default untuk AWS IoT
  1. Gunakan set-v2-logging-optionsperintah untuk mengatur opsi logging untuk akun Anda.

    aws iot set-v2-logging-options \ --role-arn logging-role-arn \ --default-log-level log-level

    di mana:

    --role-arn

    Peran ARN yang memberikan AWS IoT izin untuk menulis ke log Anda di Log. CloudWatch

    --default-log-level

    Level log yang akan digunakan. Nilai yang valid adalah:ERROR,WARN,INFO,DEBUG, atau DISABLED

    --no-disable-all-logs

    Parameter opsional yang memungkinkan semua AWS IoT logging. Gunakan parameter ini untuk mengaktifkan logging saat saat ini dinonaktifkan.

    --disable-all-logs

    Parameter opsional yang menonaktifkan semua AWS IoT logging. Gunakan parameter ini untuk menonaktifkan logging saat saat ini diaktifkan.

  2. Gunakan get-v2-logging-optionsperintah untuk mendapatkan opsi logging Anda saat ini.

    aws iot get-v2-logging-options

Setelah mengaktifkan logging, kunjungi Melihat AWS IoT log di CloudWatch konsol untuk mempelajari lebih lanjut tentang melihat entri log.

catatan

AWS IoT terus mendukung perintah lama (set-logging-optionsdanget-logging-options) untuk mengatur dan mendapatkan pencatatan global di akun Anda. Ketahuilah bahwa ketika perintah ini digunakan, log yang dihasilkan berisi teks biasa, daripada muatan JSON dan latensi logging umumnya lebih tinggi. Tidak ada perbaikan lebih lanjut yang akan dilakukan untuk implementasi perintah lama ini. Kami menyarankan Anda menggunakan versi “v2" untuk mengonfigurasi opsi pencatatan Anda dan, jika memungkinkan, ubah aplikasi lama yang menggunakan versi yang lebih lama.

Konfigurasikan login khusus sumber daya (CLI) AWS IoT

Bagian ini menjelaskan cara mengonfigurasi logging khusus sumber daya dengan AWS IoT menggunakan CLI. Pencatatan khusus sumber daya memungkinkan Anda menentukan tingkat pencatatan untuk grup hal tertentu.

Kelompok benda dapat berisi kelompok hal lain untuk membuat hubungan hierarkis. Prosedur ini menjelaskan cara mengkonfigurasi logging dari satu grup hal. Anda dapat menerapkan prosedur ini ke grup hal induk dalam hierarki untuk mengonfigurasi logging untuk semua grup hal dalam hierarki. Anda juga dapat menerapkan prosedur ini ke grup hal anak untuk mengganti konfigurasi logging induknya.

Selain grup benda, Anda juga dapat mencatat target seperti ID klien perangkat, IP sumber, dan ID utama.

catatan

Anda memerlukan Nama Sumber Daya Amazon (ARN) dari peran yang ingin Anda gunakan. Jika Anda perlu membuat peran yang akan digunakan untuk logging, lihat Buat peran logging sebelum melanjutkan.

Prinsipal yang digunakan untuk memanggil API harus memiliki Melewati izin peran peran logging Anda.

Anda juga dapat melakukan prosedur ini dengan API dengan menggunakan metode di AWS API yang sesuai dengan perintah CLI yang ditampilkan di sini.

Untuk menggunakan CLI untuk mengonfigurasi logging khusus sumber daya untuk AWS IoT
  1. Gunakan set-v2-logging-optionsperintah untuk mengatur opsi logging untuk akun Anda.

    aws iot set-v2-logging-options \ --role-arn logging-role-arn \ --default-log-level log-level

    di mana:

    --role-arn

    Peran ARN yang memberikan AWS IoT izin untuk menulis ke log Anda di Log. CloudWatch

    --default-log-level

    Level log yang akan digunakan. Nilai yang valid adalah:ERROR,WARN,INFO,DEBUG, atau DISABLED

    --no-disable-all-logs

    Parameter opsional yang memungkinkan semua AWS IoT logging. Gunakan parameter ini untuk mengaktifkan logging saat saat ini dinonaktifkan.

    --disable-all-logs

    Parameter opsional yang menonaktifkan semua AWS IoT logging. Gunakan parameter ini untuk menonaktifkan logging saat saat ini diaktifkan.

  2. Gunakan set-v2-logging-levelperintah untuk mengonfigurasi logging khusus sumber daya untuk grup sesuatu.

    aws iot set-v2-logging-level \ --log-target targetType=THING_GROUP,targetName=thing_group_name \ --log-level log_level
    --log-target

    Jenis dan nama sumber daya yang Anda konfigurasi logging. target_typeNilai harus salah satu dari: THING_GROUP | CLIENT_ID | SOURCE_IP |PRINCIPAL_ID. Nilai parameter log-target dapat berupa teks, seperti yang ditunjukkan pada contoh perintah sebelumnya, atau string JSON, seperti contoh berikut.

    aws iot set-v2-logging-level \ --log-target '{"targetType": "THING_GROUP","targetName": "thing_group_name"}' \ --log-level log_level
    --log-level

    Tingkat logging yang digunakan saat membuat log untuk sumber daya yang ditentukan. Nilai yang valid adalah:DEBUG,INFO,ERROR,WARN, dan DISABLED

    aws iot set-v2-logging-level \ --log-target targetType=CLIENT_ID,targetName=ClientId1 \ --log-level DEBUG
  3. Gunakan list-v2-logging-levelsperintah untuk mencantumkan level logging yang saat ini dikonfigurasi.

    aws iot list-v2-logging-levels
  4. Gunakan delete-v2-logging-levelperintah untuk menghapus tingkat logging khusus sumber daya, seperti contoh berikut.

    aws iot delete-v2-logging-level \ --target-type "THING_GROUP" \ --target-name "thing_group_name"
    aws iot delete-v2-logging-level \ --target-type=CLIENT_ID --target-name=ClientId1
    --targetType

    target_typeNilai harus salah satu dari: THING_GROUP | CLIENT_ID | SOURCE_IP |PRINCIPAL_ID.

    --targetName

    Nama grup benda untuk menghapus level logging.

Setelah mengaktifkan logging, kunjungi Melihat AWS IoT log di CloudWatch konsol untuk mempelajari lebih lanjut tentang melihat entri log.

Tingkat Log

Level log ini menentukan peristiwa yang dicatat dan berlaku untuk tingkat log default dan khusus sumber daya.

ERROR

Kesalahan apa pun yang menyebabkan operasi gagal.

Log hanya menyertakan informasi ERROR.

PERINGATAN

Apa pun yang berpotensi menyebabkan ketidakkonsistenan dalam sistem, tetapi mungkin tidak menyebabkan operasi gagal.

Log termasuk ERROR dan WARN informasi.

INFO

Informasi tingkat tinggi tentang aliran benda.

Log termasuk informasi INFO, ERROR, dan WARN.

AWAKUTU

Informasi yang mungkin berguna saat men-debug masalah.

Log termasuk informasi DEBUG, INFO, ERROR, dan WARN.

DISABLED

Semua logging dinonaktifkan.