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