Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The Zipkin plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
, ws
, wss
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
name
string requiredThe name of the plugin, in this case
zipkin
. -
instance_name
stringAn optional custom name to identify an instance of the plugin, for example
zipkin_my-service
. Useful when running the same plugin in multiple contexts, for example, on multiple services. -
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/SERVICE_NAME|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/ROUTE_NAME|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/CONSUMER_NAME|ID/plugins
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
local_service_name
string required default:kong
The name of the service as displayed in Zipkin.
-
http_endpoint
stringA string representing a URL, such as https://example.com/path/to/resource?q=search.
-
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.
-
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.
-
header_type
string required default:preserve
Must be one of:preserve
,ignore
,b3
,b3-single
,w3c
,jaeger
,ot
,aws
,datadog
,gcp
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
-
default_header_type
string required default:b3
Must be one of:b3
,b3-single
,w3c
,jaeger
,ot
,aws
,datadog
,gcp
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.
-
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.
-
static_tags
array of typerecord
The tags specified on this property will be added to the generated request traces.
-
name
string required
-
value
string required
-
-
http_span_name
string required default:method
Must be one of:method
,method_path
Specify whether to include the HTTP path in the span name.
-
connect_timeout
integer default:2000
between:0
2147483646
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
-
send_timeout
integer default:5000
between:0
2147483646
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
-
read_timeout
integer default:5000
between:0
2147483646
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
-
http_response_header_for_traceid
string
-
phase_duration_flavor
string required default:annotations
Must be one of:annotations
,tags
Specify whether to include the duration of each phase as an annotation or a tag.
-
queue
record required-
max_batch_size
integer default:1
between:1
1000000
Maximum number of entries that can be processed at a time.
-
max_coalescing_delay
number default:1
between:0
3600
Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
-
max_entries
integer default:10000
between:1
1000000
Maximum number of entries that can be waiting on the queue.
-
max_bytes
integerMaximum number of bytes that can be waiting on a queue, requires string content.
-
max_retry_time
number default:60
Time in seconds before the queue gives up calling a failed handler for a batch.
-
initial_retry_delay
number default:0.01
between:0.001
1000000
Time in seconds before the initial retry is made for a failing batch.
-
max_retry_delay
number default:60
between:0.001
1000000
Maximum time in seconds between retries, caps exponential backoff.
-
-