Zipkin Configuration

Configuration reference for the Zipkin plugin (`zipkin`): the static configurations and parameters, each attribute with its type, whether it is required, its default and its accepted values.

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

Parameters

See plugin common configurations (opens in Apache APISIX docs) for configuration options available to all plugins.

endpoint — string · required · since APISIX 1.2

Zipkin span endpoint to POST to, such as http://127.0.0.1:9411/api/v2/spans.

sample_ratio — number · required · since APISIX 1.2

Valid values: between 0.00001 and 1 inclusive

Frequency to sample requests. Setting to 1 means sampling every request.

service_name — string · optional · default: APISIX · since APISIX 1.2

Service name for the Zipkin reporter to be displayed in Zipkin.

server_addr — string · optional · default: the value of $server_addr · since APISIX 1.2

Valid values: IPv4 address

IPv4 address for the Zipkin reporter. For example, you can set this to your external IP address.

span_version — integer · optional · default: 2 · since APISIX 2.5

Valid values: 1 or 2

Version of the span type.