request-id

目录

名称

request-id 插件通过 APISIX 为每一个请求代理添加唯一 ID(UUID),以用于追踪 API 请求。该插件在 header_name 已经在请求中存在时不会为请求添加新的 ID。

属性

名称类型必选项默认值有效值描述
header_namestring可选“X-Request-Id”Request ID header name
include_in_responseboolean可选false是否需要在返回头中包含该唯一ID
algorithmstring可选“uuid”[“uuid”, “snowflake”]ID 生成算法

如何启用

创建一条路由并在该路由上启用 request-id 插件:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "uri": "/hello",
  4. "plugins": {
  5. "request-id": {
  6. "include_in_response": true
  7. }
  8. },
  9. "upstream": {
  10. "type": "roundrobin",
  11. "nodes": {
  12. "127.0.0.1:8080": 1
  13. }
  14. }
  15. }'

测试插件

  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. X-Request-Id: fe32076a-d0a5-49a6-a361-6c244c1df956
  4. ......

使用 snowflake 算法生成ID

支持使用 snowflake 算法来生成ID。 在决定使用snowflake时,请优先阅读一下文档。因为一旦启用配置信息则不可随意调整配置信息。否则可能会导致生成重复ID。

snowflake 算法默认是不启用的,需要在 conf/config.yaml 中开启配置。

  1. plugin_attr:
  2. request-id:
  3. snowflake:
  4. enable: true
  5. snowflake_epoc: 1609459200000
  6. data_machine_bits: 12
  7. sequence_bits: 10
  8. data_machine_ttl: 30
  9. data_machine_interval: 10

配置参数

名称类型必选项默认值有效值描述
enableboolean可选false当设置为true时, 启用snowflake算法。
snowflake_epocinteger可选1609459200000起始时间戳(单位: 毫秒)
data_machine_bitsinteger可选12最多支持机器(进程)数量 1 << data_machine_bits
sequence_bitsinteger可选10每个节点每毫秒内最多产生ID数量 1 << sequence_bits
data_machine_ttlinteger可选30etcddata_machine 注册有效时间(单位: 秒)
data_machine_intervalinteger可选10etcddata_machine 续约间隔时间(单位: 秒)
  • snowflake_epoc 默认起始时间为 2021-01-01T00:00:00Z, 按默认配置可以支持 69年 大约可以使用到 2090-09-07 15:47:35Z
  • data_machine_bits 对应的是 snowflake 定义中的 WorkerID 和 DatacenterID 的集合,插件会为每一个进程分配一个唯一ID,最大支持进程数为 pow(2, data_machine_bits)。默认占 12 bits 最多支持 4096 个进程。
  • sequence_bits 默认占 10 bits, 每个进程每秒最多生成 1024 个ID

配置示例

snowflake 支持灵活配置来满足各式各样的需求

  • snowflake 原版配置
  • 起始时间 2014-10-20T15:00:00.000Z, 精确到毫秒为单位。大约可以使用 69年
  • 最多支持 1024 个进程
  • 每个进程每秒最多产生 4096 个ID
  1. plugin_attr:
  2. request-id:
  3. snowflake:
  4. enable: true
  5. snowflake_epoc: 1413817200000
  6. data_machine_bits: 10
  7. sequence_bits: 12

禁用插件

在路由 plugins 配置块中删除 `request-id 配置,reload 即可禁用该插件,无需重启 APISIX。

  1. curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "uri": "/get",
  4. "plugins": {
  5. },
  6. "upstream": {
  7. "type": "roundrobin",
  8. "nodes": {
  9. "127.0.0.1:8080": 1
  10. }
  11. }
  12. }'