envoyproxy/envoy

XRayConfig_SegmentFields can't be configured correctly from an xDS control plane

Open

#31,142 opened on Dec 1, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C++ (27,997 stars) (5,373 forks)batch import
area/awsarea/tracingenhancementhelp wanted

Description

Title: XRayConfig_SegmentFields can't be configured correctly from an xDS control plane

Description:

Currently the XRayConfig_SegmentFields.Origin and XRayConfig_SegmentFields.Aws fields will allow configuring that the trace segment comes from the correct origin as per the Optional Segment Fields in the AWS Segment fields documentation.

The aws object that needs to be sent to make this origin be considered valid requires the following data:

ecs – Information about an Amazon ECS container.
- container – The hostname of your container.
- container_id – The full container ID of your container.
- container_arn – The ARN of your container instance.

This is possible to do using sed and yaml on statically configured envoy hosts.

However, an xDS server cannot populate this with meaningful data and it should be handled internally by envoy's XRay tracing features. I believe that detecting the correct data should be up to each individual envoy proxy at runtime, and should not be configurable here either in the yaml or in the xDS gRPC structs.

Relevant Links:

Contributor guide

Tech stack
cppgo
Domain
backendcloudinfrastructure
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Understanding of Envoy XRay tracingFamiliarity with xDS control plane
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Review the linked go control plane file (envoy/config/trace/v3/xray.pb.go) and AWS X Ray segment document fields documentation. Investigate how envoy currently populates the `aws` object in segment fields. Consider whether envoy should auto detect container metadata at runtime instead of relying on xDS configuration. Look for any existing discussions in the comments.
XRayConfig_SegmentFields can't be configured correctly from an xDS control plane · envoyproxy/envoy#31142 | Good First Issue