View a markdown version of this page

Metrik-metrik kustom - AWS Pembela Perangkat IoT
Cara menggunakan metrik khusus di konsolCara menggunakan metrik khusus dari CLIPerintah CLI metrik kustomAPI metrik khusus

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

Metrik-metrik kustom

catatan

Fitur AWS deteksi IoT Device Defender tidak lagi tersedia untuk pelanggan baru. Untuk mempelajari alternatif pendeteksian AWS IoT Device Defender, lihat AWS IoT Device Defender mendeteksi perubahan ketersediaan fitur. Tidak ada perubahan pada ketersediaan audit AWS IoT Device Defender.

Dengan metrik AWS IoT Device Defender khusus, Anda dapat menentukan dan memantau metrik yang unik untuk armada atau kasus penggunaan Anda, seperti jumlah perangkat yang terhubung ke Wi-Fi gateway, tingkat pengisian daya untuk baterai, atau jumlah siklus daya untuk colokan pintar. Perilaku metrik kustom didefinisikan dalam Profil Keamanan, yang menentukan perilaku yang diharapkan untuk sekelompok perangkat (grup benda) atau untuk semua perangkat. Anda dapat memantau perilaku dengan mengatur alarm, yang dapat Anda gunakan untuk mendeteksi dan menanggapi masalah yang khusus untuk perangkat.

Cara menggunakan metrik khusus di konsol

AWS IoT Device Defender SDK Agen (Python)

Untuk memulai, unduh AWS IoT Device Defender agen sampel Agen SDK (Python). Agen mengumpulkan metrik dan menerbitkan laporan. Setelah metrik sisi perangkat Anda diterbitkan, Anda dapat melihat metrik yang dikumpulkan dan menentukan ambang batas untuk menyiapkan alarm. Petunjuk untuk menyiapkan agen perangkat tersedia di Readme AWS IoT Device Defender Agent SDK (Python). Untuk informasi selengkapnya, lihat AWS IoT Device Defender Agen SDK (Python).

Membuat metrik khusus dan menambahkannya ke Profil Keamanan

Prosedur berikut menunjukkan cara membuat metrik khusus di konsol.

  1. Di AWS IoT konsol, di panel navigasi, perluas Per tahankan, lalu pilih Deteksi, Metrik.

  2. Pada halaman Metrik kustom, pilih Buat.

  3. Pada halaman Buat metrik kustom, lakukan hal berikut.

    1. Di bawah Nama, masukkan nama untuk metrik kustom Anda. Anda tidak dapat mengubah nama ini setelah membuat metrik kustom.

    2. Di bawah Nama tampilan (opsional), Anda dapat memasukkan nama ramah untuk metrik kustom Anda. Itu tidak harus unik dan dapat dimodifikasi setelah pembuatan.

    3. Di bawah Jenis, pilih jenis metrik yang ingin dipantau. Jenis metrik termasuk string-list, ip-address-list, number-list, dan number. Jenis tidak dapat dimodifikasi setelah pembuatan.

      catatan

      ML Detect hanya mengiz inkan jenis angka.

    4. Di bawah Tag, Anda dapat memilih tag yang akan dikaitkan dengan sumber daya.

    Setelah selesai, pilih Kon firmasi.

  4. Setelah membuat metrik kustom, halaman Metrik ku stom akan muncul, tempat Anda dapat melihat metrik kustom yang baru dibuat.

  5. Selanjutnya, Anda perlu menambahkan metrik kustom Anda ke Profil Keamanan. Di AWS IoT konsol, di panel navigasi, perluas Per tahankan, lalu pilih Deteksi, Profil keamanan.

  6. Pilih Profil Keamanan yang ingin Anda tambahkan metrik kustom.

  7. Pilih Tindakan, Edit.

  8. Pilih Metrik Tambahan untuk dipertahankan, lalu pilih metrik kustom Anda. Pilih Berikutnya pada layar berikut sampai Anda mencapai halaman Kon firmasi. Pilih S impan dan Lanjutkan. Setelah metrik kustom berhasil ditambahkan, halaman detail Profil Keamanan akan muncul.

    catatan

    Statistik persentil tidak tersedia untuk metrik ketika nilai metrik merupakan angka negatif.

Lihat detail metrik khusus

Prosedur berikut menunjukkan cara melihat detail metrik kustom di konsol.

  1. Di AWS IoT konsol, di panel navigasi, perluas Per tahankan, lalu pilih Deteksi, Metrik.

  2. Pilih nama Metrik dari metrik kustom yang ingin Anda lihat detailnya.

Memperbarui metrik khusus

Prosedur berikut menunjukkan cara memperbarui metrik khusus di konsol.

  1. Di AWS IoT konsol, di panel navigasi, perluas Per tahankan, lalu pilih Deteksi, Metrik.

  2. Pilih tombol opsi di sebelah metrik khusus yang ingin Anda perbarui. Kemudian, untuk T indakan, pilih Edit.

  3. Pada halaman Perbarui metrik kustom, Anda dapat mengedit nama tampilan dan menghapus atau menambahkan tag.

  4. Setelah selesai, pilih Per barui. Halaman metrik kustom.

Menghapus metrik khusus

Prosedur berikut menunjukkan cara menghapus metrik khusus di konsol.

  1. Pertama, hapus metrik kustom Anda dari Profil Keamanan yang dirujuk. Anda dapat melihat Profil Keamanan mana yang berisi metrik kustom Anda di halaman detail metrik kustom Anda. Di AWS IoT konsol, di panel navigasi, perluas Per tahankan, lalu pilih Deteksi, Metrik.

  2. Pilih metrik khusus yang ingin Anda hapus. Hapus metrik kustom dari Profil Keamanan apa pun yang tercantum di bawah Profil Keamanan pada halaman detail metrik kustom.

  3. Di AWS IoT konsol, di panel navigasi, perluas Per tahankan, lalu pilih Deteksi, Metrik.

  4. Pilih tombol opsi di sebelah metrik khusus yang ingin Anda hapus. Kemudian, untuk T indakan, pilih Hapus.

  5. Pada Apakah Anda yakin ingin menghapus metrik khusus? pesan, pilih H apus metrik khusus.

    Awas

    Setelah menghapus metrik khusus, Anda kehilangan semua data yang terkait dengan metrik tersebut. Tindakan ini tidak dapat dibatalkan.

Cara menggunakan metrik khusus dari CLI

AWS IoT Device Defender SDK Agen (Python)

Untuk memulai, unduh AWS IoT Device Defender agen sampel Agen SDK (Python). Agen mengumpulkan metrik dan menerbitkan laporan. Setelah metrik sisi perangkat Anda diterbitkan, Anda dapat melihat metrik yang dikumpulkan dan menentukan ambang batas untuk menyiapkan alarm. Petunjuk untuk menyiapkan agen perangkat tersedia di Readme AWS IoT Device Defender Agent SDK (Python). Untuk informasi selengkapnya, lihat AWS IoT Device Defender Agen SDK (Python).

Membuat metrik khusus dan menambahkannya ke Profil Keamanan

Prosedur berikut menunjukkan cara membuat metrik kustom dan menambahkannya ke Profil Keamanan dari CLI.

  1. Gunakan create-custom-metric perintah untuk membuat metrik kustom Anda. Contoh berikut membuat metrik khusus yang mengukur persentase baterai.

    aws iot create-custom-metric \
    --metric-name "batteryPercentage" \
    --metric-type "number" \
    --display-name "Remaining battery percentage." \
    --region us-east-1
    --client-request-token "02ccb92b-33e8-4dfa-a0c1-35b181ed26b0" \

    Output:

    {
    "metricName": "batteryPercentage",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage"
}

  2. Setelah membuat metrik kustom, Anda dapat menambahkan metrik kustom ke profil yang ada menggunakan update-security-profile atau membuat profil keamanan baru untuk menambahkan metrik kustom untuk menggunakancreate-security-profile. Di sini, kami membuat profil keamanan baru yang dipanggil batteryUsage untuk menambahkan metrik batteryPercentage khusus baru kami ke. Kami juga menambahkan metrik Deteksi Aturan yang disebutcellularBandwidth.

    aws iot create-security-profile \
    --security-profile-name batteryUsage \
    --security-profile-description "Shows how much battery is left in percentile."  \
    --behaviors "[{\"name\":\"great-than-75\",\"metric\":\"batteryPercentage\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"number\":75},\"consecutiveDatapointsToAlarm\":5,\"consecutiveDatapointsToClear\":1}},{\"name\":\"cellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" \
    --region us-east-1

    Output:

    {
    "securityProfileArn": "arn:aws:iot:us-east-1:1234564789012:securityprofile/batteryUsage",
    "securityProfileName": "batteryUsage"
}
catatan

Statistik persentil tidak tersedia untuk metrik ketika nilai metrik merupakan angka negatif.

Lihat detail metrik khusus

Prosedur berikut menunjukkan cara melihat detail untuk metrik kustom dari CLI.

  • Gunakan list-custom-metrics perintah untuk melihat semua metrik kustom Anda.

    aws iot list-custom-metrics \
    --region us-east-1

    Hasil akhir dari perintah ini adalah sebagai berikut.

    {
    "metricNames": [
        "batteryPercentage"
    ]
}

Memperbarui metrik khusus

Prosedur berikut menunjukkan cara memperbarui metrik kustom dari CLI.

  • Gunakan update-custom-metric perintah untuk memperbarui metrik khusus. Contoh berikut memperbaruidisplay-name.

    aws iot update-custom-metric \
    --metric-name batteryPercentage \
    --display-name 'remaining battery percentage on device' \
    --region us-east-1

    Hasil akhir dari perintah ini adalah sebagai berikut.

    {
    "metricName": "batteryPercentage",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage",
    "metricType": "number",
    "displayName": "remaining battery percentage on device",
    "creationDate": "2020-11-17T23:01:35.110000-08:00",
    "lastModifiedDate": "2020-11-17T23:02:12.879000-08:00"
}

Menghapus metrik khusus

Prosedur berikut menunjukkan cara menghapus metrik kustom dari CLI.

  1. Untuk menghapus metrik kustom, pertama-tama hapus metrik tersebut dari Profil Keamanan yang dilampirkan. Gunakan list-security-profiles perintah untuk melihat Profil Keamanan dengan metrik khusus tertentu.

  2. Untuk menghapus metrik kustom dari Profil Keamanan, gunakan update-security-profiles perintah. Masukkan semua informasi yang ingin Anda simpan, tetapi kecualikan metrik khusus.

    aws iot update-security-profile \
  --security-profile-name batteryUsage \
  --behaviors "[{\"name\":\"cellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"

    Hasil akhir dari perintah ini adalah sebagai berikut.

    {
  "behaviors": [{\"name\":\"cellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}],
  "securityProfileName": "batteryUsage",
  "lastModifiedDate": 2020-11-17T23:02:12.879000-09:00,
  "securityProfileDescription": "Shows how much battery is left in percentile.",
  "version": 2,
  "securityProfileArn": "arn:aws:iot:us-east-1:1234564789012:securityprofile/batteryUsage",  
  "creationDate": 2020-11-17T23:02:12.879000-09:00
}

  3. Setelah metrik kustom dilepaskan, gunakan delete-custom-metric perintah untuk menghapus metrik kustom.

    aws iot delete-custom-metric  \
  --metric-name batteryPercentage \
  --region us-east-1

    Output dari perintah ini terlihat seperti berikut

    HTTP 200

Perintah CLI metrik kustom

Anda dapat menggunakan perintah CLI berikut untuk membuat dan mengelola metrik kustom.

API metrik khusus

API berikut dapat digunakan untuk membuat dan mengelola metrik khusus.