参数
请参阅 插件通用配置 了解所有插件可用的配置选项。
sampler
object
采样配置。
name
string
default:
always_offvaild vaule:
always_on,always_off,trace_id_ratio, orparent_base采样策略。
要始终采样,请使用
always_on。要从不采样,请使用
always_off。要根据给定比例随机采样,请使用
trace_id_ratio。要使用 span 父级的采样决策,请使用
parent_base。如果没有父级,则使用根采样器。options
object
采样策略的参数。
fraction
number
default:
0vaild vaule:
介于 0 到 1 之间(含边界值)
采样策略为
trace_id_ratio时的采样率。root
object
采样策略为
parent_base时的根采样器。name
string
vaild vaule:
always_on,always_off, ortrace_id_ratio根采样策略。
options
object
根采样策略参数。
fraction
number
default:
0vaild vaule:
介于 0 到 1 之间(含边界值)
根采样策略为
trace_id_ratio时的根采样率。
additional_attributes
additional_header_prefix_attributes
array[string]
追加到 trace span 属性的请求头或请求头前缀。例如,使用
x-my-header或x-my-headers-*来包含所有前缀为x-my-headers-的请求头。
插件元数据
trace_id_source
string
default:
randomvaild vaule:
x-request-idorrandomtrace ID 的来源。当设置为
x-request-id时,x-request-id头的值将被用作 trace ID。resource
object
追加到 trace 的额外资源,例如
{"service_name": "APISIX"}。collector
object
收集器配置。
address
string
default:
127.0.0.1:4318发送追踪的 OpenTelemetry 收集器地址。
request_timeout
integer
default:
3OpenTelemetry 收集器的请求超时时间(秒)。
request_headers
object
包含在发往 OpenTelemetry 收集器的请求中的请求头,例如
{"Authorization": "token"}。
batch_span_processor
object
批量 span 处理器配置。
drop_on_queue_full
boolean
如果为 true,则在队列满时丢弃 span,否则强制处理批次。
max_queue_size
integer
缓冲 span 以进行延迟处理的 最大队列大小。
batch_timeout
number
span 批次在发送之前在导出队列中等待的超时时间(秒)。
inactive_timeout
number
如果队列未满,span 在发送之前在导出队列中等待的超时时间(秒)。
max_export_batch_size
integer
发送到 OpenTelemetry 收集器的单个批次中包含的最大 span 数。
set_ngx_var