You are browsing documentation for an outdated plugin version.
Configuration
This plugin is compatible with DB-less mode.
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
name or plugin
string requiredThe name of the plugin, in this case
zipkin
.- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
name
. - If using the KongPlugin object in Kubernetes, the field is
plugin
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
service.name or service.id
stringThe name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level
/plugins
endpoint. Not required if using/services/{serviceName|Id}/plugins
. -
route.name or route.id
stringThe name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level
/plugins
endpoint. Not required if using/routes/{routeName|Id}/plugins
. -
consumer.name or consumer.id
stringThe name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level
/plugins
endpoint. Not required if using/consumers/{consumerName|Id}/plugins
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
http_endpoint
stringThe full HTTP(S) endpoint to which Zipkin spans should be sent by Kong. If not specified, the Zipkin plugin will only act as a tracing header generator/transmitter.
-
sample_ratio
number default:0.001
between:0
1
How often to sample requests that do not contain trace IDs. Set to
0
to turn sampling off, or to1
to sample all requests. The value must be between zero (0) and one (1), inclusive.
-
default_service_name
stringSet a default service name to override
unknown-service-name
in the Zipkin spans.
-
include_credential
boolean required default:true
Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
-
traceid_byte_count
integer required default:16
Must be one of:8
,16
The length in bytes of each request’s Trace ID. The value can be either
8
or16
.
-
header_type
string required default:preserve
Must be one of:preserve
,b3
,b3-single
,w3c
,jaeger
,ot
All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests.
Possible values:
b3
,b3-single
,w3c
,preserve
,jaeger
,ot
, orignore
.-
b3
: Expects Zipkin’s B3 multiple headers on incoming requests, and will add them to the transmitted requests if the headers are missing from those requests. -
b3-single
: Expects or adds Zipkin’s B3 single-header tracing headers. -
w3c
: Expects or adds W3C’s traceparent tracing header. -
preserve
: Does not expect any format, and will transmit whatever header is recognized or present, with a default ofb3
if none is found. In case of a mismatch between the expected and incoming tracing headers (for example, whenheader_type
is set tob3
but a w3c-style tracing header is found in the incoming request), then the plugin will add both kinds of tracing headers to the request and generate a mismatch warning in the logs. -
jaeger
: Expects or adds Jaeger-style tracing headers (uber-trace-id
). -
ot
: Expects or adds OpenTelemetry tracing headers of the formot-tracer-*
.
-
-
default_header_type
string required default:b3
Must be one of:b3
,b3-single
,w3c
,jaeger
,ot
Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when
config.header_type
is set to"preserve"
. Whenheader_type
is set to any other value,default_header_type
is ignored.Possible values are
b3
,b3-single
,w3c
,jaeger
, orot
. See the entry forheader_type
for value definitions.
-
tags_header
string required default:Zipkin-Tags
The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property. The format is
name_of_tag=value_of_tag
, separated by semicolons (;
).For example: with the default value, a request with the header
Zipkin-Tags: fg=blue; bg=red
will generate a trace with the tagfg
with valueblue
, and another tag calledbg
with valuered
.
-
static_tags
array of typerecord
The tags specified on this property will be added to the generated request traces. For example:
[ { "name": "color", "value": "red" } ]
.-
name
string required
-
value
string required
-
-