跳到主要内容

参数

请参阅插件通用配置,了解所有插件通用的配置选项。

  • sampler

    object


    采样配置。

    • name

      string

      默认值:always_off

      有效值:

      always_onalways_offtrace_id_ratioparent_base


      采样策略。

      要始终采样,请使用 always_on

      要从不采样,请使用 always_off

      要根据给定比例随机采样,请使用 trace_id_ratio

      要遵循父跨度的采样决策,请使用 parent_base。如果没有父跨度,则由根采样器决定是否采样。

    • options

      object


      采样策略的参数。

      • fraction

        number

        默认值:0


        采样策略为 trace_id_ratio 时的采样比例。小于 0 的值按 0 处理,大于或等于 1 的值会对所有链路采样。

      • root

        object


        采样策略为 parent_base 且跨度没有父跨度时使用的根采样器。

        • name

          string

          默认值:always_off

          有效值:

          always_onalways_offtrace_id_ratio


          根采样策略。

        • options

          object


          根采样策略参数。

          • fraction

            number

            默认值:0


            根采样策略为 trace_id_ratio 时的采样比例。小于 0 的值按 0 处理,大于或等于 1 的值会对所有链路采样。

  • additional_attributes

    array[string]


    要作为字符串属性附加到链路跨度的内置变量名称。变量值在日志阶段解析,因此可以使用请求处理后期才填充的变量。数字和布尔值会转换为字符串;布尔值 false 不会被丢弃。

  • additional_header_prefix_attributes

    array[string]


    在日志阶段作为字符串属性附加到链路跨度的请求头或请求头前缀。例如,使用 x-my-headerx-my-headers-* 来包含所有前缀为 x-my-headers- 的请求头。同一请求头的多个值使用 , 连接。

插件元数据

  • trace_id_source

    string

    默认值:random

    有效值:

    x-request-idrandom


    链路 ID 的来源。使用 x-request-id 时,请提供一个非零的 32 字符十六进制链路 ID。APISIX 3.18.0 和 API7 网关 3.10.7 会规范化并验证候选值;无效时会改用生成的链路 ID。API7 网关 3.9.20 不验证显式提供的请求头;请求头缺失时使用 NGINX 请求 ID。

  • resource

    object


    添加到每个跨度的资源属性,例如 {"service.name": "APISIX"}。如果对象存在但未设置 service.name,插件会添加 service.name: APISIX

  • collector

    object


    收集器配置。

    • address

      string

      默认值:127.0.0.1:4318


      OpenTelemetry Collector 的基础地址。地址不含协议时,插件会使用 HTTP 并追加 /v1/traces

    • request_timeout

      integer

      默认值:3


      发送到 OpenTelemetry Collector 的请求超时时间(秒)。

    • request_headers

      object


      向 OpenTelemetry Collector 发送链路时包含的请求头,例如 {"Authorization": "token"}

  • batch_span_processor

    object


    批量跨度处理器配置。

    • drop_on_queue_full

      boolean

      默认值:true


      如果为 true,则在队列已满时丢弃新跨度;如果为 false,则处理队列中的批次以腾出空间。

    • max_queue_size

      integer

      默认值:2048

      有效值:

      大于 max_export_batch_size


      为延迟处理缓冲的最大跨度数。

    • batch_timeout

      number

      默认值:5

      有效值:

      大于 0


      构建批次时允许等待的最长时间(秒)。

    • inactive_timeout

      number

      默认值:2

      有效值:

      大于 0


      队列未满时处理队列中批次的时间间隔(秒)。

    • max_export_batch_size

      integer

      默认值:256

      有效值:

      大于 0 且小于 max_queue_size


      单个导出批次中处理的最大跨度数。

  • set_ngx_var

    boolean

    默认值:false


    如果为 true,则填充 opentelemetry_context_traceparentopentelemetry_trace_idopentelemetry_span_id NGINX 变量。