Setelah mendaftarkan, memublikasikan, dan mengaktifkan ekstensi di DataWorks Open Platform, DataWorks akan mengirimkan pesan event ke ekstensi Anda ketika suatu aksi di ruang kerja memicu titik ekstensi. Anda kemudian dapat melihat hasil yang dikembalikan oleh ekstensi tersebut. Topik ini menjelaskan titik ekstensi yang didukung oleh Operation Center dan cara menggunakannya untuk memicu validasi kustom.
Prasyarat
-
Anda telah mengaktifkan subscription pesan. Untuk informasi selengkapnya, lihat Enable message subscription.
-
Anda telah mengembangkan dan menerapkan ekstensi. Untuk informasi selengkapnya, lihat Develop and deploy an extension using Function Compute.
Latar Belakang
DataWorks dapat mengirimi Anda notifikasi untuk titik ekstensi event. Anda juga dapat menggunakan ekstensi untuk membuat checkpoint proses berdasarkan titik ekstensi yang didukung, sehingga memungkinkan Anda menjalankan logika kustom untuk operasi tertentu. Untuk menggunakan fitur ini, pertama-tama daftarkan ekstensi Anda di Konsol DataWorks, lalu aktifkan di Administration > Extensions. Di panel navigasi Administration DataWorks, klik Extensions untuk membuka halaman manajemen ekstensi. Di bagian Extension Scope, pilih Workspace sebagai tipe, pilih ruang kerja target, lalu aktifkan sakelar Enable untuk ekstensi Anda. Di kotak dialog Extension Data Authorization yang muncul, konfirmasi detail otorisasi—misalnya OpenAPI untuk event perubahan file: UpdateIDEEventResult. Pilih I have read and agree to the risks associated with the preceding data authorization., lalu klik Agree and Authorize.
-
Hanya administrator ruang kerja yang dapat mengaktifkan ekstensi di Administration > Extensions.
-
Untuk informasi selengkapnya tentang ekstensi, lihat Extension overview.
-
Prosedur sebelumnya berlaku untuk ekstensi tingkat ruang kerja. Untuk informasi selengkapnya, lihat Event titik ekstensi yang didukung.
Ikhtisar
Modul Operation Center memungkinkan layanan Anda menerima pesan untuk titik ekstensi event berikut. Anda juga dapat mendaftarkan program lokal sebagai ekstensi DataWorks untuk menerima pesan event ini, memprosesnya dengan logika kustom, dan mengembalikan hasilnya ke platform dengan memanggil API UpdateWorkbenchEventResult. Mekanisme ini memungkinkan Anda menerapkan kontrol proses di DataWorks. Operation Center mendukung titik ekstensi berikut:
|
Event |
Description |
|
node change event |
Catatan
Dalam konteks ini, node mengacu pada task di daftar Scheduled Tasks di Operation Center lingkungan produksi. |
|
backfill data event |
|
Dalam konteks ini, node mengacu pada task di daftar production Operation Center Scheduled Tasks. Ketika Anda melakukan operasi tersebut pada task di halaman Scheduled Tasks di lingkungan produksi, validasi ekstensi akan dipicu. Operasi yang sama pada scheduled task di lingkungan pengembangan tidak memicu validasi ekstensi. Demikian pula, membekukan atau melepas pembekuan instans di halaman instans tidak memicu validasi ekstensi.
Titik ekstensi yang didukung
Operation Center: Membekukan dan melepas pembekuan node
Contoh ini menunjukkan cara memicu ekstensi saat Anda membekukan node. Di Operation Center, pada halaman Scheduled Tasks, klik kanan node target, misalnya xc_demo_start, lalu pilih Suspend (Freeze) dari menu pintasan. Aksi ini merupakan titik ekstensi. Anda juga dapat memicu aksi ini dengan mengklik ikon freeze di Bilah alat. Setelah aksi dipicu, panel Operation Check Details (ekstensi) muncul di sebelah kanan, menampilkan nama node, jenis operasi (Suspend/Freeze), dan status checkpoint validasi, seperti 'Operation check in progress'. Anda dapat mengklik View Details atau View Documentation untuk melihat hasil validasi, mengklik Recheck untuk memicu validasi ulang, atau mengklik Close untuk menutup panel.
Operation Center: Undeploy node
Pada daftar Scheduled Tasks, klik kanan task target, misalnya test_select, lalu pilih Undeploy node dari menu pintasan. Setelah undeployment dimulai, pesan Undeployment check in progress dan ikon status akan muncul di baris task tersebut, menandakan bahwa ekstensi sedang memvalidasi operasi. Klik ikon status untuk membuka kotak dialog Operation Check Details. Kotak dialog ini menampilkan nama task, jenis operasi (Undeploy), checkpoint, serta statusnya. Kolom Operation menyediakan tautan ke View Details dan View Documentation. Di bagian bawah kotak dialog terdapat tombol Recheck dan Close.
Operation Center: Backfill data
Di panel navigasi kiri Operation Center, pilih Scheduled Tasks. Di DAG di sebelah kanan, klik kanan node task target dan pilih opsi backfill data—misalnya untuk node saat ini, node saat ini dan downstream-nya, dalam mode massive node, atau dalam mode advanced. Aksi ini memicu event titik ekstensi pra-periksa (pre-check). Setelah Anda mengirimkan task, Anda dapat melihat status pemeriksaan task backfill data dengan memilih Backfill Instances di panel navigasi kiri. Klik status pemeriksaan untuk membuka kotak dialog Operation Check Details, yang menampilkan hasil validasi dari ekstensi, termasuk nama checkpoint dan statusnya.
Referensi
-
Untuk mengaktifkan ekstensi, lihat Enable an extension.
-
Untuk informasi selengkapnya tentang event titik ekstensi di Pusat Operasi, lihat Event titik ekstensi yang didukung.
-
Untuk format pesan event backfill data, lihat Backfill data event.
-
Untuk format pesan event perubahan node, lihat Node change event (create, modify, delete, freeze, unfreeze, and undeploy).