View a markdown version of this page

Kembangkan konsumen Kinesis Client Library di Python - Amazon Kinesis Data Streams

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

Kembangkan konsumen Kinesis Client Library di Python

penting

Amazon Kinesis Client Library (KCL) versi 1.x dan 2.x sudah usang. KCL 1.x akan mencapai akhir dukungan pada 30 Januari 2026. Kami sangat menyarankan Anda memigrasikan aplikasi KCL menggunakan versi 1.x ke versi KCL terbaru sebelum 30 Januari 2026. Untuk menemukan versi KCL terbaru, lihat halaman Perpustakaan Klien Amazon Kinesis di. GitHub Untuk informasi tentang versi KCL terbaru, lihatGunakan Perpustakaan Klien Kinesis. Untuk informasi tentang migrasi dari KCL 1.x ke KCL 3.x, lihat. Migrasi dari KCL 1.x ke KCL 3.x

Anda dapat menggunakan Kinesis Client Library (KCL) untuk membangun aplikasi yang memproses data dari aliran data Kinesis Anda. Perpustakaan Klien Kinesis tersedia dalam berbagai bahasa. Topik ini membahas Python.

KCL adalah perpustakaan Java; dukungan untuk bahasa selain Java disediakan menggunakan antarmuka multi-bahasa yang disebut. MultiLangDaemon Daemon ini Java-based dan berjalan di latar belakang ketika Anda menggunakan bahasa KCL selain Java. Oleh karena itu, jika Anda menginstal KCL untuk Python dan menulis aplikasi konsumen Anda sepenuhnya dalam Python, Anda masih perlu menginstal Java di sistem Anda karena. MultiLangDaemon Selanjutnya, MultiLangDaemon memiliki beberapa pengaturan default yang mungkin perlu Anda sesuaikan untuk kasus penggunaan Anda, misalnya, AWS Wilayah yang terhubung dengannya. Untuk informasi lebih lanjut MultiLangDaemon tentang aktif GitHub, buka halaman MultiLangDaemon proyek KCL.

Untuk mengunduh Python KCL dari GitHub, buka Kinesis Client Library (Python). Untuk mengunduh kode sampel untuk aplikasi konsumen Python KCL, buka halaman proyek sampel KCL untuk Python di. GitHub

Anda harus menyelesaikan tugas-tugas berikut saat mengimplementasikan aplikasi konsumen KCL di Python:

Menerapkan metode RecordProcessor kelas

Kel RecordProcess as harus memperluas RecordProcessorBase untuk mengimplementasikan metode berikut. Sampel menyediakan implementasi yang dapat Anda gunakan sebagai titik awal (lihatsample_kclpy_app.py).

def initialize(self, shard_id) def process_records(self, records, checkpointer) def shutdown(self, checkpointer, reason)
menginisialisasi

KCL memanggil initialize metode ketika prosesor rekaman dibuat instansiasi, meneruskan ID pecahan tertentu sebagai parameter. Prosesor rekaman ini hanya memproses pecahan ini, dan biasanya, kebalikannya juga benar (pecahan ini hanya diproses oleh prosesor rekaman ini). Namun, konsumen Anda harus memperhitungkan kemungkinan bahwa catatan data mungkin diproses lebih dari satu kali. Ini karena Kinesis Data Streams memiliki setidaknya sekali semantik, yang berarti bahwa setiap catatan data dari pecahan diproses setidaknya satu kali oleh pekerja di konsumen Anda. Untuk informasi lebih lanjut tentang kasus di mana pecahan tertentu dapat diproses oleh lebih dari satu pekerja, lihatGunakan resharding, scaling, dan parallel processing untuk mengubah jumlah pecahan.

def initialize(self, shard_id)
rekaman proses

KCL memanggil metode ini, meneruskan daftar catatan data dari pecahan yang ditentukan oleh metode. initialize Prosesor catatan yang Anda terapkan memproses data dalam catatan ini sesuai dengan semantik konsumen Anda. Misalnya, pekerja mungkin melakukan transformasi pada data dan kemudian menyimpan hasilnya dalam bucket Amazon Simple Storage Service (Amazon S3).

def process_records(self, records, checkpointer)

Selain data itu sendiri, catatan juga berisi nomor urut dan kunci partisi. Pekerja dapat menggunakan nilai-nilai ini saat memproses data. Misalnya, pekerja dapat memilih bucket S3 untuk menyimpan data berdasarkan nilai kunci partisi. Kam record us menampilkan pasangan kunci-nilai berikut untuk mengakses data rekaman, nomor urut, dan kunci partisi:

record.get('data') record.get('sequenceNumber') record.get('partitionKey')

Perhatikan bahwa datanya adalah Base64-encoded.

Dalam sampel, metode process_records memiliki kode yang menunjukkan bagaimana pekerja dapat mengakses data catatan, nomor urut, dan kunci partisi.

Kinesis Data Streams membutuhkan prosesor rekaman untuk melacak catatan yang telah diproses dalam pecahan. KCL menangani pelacakan ini untuk Anda dengan meneruskan Checkpointer objek keprocess_records. Prosesor rekaman memang checkpoint gil metode pada objek ini untuk menginformasikan KCL tentang seberapa jauh perkembangannya dalam memproses catatan dalam pecahan. Jika pekerja gagal, KCL menggunakan informasi ini untuk memulai ulang pemrosesan pecahan pada catatan terakhir yang diproses yang diketahui.

Untuk operasi split atau merger, KCL tidak mulai memproses pecahan baru sampai prosesor untuk pecahan asli telah memanggil untuk memberi sinyal bahwa semua pemrosesan pada pecahan asli selesai. checkpoint

Jika Anda tidak meneruskan parameter, KCL mengasumsikan bahwa panggilan ke checkpoint berarti bahwa semua catatan telah diproses, hingga catatan terakhir yang diteruskan ke prosesor rekaman. Oleh karena itu, prosesor rekaman harus memanggil checkpoint hanya setelah memproses semua catatan dalam daftar yang diteruskan kepadanya. Prosesor rekaman tidak perlu menelep checkpoint on setiap panggilan keprocess_records. Prosesor dapat, misalnya, menelep checkpoint on setiap panggilan ketiga. Anda dapat secara opsional menentukan nomor urutan yang tepat dari catatan sebagai parameter untukcheckpoint. Dalam hal ini, KCL mengasumsikan bahwa semua catatan telah diproses hingga catatan itu saja.

Dalam sampel, metode pribadi checkpoint menunjukkan cara memanggil Checkpointer.checkpoint metode menggunakan penanganan pengecualian yang sesuai dan logika coba ulang.

KCL mengandalkan process_records untuk menangani pengecualian apa pun yang timbul dari pemrosesan catatan data. Jika pengecualian dilempar process_records kan dari, KCL melewatkan catatan data yang diteruskan process_records sebelum pengecualian. Artinya, catatan ini tidak dikirim kembali ke prosesor rekaman yang melemparkan pengecualian atau ke prosesor rekaman lain di konsumen.

penonaktifan

KCL memanggil shutdown metode baik ketika pemrosesan berakhir (alasan shutdown adalahTERMINATE) atau pekerja tidak lagi merespons (shutdown reason adalahZOMBIE).

def shutdown(self, checkpointer, reason)

Pemrosesan berakhir ketika prosesor rekaman tidak menerima catatan lebih lanjut dari pecahan, karena pecahan dipecah atau digabungkan, atau aliran dihapus.

KCL juga meneruskan Checkpointer objek keshutdown. Jika shutdown reasonTERMINATE, prosesor rekaman harus menyelesaikan pemrosesan catatan data apa pun, dan kemudian memanggil checkpoint metode pada antarmuka ini.

Ubah properti konfigurasi

Sampel memberikan nilai default untuk properti konfigurasi. Anda dapat mengganti salah satu properti ini dengan nilai Anda sendiri (lihatsample.properties).

Nama aplikasi

KCL memerlukan nama aplikasi yang unik di antara aplikasi Anda, dan di antara tabel Amazon DynamoDB di Wilayah yang sama. Ini menggunakan nilai konfigurasi nama aplikasi dengan cara berikut:

  • Semua pekerja yang terkait dengan nama aplikasi ini diasumsikan bekerja bersama pada aliran yang sama. Pekerja ini dapat didistribusikan pada beberapa contoh. Jika Anda menjalankan instance tambahan dari kode aplikasi yang sama, tetapi dengan nama aplikasi yang berbeda, KCL memperlakukan instance kedua sebagai aplikasi yang sepenuhnya terpisah yang juga beroperasi pada aliran yang sama.

  • KCL membuat tabel DynamoDB dengan nama aplikasi dan menggunakan tabel untuk mempertahankan informasi status (seperti pos pemeriksaan dan pemetaan pecahan pekerja) untuk aplikasi. Setiap aplikasi memiliki tabel DynamoDB sendiri. Untuk informasi selengkapnya, lihat Gunakan tabel sewa untuk melacak pecahan yang diproses oleh aplikasi konsumen KCL.

Menyiapkan kredensi

Anda harus membuat AWS kredenSIAL Anda tersedia untuk salah satu penyedia kredensia dalam rantai penyedia kredensia default. Anda dapat menggunakan AWSCredentialsProvider properti untuk menetapkan penyedia kredensibilitas. Sample.properties harus membuat kredenSIAL Anda tersedia untuk salah satu penyedia kredenSIAL dalam rantai penyedia kreden sia default. Jika Anda menjalankan aplikasi konsumen pada instans Amazon EC2, sebaiknya Anda mengonfigurasi instans dengan peran IAM. AWS kredenSIAL yang mencerminkan izin yang terkait dengan peran IAM ini tersedia untuk aplikasi pada instans melalui metadata instansnya. Ini adalah cara paling aman untuk mengelola kredenSIAL untuk aplikasi konsumen yang berjalan pada instans EC2.

File properti sampel mengonfigurasi KCL untuk memproses aliran data Kinesis yang disebut “kata-kata” menggunakan prosesor rekaman yang disediakan. sample_kclpy_app.py