功能说明

geo-ip本插件实现了通过用户ip查询出地理位置信息，然后通过请求属性和新添加的请求头把地理位置信息传递给后续插件。

运行属性

插件执行阶段：认证阶段 插件执行优先级：440

配置字段

名称数据类型填写要求默认值描述
ip_protocolstring否ipv4可选值：1. ipv4：只对ipv4用户请求查找地理位置信息，传递给后续插件。而ipv6用户的请求会跳过该插件，继续由后续插件处理。 2. ipv6：(未来实现后)只对ipv6用户查找地理位置信息，传递给后续插件。而ipv4用户的请求会跳过该插件，继续由后续插件处理。（目前是跳过插件，请求由后续插件处理。）
ip_source_typestring否origin-source可选值：1. 对端socket ip：origin-source; 2. 通过header获取：header
ip_header_namestring否x-forwarded-for当ip_source_type为header时，指定自定义IP来源头

配置示例

  1. ip_protocol: ipv4
  2. ip_source_type: header
  3. ip_header_name: X-Real-Ip

生成geoCidr.txt的说明

在generateCidr目录里包含的ip.merge.txt文件是github上ip2region项目的全世界的ip网段库。 ipRange2Cidr.go 是把ip网段转换成多个cidr的程序。转换出的cidr 和地理位置信息存在 /data/geoCidr.txt文件里。geo-ip插件会在Higress启动读配置阶段读取geoCidr.txt文件并且解析到radixtree数据结构的内存里，以便以后查询用户ip对应的地理位置信息。转换程序运行命令如下：

  1. go run generateCidr/ipRange2Cidr.go

property 的使用方式

在geo-ip插件里调用proxywasm.SetProperty() 分别把country、city、province、isp设置进请求属性里，以便后续插件可以调用proxywasm.GetProperty()获取该请求的用户ip对应的地理信息。

基于geo-ip插件的能力，扩展AI提示词装饰器插件携带用户地理位置信息

如果需要在LLM的请求前后加入用户地理位置信息，请确保同时开启geo-ip插件和AI提示词装饰器插件。并且在相同的请求处理阶段里，geo-ip插件的优先级必须高于AI提示词装饰器插件。首先geo-ip插件会根据用户ip计算出用户的地理位置信息，然后通过请求属性传递给后续插件。比如在默认阶段里，geo-ip插件的priority配置1000，ai-prompt-decorator插件的priority配置500。

geo-ip插件配置示例：

  1. ipProtocal: “ipv4”

AI提示词插件的配置示例如下：

  1. prepend:
  2. - role: system
  3.   content: “提问用户当前的地理位置信息是，国家：${geo-country}，省份：${geo-province}, 城市：${geo-city}”
  4. append:
  5. - role: user
  6.   content: “每次回答完问题，尝试进行反问”

使用以上配置发起请求：

  2. -H “content-type: application/json” \
  3. -H “x-forwarded-for: 87.254.207.100,4.5.6.7” \
  4. -d ‘{
  5.   “model”: “gpt-3.5-turbo”,
  6.   “messages”: [
  7.     {
  8.       “role”: “user”,
  9.       “content”: “今天天气怎么样？”
  10.     }
  11.   ]
  12. }’

经过插件处理后，实际请求为：

  2. -H “content-type: application/json” \
  3. -H “x-forwarded-for: 87.254.207.100,4.5.6.7” \
  4. -d ‘{
  5.   “model”: “gpt-3.5-turbo”,
  6.   “messages”: [
  7.     {
  8.       “role”: “system”,
  9.       “content”: “提问用户当前的地理位置信息是，国家：中国，省份：北京, 城市：北京”
  10.     },
  11.     {
  12.       “role”: “user”,
  13.       “content”: “今天天气怎么样？”
  14.     },
  15.     {
  16.       “role”: “user”,
  17.       “content”: “每次回答完问题，尝试进行反问”
  18.     }
  19.   ]
  20. }’