静态配置
默认情况下,zipkin 插件不会填充其 NGINX 变量。当日志插件或访问日志需要当前请求的 Trace ID 时,请启用这些变量。
需要更新的文件取决于网关的部署方式:
- Host or Docker
- Kubernetes (Helm)
对于主机或 Docker 部署,请配置以下设置:
config.yaml
plugin_attr:
zipkin:
set_ngx_var: true
然后重新加载网关,使更改生效。
对于 Helm 部署,请更新用于渲染 plugin_attr.zipkin 的 Chart values,并保持 values 文件中的其他配置不变。
对于 APISIX Helm Chart,请设置以下 values:
values.yaml
apisix:
pluginAttrs:
zipkin:
set_ngx_var: true
对于 API7 网关 Helm Chart,请设置以下 values:
values.yaml
pluginAttrs:
zipkin:
set_ngx_var: true
然后使用当前网关版本对应的 Chart 应用 values 文件。请将 <chart-version> 替换为已安装发布版本所使用的版本:
helm upgrade <release-name> <chart-name> \
--version <chart-version> \
-n <namespace> \
-f values.yaml
参数
请参阅插件通用配置,了解所有插件通用的配置选项。
endpoint
插件向其发送 Span 的 Zipkin v2 HTTP 端点,例如
http://zipkin:9411/api/v2/spans。sample_ratio
有效值:
介于 0.00001 和 1 之间(含边界值)
采样请求的频率。设置为 1 表示采样每个请求。
service_name
Zipkin 中显示的 Zipkin 报告器的服务名称。
server_addr
有效值:
IPv4 地址
Zipkin 报告器的 IPv4 地址。例如,你可以将其设置为你的外部 IP 地址。
span_version
有效值:
1 或 2
要生成的网关 Span 层级。此设置不会改变 Zipkin v2 的传输格式。