All Products
Search
Document Center

API Gateway:Canary-header

Last Updated:Sep 10, 2026

Plug-in canary-header menambahkan header yang ditentukan ke persentase permintaan yang telah dikonfigurasi dan melakukan pencocokan ulang entri rute, sehingga memungkinkan rilis canary berbasis persentase tanpa mengharuskan klien membawa header canary.

Fields

Configuration item

Data type

Required

Default value

Description

weighted_headers

array of object

Yes

-

Header yang akan ditambahkan beserta bobotnya.

Tabel berikut menjelaskan bidang-bidang dalam array weighted_headers.

Configuration item

Data type

Required

Default value

Description

added_key

string

Yes

-

Kunci header yang akan ditambahkan.

added_value

string

Yes

-

Nilai header yang akan ditambahkan.

weight

number

Yes

-

Bobot untuk header ini. Satuan: %. Total bobot semua header tidak boleh melebihi 100.

Catatan

Jika total bobot semua header kurang dari 100, sisa persentase permintaan diteruskan tanpa penambahan header.

Configuration examples

Global configuration

Contoh berikut menambahkan header x-higress-canary:gray ke 30% permintaan dan header x-higress-canary:base ke sisa 70%.

weighted_headers: 
- added_key: x-higress-canary
  added_value: gray
  weight: 30
- added_key: x-higress-canary
  added_value: base
  weight: 70

Contoh berikut menambahkan header x-higress-canary:gray ke 30% permintaan. Sisa 70% diteruskan tanpa penambahan header.

weighted_headers: 
- added_key: x-higress-canary
  added_value: gray
  weight: 30

Enable the plug-in for specific routes or domain names

Ketika entri rute route-a cocok, header x-higress-canary:gray ditambahkan ke 30% permintaan dan header x-higress-canary:base ke sisa 70%. Entri rute kemudian dicocokkan ulang. Misalnya, jika terdapat entri rute bernama route-a-gray yang menggunakan header x-higress-canary:gray untuk pencocokan, maka 30% permintaan route-a akan cocok dengan route-a-gray, sehingga memungkinkan rilis canary berbasis persentase.

# Gunakan bidang _rules_ untuk mengonfigurasi aturan detail halus.
_rules_:
# Aturan 1: Cocokkan nama entri rute.
- _match_route_:
  - route-a
  weighted_headers: 
  - added_key: x-higress-canary
    added_value: gray
    weight: 30
  - added_key: x-higress-canary
    added_value: base
    weight: 70
# Aturan 2: Cocokkan Nama domain.
- _match_domain_:
  - "*.example.com"
  weighted_headers:
  - added_key: x-custom-header
    added_value: gray
    weight: 30
  - added_key: x-custom-header
    added_value: blue
    weight: 30
  - added_key: x-custom-header
    added_value: base
    weight: 40