kayx23 commented on code in PR #11247:
URL: https://github.com/apache/apisix/pull/11247#discussion_r1597611146
##########
docs/en/latest/plugins/opentelemetry.md:
##########
@@ -66,6 +66,14 @@ You can set up the collector by configuring it in you
configuration file (`conf/
| batch_span_processor.max_export_batch_size | integer | 256
| Maximum number of spans to process in a single
batch.
|
| batch_span_processor.inactive_timeout | number | 2
| Time interval in seconds between processing
batches.
|
+:::note
+
+When the `trace_id_source` is set to `x-request-id` and requests carry an
`x-request-id` header generated by Envoy, there may be issues pushing traces to
the collector.
+
+This occurs because Envoy generates its `x-request-id` header using
[UUID](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/observability/tracing#trace-context-propagation)
by default, which does not match the specified regex pattern `[0-9a-f]{32}`.
Review Comment:
Q: so should the regex pattern be updated?
##########
docs/en/latest/plugins/opentelemetry.md:
##########
@@ -53,7 +53,7 @@ You can set up the collector by configuring it in you
configuration file (`conf/
| Name | Type | Default
| Description
|
|--------------------------------------------|---------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| trace_id_source | enum | random
| Source of the trace ID. Valid values are `random`
or `x-request-id`. When set to `x-request-id`, the value of the `x-request-id`
header will be used as trace ID. Make sure that is matches the regex pattern
`[0-9a-f]{32}`. |
+| trace_id_source | enum | x-request-id
| Source of the trace ID. Valid values are `random`
or `x-request-id`. When set to `x-request-id`, the value of the `x-request-id`
header will be used as trace ID. Make sure that is matches the regex pattern
`[0-9a-f]{32}`. |
Review Comment:
```suggestion
| trace_id_source | enum | x-request-id
| Source of the trace ID. Valid values are
`random` or `x-request-id`. When set to `x-request-id`, the value of the
`x-request-id` header will be used as trace ID. Make sure that it matches the
regex pattern `[0-9a-f]{32}`. |
```
--
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]
