Konsol debug lokal - AWS IoT Greengrass

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

Konsol debug lokal

Komponen konsol debug lokal (aws.greengrass.LocalDebugConsole) menyediakan dasbor lokal yang menampilkan informasi tentang perangkat AWS IoT Greengrass inti Anda dan komponennya. Anda dapat menggunakan dasbor ini untuk men-debug perangkat inti Anda dan mengelola komponen lokal.

penting

Kami menyarankan Anda menggunakan komponen ini hanya di lingkungan pengembangan, bukan lingkungan produksi. Komponen ini menyediakan akses ke informasi dan operasi yang biasanya tidak Anda perlukan di lingkungan produksi. Ikuti prinsip hak istimewa paling sedikit dengan menerapkan komponen ini hanya ke perangkat inti di mana Anda membutuhkannya.

Versi

Komponen ini memiliki versi berikut:

  • 2.3.x

  • 2.2.x

  • 2.1.x

  • 2.0.x

Tipe

Komponen ini adalah komponen plugin (aws.greengrass.plugin). Inti Greengrass menjalankan komponen plugin dalam Java Virtual Machine (JVM) yang sama sebagai inti. Nukleus dimulai ulang saat Anda mengubah versi komponen ini di perangkat inti.

Komponen plugin menggunakan file log yang sama seperti inti Greengrass. Untuk informasi selengkapnya, lihat Memantau AWS IoT Greengrass log.

Untuk informasi selengkapnya, lihat Jenis komponen.

Sistem operasi

Komponen ini dapat diinstal pada perangkat inti yang menjalankan sistem operasi berikut:

  • Linux

  • Windows

Persyaratan

Komponen ini memiliki persyaratan sebagai berikut:

  • Anda menggunakan nama pengguna dan kata sandi untuk masuk ke dasbor. Nama pengguna, yaitu debug, disediakan untuk Anda. Anda harus menggunakan AWS IoT Greengrass CLI untuk membuat kata sandi sementara yang mengautentikasi Anda dengan dasbor pada perangkat inti. Anda harus dapat menggunakan AWS IoT Greengrass CLI untuk menggunakan konsol debug lokal. Untuk informasi lebih lanjut, lihat Persyaratan Greengrass CLI. Untuk informasi lebih lanjut tentang cara membuat kata sandi dan masuk, lihat Penggunaan komponen konsol debug lokal.

  • Komponen konsol debug lokal didukung untuk berjalan di VPC.

Dependensi

Saat Anda menerapkan komponen, gunakan AWS IoT Greengrass juga versi dependensinya yang kompatibel. Ini berarti bahwa Anda harus memenuhi persyaratan untuk komponen dan semua dependensinya untuk berhasil men-deploy komponen. Bagian ini berisi daftar dependensi untuk versi yang dirilis dari komponen ini dan kendala versi semantik yang menentukan versi komponen untuk setiap dependensi. Anda juga dapat melihat dependensi untuk setiap versi komponen di konsol AWS IoT Greengrass tersebut. Pada halaman detail komponen, cari daftar Dependensi.

2.4.1 – 2.4.2

Tabel berikut mencantumkan dependensi untuk versi 2.4.1 hingga 2.4.2 komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.10.0 <2.13.0 Keras
CLI Greengrass >=2.10.0 <2.13.0 Keras
2.4.0

Tabel berikut mencantumkan dependensi untuk versi 2.4.0 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.10.0 <2.12.0 Keras
CLI Greengrass >=2.10.0 <2.12.0 Keras
2.3.0 and 2.3.1

Tabel berikut mencantumkan dependensi untuk versi 2.3.0 dan 2.3.1 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.10.0 <2.12.0 Keras
CLI Greengrass >=2.10.0 <2.12.0 Keras
2.2.9

Tabel berikut mencantumkan dependensi untuk versi 2.2.9 komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.12.0 Keras
CLI Greengrass >=2.1.0 <2.12.0 Keras
2.2.8

Tabel berikut mencantumkan dependensi untuk versi 2.2.8 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.11.0 Keras
CLI Greengrass >=2.1.0 <2.11.0 Keras
2.2.7

Tabel berikut mencantumkan dependensi untuk versi 2.2.7 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.10.0 Keras
CLI Greengrass >=2.1.0 <2.10.0 Keras
2.2.6

Tabel berikut mencantumkan dependensi untuk versi 2.2.6 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.9.0 Keras
CLI Greengrass >=2.1.0 <2.9.0 Keras
2.2.5

Tabel berikut mencantumkan dependensi untuk versi 2.2.5 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.8.0 Keras
CLI Greengrass >=2.1.0 <2.8.0 Keras
2.2.4

Tabel berikut mencantumkan dependensi untuk versi 2.2.4 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.7.0 Keras
CLI Greengrass >=2.1.0 <2.7.0 Keras
2.2.3

Tabel berikut mencantumkan dependensi untuk versi 2.2.3 komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.6.0 Keras
CLI Greengrass >=2.1.0 <2.6.0 Keras
2.2.2

Tabel berikut mencantumkan dependensi untuk versi 2.2.2 dari komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.5.0 Keras
CLI Greengrass >=2.1.0 <2.5.0 Keras
2.2.1

Tabel berikut mencantumkan dependensi untuk versi 2.2.1 komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.4.0 Keras
CLI Greengrass >=2.1.0 <2.4.0 Keras
2.2.0

Tabel berikut mencantumkan dependensi untuk versi 2.2.0 komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.3.0 Keras
CLI Greengrass >=2.1.0 <2.3.0 Keras
2.1.0

Tabel berikut mencantumkan dependensi untuk versi 2.1.0 komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.1.0 <2.2.0 Keras
CLI Greengrass >=2.1.0 <2.2.0 Keras
2.0.x

Tabel berikut mencantumkan dependensi untuk versi 2.0.x komponen ini.

Dependensi Versi yang kompatibel Jenis dependensi
Inti Greengrass >=2.0.3 <2.1.0 Lunak
CLI Greengrass >=2.0.3 <2.1.0 Lunak

Untuk informasi selengkapnya tentang dependensi komponen, lihat referensi resep komponen.

Konfigurasi

Komponen ini menyediakan parameter konfigurasi berikut yang dapat Anda sesuaikan ketika Anda men-deploy komponen.

v2.1.x - v2.4.x
httpsEnabled

(Opsional) Anda dapat mengaktifkan HTTPS komunikasi untuk konsol debug lokal. Jika Anda mengaktifkan HTTPS komunikasi, konsol debug lokal akan membuat sertifikat yang ditandatangani sendiri. Peramban web menampilkan peringatan keamanan untuk situs web yang menggunakan sertifikat yang ditandatangani sendiri, sehingga Anda harus memverifikasi sertifikat secara manual. Kemudian, Anda dapat melewati peringatan ini. Untuk informasi selengkapnya, lihat Penggunaan.

Default: true

port

(Opsional) Port tempat untuk menyediakan konsol debug lokal.

Default: 1441

websocketPort

(Opsional) Port websocket yang akan digunakan untuk konsol debug lokal.

Default: 1442

bindHostname

(Opsional) Nama host yang akan digunakan untuk konsol debug lokal.

Jika Anda menjalankan perangkat lunak AWS IoT Greengrass Core dalam wadah Docker, atur parameter ini0.0.0.0, sehingga Anda dapat membuka konsol debug lokal di luar wadah Docker.

Default: localhost

contoh Contoh: Pembaruan gabungan konfigurasi

Contoh konfigurasi berikut menentukan untuk membuka konsol debug lokal pada port non-default dan menonaktifkan HTTPS.

{ "httpsEnabled": false, "port": "10441", "websocketPort": "10442" }
v2.0.x
port

(Opsional) Port tempat untuk menyediakan konsol debug lokal.

Default: 1441

websocketPort

(Opsional) Port websocket yang akan digunakan untuk konsol debug lokal.

Default: 1442

bindHostname

(Opsional) Nama host yang akan digunakan untuk konsol debug lokal.

Jika Anda menjalankan perangkat lunak AWS IoT Greengrass Core dalam wadah Docker, atur parameter ini0.0.0.0, sehingga Anda dapat membuka konsol debug lokal di luar wadah Docker.

Default: localhost

contoh Contoh: Pembaruan gabungan konfigurasi

Contoh konfigurasi berikut menentukan untuk membuka konsol debug lokal pada port non-default.

{ "port": "10441", "websocketPort": "10442" }

Penggunaan

Untuk menggunakan konsol debug lokal, buat sesi dari Greengrass CLI. Ketika Anda membuat sesi, Greengrass CLI akan menyediakan nama pengguna dan kata sandi sementara yang dapat Anda gunakan untuk masuk ke konsol debug lokal.

Ikuti petunjuk ini untuk membuka konsol debug lokal pada perangkat inti atau komputer pengembangan Anda.

v2.1.x - v2.4.x

Dalam versi 2.1.0 dan kemudian, konsol debug lokal menggunakan HTTPS secara default. Ketika HTTPS diaktifkan, konsol debug lokal membuat sertifikat yang ditandatangani sendiri untuk mengamankan sambungan. Peramban web Anda akan menunjukkan peringatan keamanan ketika Anda membuka konsol debug lokal karena sertifikat yang ditandatangani sendiri ini. Ketika Anda membuat sesi dengan Greengrass CLI, output akan mencakup sidik jari sertifikat, sehingga Anda dapat memverifikasi bahwa sertifikat itu sah dan sambungan aman.

Anda dapat menonaktifkan HTTPS. Untuk informasi lebih lanjut, lihat konfigurasi konsol debug lokal.

Untuk membuka konsol debug lokal
  1. (Opsional) Untuk melihat konsol debug lokal pada komputer pengembangan Anda, Anda dapat meneruskan port konsol melalui SSH. Namun, Anda harus mengaktifkan opsi AllowTcpForwarding di file konfigurasi SSH perangkat inti Anda. Opsi ini diatur secara default. Jalankan perintah berikut pada komputer pengembangan Anda untuk melihat dasbor di localhost:1441 pada komputer pengembangan Anda.

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    catatan

    Anda dapat mengubah port default dari 1441 dan 1442. Untuk informasi lebih lanjut, lihat konfigurasi konsol debug lokal.

  2. Buat sesi untuk menggunakan konsol debug lokal. Ketika Anda membuat sesi, Anda membuat kata sandi yang Anda gunakan untuk mengautentikasi. Konsol debug lokal memerlukan kata sandi untuk meningkatkan keamanan, karena Anda dapat menggunakan komponen ini untuk melihat informasi penting dan melakukan operasi pada perangkat inti. Konsol debug lokal juga menciptakan sertifikat untuk mengamankan sambungan jika Anda mengaktifkan HTTPS dalam konfigurasi komponen. HTTPS tidak diaktifkan secara default.

    Gunakan AWS IoT Greengrass CLI untuk membuat sesi. Perintah ini menghasilkan kata sandi 43 karakter acak yang akan kedaluwarsa setelah 8 jam. Ganti /greengrass/v2 atau C:\greengrass\v2 dengan jalur ke folder AWS IoT Greengrass V2 root.

    Linux or UnixWindows
    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli get-debug-password
    Windows
    C:\greengrass\v2\bin\greengrass-cli get-debug-password

    Perintah output terlihat seperti contoh berikut jika Anda telah mengonfigurasi konsol debug lokal untuk menggunakan HTTPS. Anda menggunakan sidik jari sertifikat untuk memverifikasi bahwa sambungan aman ketika Anda membuka konsol debug lokal.

    Username: debug Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE Password expires at: 2021-04-01T17:01:43.921999931-07:00 The local debug console is configured to use TLS security. The certificate is self-signed so you will need to bypass your web browser's security warnings to open the console. Before you bypass the security warning, verify that the certificate fingerprint matches the following fingerprints. SHA-256: 15 0B 2C E2 54 8B 22 DE 08 46 54 8A B1 2B 25 DE FB 02 7D 01 4E 4A 56 67 96 DA A6 CC B1 D2 C4 1B SHA-1: BC 3E 16 04 D3 80 70 DA E0 47 25 F9 90 FA D6 02 80 3E B5 C1

    Komponen tampilan debug menciptakan sesi yang berlangsung selama 8 jam. Setelah itu, Anda harus menghasilkan kata sandi baru untuk melihat konsol debug lokal lagi.

  3. Buka dan masuk ke dasbor. Lihat dasbor pada perangkat inti Greengrass Anda, atau pada komputer pengembangan Anda jika Anda meneruskan port melalui SSH. Lakukan salah satu hal berikut:

    • Jika Anda mengaktifkan HTTPS di konsol debug lokal, yang merupakan pengaturan default, lakukan hal berikut:

      1. Buka https://localhost:1441 pada perangkat inti Greengrass Anda, atau pada komputer pengembangan Anda jika Anda meneruskan port melalui SSH.

        Peramban Anda mungkin akan menampilkan peringatan keamanan tentang sertifikat keamanan yang tidak valid.

      2. Jika peramban Anda menampilkan peringatan keamanan, verifikasi bahwa sertifikat itu sah dan lewati peringatan keamanan. Lakukan hal-hal berikut:

        1. Temukan sidik jari SHA-256 atau SHA-1 untuk sertifikat itu, dan verifikasi bahwa ia cocok dengan sidik jari SHA-256 atau SHA-1 yang dicetak oleh perintah get-debug-password sebelumnya. Peramban Anda mungkin akan menyediakan satu atau kedua sidik jari itu. Lihat dokumentasi peramban Anda untuk melihat sertifikat dan sidik jarinya. Di beberapa peramban, sidik jari sertifikat disebut sidik jari.

          catatan

          Jika sidik jari sertifikat tidak cocok, buka Tahap 2 untuk membuat sesi baru. Jika sidik jari sertifikat masih tidak cocok, koneksi Anda mungkin tidak aman.

        2. Jika sidik jari sertifikat cocok, lewati peringatan keamanan peramban Anda untuk membuka konsol debug lokal. Lihat dokumentasi peramban Anda untuk melewati peringatan keamanan peramban.

      3. Masuk ke situs web dengan menggunakan nama pengguna dan kata sandi yang dicetak oleh perintah get-debug-password sebelumnya.

        Konsol debug lokal terbuka.

      4. Jika konsol debug lokal menunjukkan kesalahan yang mengatakan tidak dapat terhubung ke konsol WebSocket karena jabat tangan TLS gagal, Anda harus melewati peringatan keamanan yang ditandatangani sendiri untuk URL tersebut. WebSocket

        Kesalahan jabat tangan WebSocket TLS di konsol debug lokal.

        Lakukan hal-hal berikut:

        1. Buka https://localhost:1442 di peramban yang sama di mana Anda membuka konsol debug lokal.

        2. Verifikasi sertifikat dan lewati peringatan keamanan.

          Peramban Anda mungkin akan menampilkan halaman HTTP 404 setelah Anda melewati peringatan.

        3. Buka https://localhost:1441 lagi.

          Konsol debug lokal menunjukkan informasi tentang perangkat inti.

    • Jika Anda menonaktifkan HTTPS di konsol debug lokal, lakukan hal berikut:

      1. Buka http://localhost:1441 pada perangkat inti, atau buka pada komputer pengembangan Anda jika Anda meneruskan port melalui SSH.

      2. Masuk ke situs web dengan menggunakan nama pengguna dan kata sandi yang dicetak oleh perintah get-debug-password sebelumnya.

        Konsol debug lokal terbuka.

v2.0.x
Untuk membuka konsol debug lokal
  1. (Opsional) Untuk melihat konsol debug lokal pada komputer pengembangan Anda, Anda dapat meneruskan port konsol melalui SSH. Namun, Anda harus mengaktifkan opsi AllowTcpForwarding di file konfigurasi SSH perangkat inti Anda. Opsi ini diatur secara default. Jalankan perintah berikut pada komputer pengembangan Anda untuk melihat dasbor di localhost:1441 pada komputer pengembangan Anda.

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    catatan

    Anda dapat mengubah port default dari 1441 dan 1442. Untuk informasi lebih lanjut, lihat konfigurasi konsol debug lokal.

  2. Buat sesi untuk menggunakan konsol debug lokal. Ketika Anda membuat sesi, Anda membuat kata sandi yang Anda gunakan untuk mengautentikasi. Konsol debug lokal memerlukan kata sandi untuk meningkatkan keamanan, karena Anda dapat menggunakan komponen ini untuk melihat informasi penting dan melakukan operasi pada perangkat inti.

    Gunakan AWS IoT Greengrass CLI untuk membuat sesi. Perintah ini menghasilkan kata sandi 43 karakter acak yang akan kedaluwarsa setelah 8 jam. Ganti /greengrass/v2 atau C:\greengrass\v2 dengan jalur ke folder AWS IoT Greengrass V2 root.

    Linux or UnixWindows
    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli get-debug-password
    Windows
    C:\greengrass\v2\bin\greengrass-cli get-debug-password

    Perintah output terlihat seperti contoh berikut.

    Username: debug Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE Password will expire at: 2021-04-01T17:01:43.921999931-07:00

    Komponen tampilan debug menciptakan sesi yang berlangsung selama 4 jam, dan kemudian Anda harus menghasilkan kata sandi baru untuk melihat konsol debug lokal lagi.

  3. Buka http://localhost:1441 pada perangkat inti, atau buka pada komputer pengembangan Anda jika Anda meneruskan port melalui SSH.

  4. Masuk ke situs web dengan menggunakan nama pengguna dan kata sandi yang dicetak oleh perintah get-debug-password sebelumnya.

    Konsol debug lokal terbuka.

File log lokal

Komponen ini menggunakan file log yang sama dengan komponen inti Greengrass.

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
Untuk melihat log komponen ini
  • Jalankan perintah berikut pada perangkat inti untuk melihat file log komponen ini secara real time. Ganti /greengrass/v2 atau C:\greengrass\v2 dengan jalur ke folder AWS IoT Greengrass root.

    Linux
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

Changelog

Tabel berikut menjelaskan perubahan dalam setiap versi komponen.

Versi

Perubahan

2.4.2

Perbaikan bug dan peningkatan
  • Perbaikan bug umum dan perbaikan.

2.4.1

Versi diperbarui untuk Greengrass nucleus versi 2.12.0 rilis.

2.4.0

Fitur baru
  • Menambahkan konsol debugging manajer aliran.

2.3.1

Versi diperbarui untuk Greengrass nucleus versi 2.11.0 rilis.

2.3.0

Versi diperbarui untuk Greengrass nucleus versi 2.10.0 rilis.
Fitur baru
  • Termasuk PubSub dan klien AWS IoT Core debug MQTT.

2.2.7

Versi diperbarui untuk Greengrass nucleus versi 2.9.0 rilis.

2.2.6

Versi diperbarui untuk Greengrass nucleus versi 2.8.0 rilis.

2.2.5

Versi diperbarui untuk Greengrass nucleus versi 2.7.0 rilis.

2.2.4

Versi diperbarui untuk Greengrass nucleus versi 2.6.0 rilis.

2.2.3

Perbaikan bug dan peningkatan
  • Memperbaiki masalah yang mencegah startup ketika komponen tidak dapat mendekripsi keystore yang menyimpan kunci pribadi SSL.

  • Versi diperbarui untuk Greengrass nucleus versi 2.5.0 rilis.

2.2.2

Versi diperbarui untuk Greengrass nucleus versi 2.4.0 rilis.

2.2.1

Versi yang diperbarui untuk rilis inti Greengrass versi 2.3.0.

2.2.0

Versi yang diperbarui untuk rilis inti Greengrass versi 2.2.0.

2.1.0

Fitur baru
  • Menggunakan HTTPS untuk mengamankan koneksi Anda ke konsol debug lokal. HTTPS tidak diaktifkan secara default.

Perbaikan bug dan peningkatan
  • Anda dapat mengabaikan pesan flashbar di editor konfigurasi.

2.0.3

Versi awal.