Zipkin | APISIX & API7 API Gateway Docs

Static Configurations

By default, zipkin plugin NGINX variables configuration is set to false in the default configuration.

The file to update depends on how the gateway is deployed:

For host or Docker deployments, configure the following settings:

config.yaml
plugin_attr:
  zipkin:
    set_ngx_var: true

Then reload the gateway for changes to take effect.

For Helm deployments, update the chart values that render plugin_attr.zipkin. Keep the rest of your values file unchanged.

For the APISIX Helm chart, set the following values:

values.yaml
apisix:
  pluginAttrs:
    zipkin:
      set_ngx_var: true

For the API7 Gateway Helm chart, set the following values:

values.yaml
pluginAttrs:
  zipkin:
    set_ngx_var: true

Then apply the values file with the chart used for this gateway release:

helm upgrade <release-name> <chart-name> -n <namespace> -f values.yaml

See plugin common configurations for configuration options available to all plugins.

endpoint
string
required
Zipkin span endpoint to POST to, such as http://127.0.0.1:9411/api/v2/spans.
sample_ratio
number
required
vaild vaule:
between 0.00001 and 1 inclusive
Frequency to sample requests. Setting to 1 means sampling every request.
service_name
string
default: APISIX
Service name for the Zipkin reporter to be displayed in Zipkin.
server_addr
string
default: the value of $server_addr
vaild vaule:
IPv4 address
IPv4 address for the Zipkin reporter. For example, you can set this to your external IP address.
span_version
integer
default: 2
vaild vaule:
1 or 2
Version of the span type.