envoyproxy / envoyproxy/envoy

XRayConfig_SegmentFields doesn't support setting search indexable Annotations

Open
#31,140 3 comments 1 reaction 0 assignees View on GitHub
area/aws area/tracing enhancement help wanted
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
437

Description

*Title*: *XRayConfig_SegmentFields doesn't support setting search indexable Annotations*

*Description*:

CloudWatch X-Ray supports setting Annotations in segment fields, which are indexed by CloudWatch and allows traces to be searched by these values.

Currently, *only metadata fields* can be set by setting `HttpConnectionManager_Tracing.CustomTags`. These are not indexed by CloudWatch X-Ray.

The documentation for XRayConfig_SegmentFields seems to suggest being able to set "AWS resource metadata dictionary", but this is the `aws` field in documented by AWS' Segment Fields, which only "contains information about the resource on which your application is running."

*Relevant Links*:

- https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html#api-segmentdocuments-fields.
- https://github.com/envoyproxy/go-control-plane/blob/main/envoy/config/trace/v3/xray.pb.go#L109
- https://github.com/envoyproxy/go-control-plane/blob/main/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.pb.go#L1978

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.