kayx23 commented on code in PR #11247:
URL: https://github.com/apache/apisix/pull/11247#discussion_r1615755150
##########
docs/zh/latest/plugins/opentelemetry.md:
##########
@@ -54,18 +54,26 @@ description: 本文介绍了关于 Apache APISIX `opentelemetry` 插件的基本
| 名称 | 类型 | 默认值
| 描述
|
| ------------------------------------------ | ------- |
------------------------------------------------- |
-------------------------------------------------------------------------------------------------------------------------------------------------
|
-| trace_id_source | enum | random
| trace ID 的来源。有效值为:`random` 或 `x-request-id`。当设置为
`x-request-id` 时,`x-request-id` 头的值将用作跟踪 ID。请确保当前请求 ID 是符合 TraceID
规范的:`[0-9a-f]{32}`。 |
+| trace_id_source | enum | x-request-id
| trace ID 的来源。有效值为:`random` 或 `x-request-id`。当设置为
`x-request-id` 时,`x-request-id` 头的值将用作跟踪 ID。请确保当前请求 ID 是符合 TraceID
规范的:`[0-9a-f]{32}`。 |
| resource | object |
| 追加到 trace 的额外
[resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md)。
|
| collector | object | {address =
"127.0.0.1:4318", request_timeout = 3} | OpenTelemetry Collector 配置。 |
| collector.address | string | 127.0.0.1:4318
| 数据采集服务的地址。如果数据采集服务使用的是 HTTPS 协议,可以将 address 设置为
https://127.0.0.1:4318。 |
| collector.request_timeout | integer | 3
| 数据采集服务上报请求超时时长,单位为秒。 |
| collector.request_headers | object |
| 数据采集服务上报请求附加的 HTTP 请求头。 |
| batch_span_processor | object |
| trace span 处理器参数配置。 |
-| batch_span_processor.drop_on_queue_full | boolean | true
| 如果设置为 `true` 时,则在队列排满时删除 span。否则,强制处理批次。|
-| batch_span_processor.max_queue_size | integer | 2048
| 处理器缓存队列容量的最大值。 |
-| batch_span_processor.batch_timeout | number | 5
| 构造一批 span 超时时间,单位为秒。 |
-| batch_span_processor.max_export_batch_size | integer | 256
| 单个批次中要处理的 span 数量。 |
-| batch_span_processor.inactive_timeout | number | 2
| 两个处理批次之间的时间间隔,单位为秒。 |
+| batch_span_processor.drop_on_queue_full | boolean | false
| 如果设置为 `true` 时,则在队列排满时删除 span。否则,强制处理批次。|
+| batch_span_processor.max_queue_size | integer | 1024
| 处理器缓存队列容量的最大值。 |
+| batch_span_processor.batch_timeout | number | 2
| 构造一批 span 超时时间,单位为秒。 |
+| batch_span_processor.max_export_batch_size | integer | 16
| 单个批次中要处理的 span 数量。 |
+| batch_span_processor.inactive_timeout | number | 1
| 两个处理批次之间的时间间隔,单位为秒。 |
+
+:::note
+
+当`trace_id_source`设置为`x-request-id`且请求携带由 Envoy
默认生成的`x-request-id`标头时,将链路数据推送到采集器时可能会出现问题。
Review Comment:
```suggestion
当 `trace_id_source` 设置为 `x-request-id` 且请求携带由 Envoy 默认生成的 `x-request-id`
标头时,将链路数据推送到采集器时可能会出现问题。
```
```suggestion
当`trace_id_source`设置为`x-request-id`且请求携带由 Envoy
默认生成的`x-request-id`标头时,将链路数据推送到采集器时可能会出现问题。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]