参数
请参阅插件通用配置,了解所有插件通用的配置选项。
sampler
采样配置。
name
有效值:
always_on、always_off、trace_id_ratio或parent_base采样策略。
要始终采样,请使用
always_on。要从不采样,请使用
always_off。要根据给定比例随机采样,请使用
trace_id_ratio。要遵循父跨度的采样决策,请使用
parent_base。如果没有父跨度,则由根采样器决定是否采样。options
采样策略的参数。
fraction
采样策略为
trace_id_ratio时的采样比例。小于0的值按0处理,大于或等于1的值会对所有链路采样。root
采样策略为
parent_base且跨度没有父跨度时使用的根采样器。name
有效值:
always_on、always_off或trace_id_ratio根采样策略。
options
根采样策略参数。
fraction
根采样策略为
trace_id_ratio时的采样比例。小于0的值按0处理,大于或等于1的值会对所有链路 采样。
additional_attributes
要作为字符串属性附加到链路跨度的内置变量名称。变量值在日志阶段解析,因此可以使用请求处理后期才填充的变量。数字和布尔值会转换为字符串;布尔值
false不会被丢弃。additional_header_prefix_attributes
在日志阶段作为字符串属性附加到链路跨度的请求头或请求头前缀。例如,使用
x-my-header或x-my-headers-*来包含所有前缀为x-my-headers-的请求头。同一请求头的多个值使用,连接。
插件元数据
trace_id_source
有效值:
x-request-id或random链路 ID 的来源 。使用
x-request-id时,请提供一个非零的 32 字符十六进制链路 ID。APISIX 3.18.0 和 API7 网关 3.10.7 会规范化并验证候选值;无效时会改用生成的链路 ID。API7 网关 3.9.20 不验证显式提供的请求头;请求头缺失时使用 NGINX 请求 ID。resource
添加到每个跨度的资源属性,例如
{"service.name": "APISIX"}。如果对象存在但未设置service.name,插件会添加service.name: APISIX。collector
收集器配置。
address
OpenTelemetry Collector 的基础地址。地址不含协议时,插件会使用 HTTP 并追加
/v1/traces。request_timeout
发送到 OpenTelemetry Collector 的请求超时时间(秒)。
request_headers
向 OpenTelemetry Collector 发送链路时包含的请求头,例如
{"Authorization": "token"}。
batch_span_processor
批量跨度处理器配置。
drop_on_queue_full
如果为 true,则在队列已满时丢弃新跨度;如果为 false,则处理队列中的批次以腾出空间。
max_queue_size
有效值:
大于
max_export_batch_size为延迟处理缓冲的最大跨度数。
batch_timeout
有效值:
大于 0
构建批次时允许等待的最长时间(秒)。
inactive_timeout
有效值:
大于 0
队列未满时处理队列中批次的时间间隔(秒)。
max_export_batch_size
有效值:
大于 0 且小于
max_queue_size单个导出批次中处理的最大跨度数。
set_ngx_var
如果为 true,则填充
opentelemetry_context_traceparent、opentelemetry_trace_id和opentelemetry_span_idNGINX 变量。