Mengonfigurasi kebijakan polling

Library Klien Cloud untuk Rust menyediakan fungsi bantuan untuk memantau progres operasi yang berjalan lama (LRO). Helper ini menggunakan kebijakan untuk mengonfigurasi frekuensi polling dan menentukan error polling mana yang bersifat sementara dan aman untuk dicoba lagi, serta error mana yang tidak dapat dipulihkan.

Dua kebijakan mengontrol perilaku loop polling LRO:

  • Kebijakan backoff polling mengontrol berapa lama loop menunggu sebelum melakukan polling status LRO yang sedang berlangsung.
  • Kebijakan error polling mengontrol cara menangani error polling. Beberapa error polling tidak dapat dipulihkan, yang menunjukkan bahwa operasi berhenti atau pemanggil tidak memiliki izin untuk memeriksa statusnya. Error polling lainnya bersifat sementara dan menunjukkan masalah jaringan atau layanan sementara.

Anda dapat menetapkan setiap kebijakan secara independen, baik untuk semua LRO yang dimulai pada klien maupun untuk permintaan individual.

Sebelum memulai

Dokumen ini menggunakan Cloud Storage untuk mengilustrasikan konfigurasi kebijakan polling, meskipun konsep yang sama berlaku untuk layanan Google Cloud apa pun yang menggunakan LRO.

Sebelum menjalankan kode dalam dokumen ini, selesaikan prasyarat berikut:

  • Ikuti Memulai Rust untuk menyiapkan lingkungan pengembangan Anda.
  • Ikuti Menggunakan Cloud Storage dengan Rust untuk menyiapkan project Google Cloud dengan penagihan diaktifkan, mengaktifkan Cloud Storage API, dan mengonfigurasi kredensial.
  • Buat bucket Cloud Storage dengan namespace hierarkis yang diaktifkan dan buat folder sumber untuk diganti namanya. Berikan peran Identity and Access Management (IAM) kepada akun utama Anda dengan izin untuk mengelola folder, seperti Storage Admin (roles/storage.admin).

Dependensi

Tambahkan crate yang diperlukan ke file Cargo.toml Anda:

cargo add google-cloud-storage google-cloud-lro google-cloud-gax anyhow

Mengonfigurasi frekuensi polling untuk semua permintaan di klien

Jika Anda menggunakan kebijakan backoff polling yang sama di sebagian besar permintaan pada klien, konfigurasikan kebijakan tersebut di builder klien. Contoh berikut mengonfigurasi backoff polling eksponensial untuk semua LRO yang dimulai oleh klien StorageControl:

pub async fn client_backoff(bucket: &str, folder: &str, dest: &str) -> Result<()> {
    use google_cloud_gax::exponential_backoff::ExponentialBackoffBuilder;
    use google_cloud_lro::Poller;
    use std::time::Duration;

    let client = StorageControl::builder()
        .with_polling_backoff_policy(
            ExponentialBackoffBuilder::new()
                .with_initial_delay(Duration::from_millis(250))
                .with_maximum_delay(Duration::from_secs(10))
                .build()?,
        )
        .build()
        .await?;

    let response = client
        .rename_folder()
        .set_name(format!("projects/_/buckets/{bucket}/folders/{folder}"))
        .set_destination_folder_id(dest)
        .poller()
        .until_done()
        .await?;

    println!("LRO completed, response={response:?}");

    Ok(())
}

Kecuali jika Anda mengganti kebijakan pada setiap permintaan, konfigurasi ini berlaku untuk setiap LRO yang dimulai oleh klien. Dalam contoh ini, library klien menunggu 250 md setelah polling pertama dan 500 md setelah polling kedua. Penundaan kemudian berlipat ganda menjadi 1 dtk, 2 dtk, 4 dtk, dan 8 dtk sebelum dibatasi pada 10 dtk untuk semua polling berikutnya.

Mengonfigurasi frekuensi polling untuk permintaan tertentu

Anda juga dapat mengonfigurasi frekuensi polling pada pembuat permintaan individual, yang menggantikan kebijakan backoff polling tingkat klien. Masukkan RequestOptionsBuilder ke dalam cakupan dan panggil with_polling_backoff_policy pada builder permintaan:

pub async fn rpc_backoff(bucket: &str, folder: &str, dest: &str) -> Result<()> {
    use google_cloud_gax::exponential_backoff::ExponentialBackoffBuilder;
    use std::time::Duration;
    use google_cloud_gax::options::RequestOptionsBuilder;
    use google_cloud_lro::Poller;

    let client = StorageControl::builder().build().await?;

    let response = client
        .rename_folder()
        .with_polling_backoff_policy(
            ExponentialBackoffBuilder::new()
                .with_initial_delay(Duration::from_millis(250))
                .with_maximum_delay(Duration::from_secs(10))
                .build()?,
        )
        .set_name(format!("projects/_/buckets/{bucket}/folders/{folder}"))
        .set_destination_folder_id(dest)
        .poller()
        .until_done()
        .await?;

    println!("LRO completed, response={response:?}");

    Ok(())
}

Mengonfigurasi kebijakan error polling untuk semua permintaan di klien

Untuk mengontrol error polling yang dicoba ulang oleh loop dan kapan polling berhenti, teruskan jenis yang mengimplementasikan trait PollingErrorPolicy, seperti Aip194Strict.

Kebijakan error polling hanya mengatur error selama loop tunggu LRO. Untuk menangani error sementara saat mengirim permintaan awal yang memulai LRO, konfigurasikan juga kebijakan percobaan ulang standar pada klien:

pub async fn client_errors(bucket: &str, folder: &str, dest: &str) -> Result<()> {
    use google_cloud_gax::polling_error_policy::Aip194Strict;
    use google_cloud_gax::polling_error_policy::PollingErrorPolicyExt;
    use google_cloud_gax::retry_policy;
    use google_cloud_gax::retry_policy::RetryPolicyExt;
    use std::time::Duration;
    use google_cloud_lro::Poller;

    let builder = StorageControl::builder().with_polling_error_policy(
        Aip194Strict
            .with_attempt_limit(100)
            .with_time_limit(Duration::from_secs(300)),
    );

    let client = builder
        .with_retry_policy(
            retry_policy::Aip194Strict
                .with_attempt_limit(100)
                .with_time_limit(Duration::from_secs(300)),
        )
        .build()
        .await?;

    let response = client
        .rename_folder()
        .set_name(format!("projects/_/buckets/{bucket}/folders/{folder}"))
        .set_destination_folder_id(dest)
        .poller()
        .until_done()
        .await?;

    println!("LRO completed, response={response:?}");

    Ok(())
}

Mengonfigurasi kebijakan error polling untuk permintaan tertentu

Untuk mengganti kebijakan error polling untuk satu permintaan, masukkan RequestOptionsBuilder ke dalam cakupan dan panggil with_polling_error_policy pada builder permintaan:

pub async fn rpc_errors(bucket: &str, folder: &str, dest: &str) -> Result<()> {
    use google_cloud_gax::polling_error_policy::Aip194Strict;
    use google_cloud_gax::polling_error_policy::PollingErrorPolicyExt;
    use google_cloud_gax::retry_policy;
    use google_cloud_gax::retry_policy::RetryPolicyExt;
    use std::time::Duration;
    use google_cloud_gax::options::RequestOptionsBuilder;
    use google_cloud_lro::Poller;

    let client = StorageControl::builder()
        .with_retry_policy(
            retry_policy::Aip194Strict
                .with_attempt_limit(100)
                .with_time_limit(Duration::from_secs(300)),
        )
        .build()
        .await?;

    let response = client
        .rename_folder()
        .with_polling_error_policy(
            Aip194Strict
                .with_attempt_limit(100)
                .with_time_limit(Duration::from_secs(300)),
        )
        .set_name(format!("projects/_/buckets/{bucket}/folders/{folder}"))
        .set_destination_folder_id(dest)
        .poller()
        .until_done()
        .await?;

    println!("LRO completed, response={response:?}");

    Ok(())
}