Pembatasan Kapasitas

Beta

Produk atau fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum di Persyaratan Khusus Layanan. Produk dan fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Halaman ini menjelaskan cara menggunakan Infrastruktur Layanan untuk menerapkan pembatasan kapasitas untuk layanan terkelola yang terintegrasi dengan Service Management API.

Layanan terkelola dapat melayani banyak konsumen layanan. Untuk melindungi kapasitas sistem dan memastikan penggunaan wajar, layanan terkelola sering kali menggunakan pembatasan kapasitas untuk mendistribusikan kapasitasnya di antara konsumen layanan. Service Management dan Service Control API memungkinkan Anda mengelola dan menerapkan pembatasan kapasitas.

Mengonfigurasi batas kapasitas

Untuk menggunakan fitur pembatasan kapasitas, konfigurasikan _quota metrics_ dan _quota limits_ dalam konfigurasi layanan untuk project produsen layanan Anda.

Saat ini, pembatasan kapasitas yang didukung adalah jumlah permintaan per menit per konsumen layanan, dengan konsumen layanan adalah project Google Cloud seperti yang diidentifikasi oleh kunci API, ID project, atau nomor project. Untuk pembatasan kapasitas, konsep permintaan adalah konsep buram. Layanan dapat memilih permintaan HTTP sebagai permintaan, atau byte payload sebagai permintaan. Fitur pembatasan kapasitas tidak bergantung pada semantik permintaan.

Metrik kuota

Metrik adalah penghitung bernama untuk mengukur nilai tertentu dari waktu ke waktu. Misalnya, jumlah permintaan HTTP yang diterima layanan adalah metrik. Metrik kuota adalah metrik yang digunakan untuk tujuan pembatasan kuota dan kapasitas. Saat suatu aktivitas terjadi dengan layanan, satu atau beberapa metrik kuota dapat meningkat. Jika nilai metrik mencapai batas kuota yang telah ditentukan, layanan harus menolak aktivitas dengan error 429.

Batas kuota

Batas kuota menunjukkan batas yang dapat diterapkan pada metrik kuota. Misalnya, jumlah permintaan per konsumen layanan per menit adalah batas kuota. Saat ini, satu-satunya jenis batas kuota yang didukung adalah per menit per konsumen, khususnya 1/min/{project}.

Batas kapasitas aktual untuk pasangan (layanan, konsumen) dikontrol oleh 3 setelan:

• Batas default yang ditentukan untuk layanan terkelola.
• Penggantian produsen layanan untuk konsumen layanan.
• Penggantian konsumen layanan untuk konsumen layanan.

Batas kapasitas efektif adalah:

• Batas default jika tidak ada penggantian.
• Produsen layanan akan mengganti jika ada penggantian produsen layanan, tetapi tidak ada penggantian konsumen layanan.
• Nilai minimum(penggantian konsumen layanan, batas default) jika ada penggantian konsumen layanan, tetapi tidak ada penggantian produsen layanan.
• Nilai minimum(penggantian konsumen layanan, penggantian produsen layanan) jika ada pengganti produsen layanan dan konsumen layanan.

Menerapkan pembatasan kapasitas

Untuk menerapkan pembatasan kapasitas, setiap server yang menjadi bagian dari layanan terkelola harus memanggil metode services.allocateQuota Service Control API secara rutin. Jika respons metode services.allocateQuota menunjukkan bahwa penggunaan melebihi batas, server harus menolak permintaan masuk dengan error 429. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi untuk metode services.allocateQuota.

Sebaiknya setiap server harus menggunakan logika batch, caching, dan prediktif untuk meningkatkan performa dan keandalan sistem. Secara umum, satu server hanya boleh memanggil metode services.allocateQuota satu kali per detik untuk tuple (layanan, konsumen, metrik) yang sama.

Contoh berikut menunjukkan cara memanggil metode services.allocateQuota untuk memeriksa pembatasan kapasitas. Parameter permintaan penting yang harus ditetapkan dengan benar adalah nama layanan, ID konsumen, nama metrik, dan nilai metrik. Metode services.allocateQuota akan mencoba meningkatkan penggunaan sebesar jumlah yang ditentukan untuk tuple (layanan, konsumen, metrik). Jika peningkatan penggunaan melampaui batas, error akan ditampilkan. Contoh berikut menggunakan perintah gcurl untuk mendemonstrasikan panggilan. Untuk mempelajari cara menyiapkannya, lihat Mulai Menggunakan Service Control API.

Catatan: Konsumen layanan dapat ditentukan menggunakan project ID, nomor project, atau kunci API.

gcurl -d '{
  "allocateOperation": {
    "operationId": "123e4567-e89b-12d3-a456-426655440000",
    "methodName": "google.example.hello.v1.HelloService.GetHello",
    "consumerId": "project:endpointsapis-consumer",
    "quotaMetrics": [{
      "metricName": "endpointsapis.appspot.com/requests",
      "metricValues": [{
        "int64Value": 1
      }]
    }],
    "quotaMode": "NORMAL"
  }
}' https://servicecontrol.googleapis.com/v1/services/endpointsapis.appspot.com:allocateQuota
{
  "operationId": "123e4567-e89b-12d3-a456-426655440000",
  "quotaMetrics": [
    {
      "metricName": "serviceruntime.googleapis.com/api/consumer/quota_used_count",
      "metricValues": [
        {
          "labels": {
            "/quota_name": "endpointsapis.appspot.com/requests"
          },
          "int64Value": "1"
        }
      ]
    }
  ],
  "serviceConfigId": "2017-09-10r0"
}

Penanganan error

Jika kode respons HTTP adalah 200, dan respons berisi RESOURCE_EXHAUSTED QuotaError, server Anda harus menolak permintaan dengan error 429. Jika respons tidak berisi error kuota, server Anda harus terus menayangkan permintaan masuk. Untuk semua error kuota lainnya, server Anda harus menolak permintaan dengan error 409. Karena risiko keamanan, Anda harus sangat berhati-hati terkait informasi error yang disertakan dalam pesan error.

Untuk semua kode respons HTTP lainnya, kemungkinan server Anda memiliki beberapa bug pemrograman. Sebaiknya server terus melayani permintaan masuk selagi Anda melakukan debug masalah. Jika metode services.allocateQuota menampilkan error yang tidak terduga, layanan Anda harus mencatat error tersebut dan menerima permintaan pendapatan. Anda dapat men-debug error nanti.

Gagal Terbuka

Fitur pembatasan kapasitas ditujukan untuk melindungi layanan terkelola Anda agar tidak kelebihan beban dan mendistribusikan kapasitas layanan secara adil di antara konsumen layanan. Karena sebagian besar konsumen layanan tidak boleh mencapai batas kapasitas selama operasi normal, layanan terkelola Anda harus menerima semua permintaan masuk jika fitur pembatasan kapasitas tidak tersedia, yang juga disebut sebagai gagal dibuka. Dengan begitu, ketersediaan layanan Anda tidak terpengaruh oleh sistem pembatasan kapasitas.

Jika Anda menggunakan metode services.allocateQuota, layanan Anda harus mengabaikan error 500, 503, dan 504 tanpa mencoba lagi. Untuk mencegah dependensi keras pada fitur pembatasan kapasitas, Service Control API mengeluarkan injeksi error dalam jumlah terbatas secara reguler.