envoyproxy/envoy

XRayConfig_SegmentFields doesn't support setting search indexable Annotations

Open

#31,140 opened on Dec 1, 2023

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

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:

Contributor guide

Tech stack
cppgo
Domain
observabilitybackend
Issue type
feature
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-2 days
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.
clear
Prerequisites
C++Protocol BuffersEnvoy X Ray tracing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
This issue requests adding support for setting search indexable Annotations in XRayConfig SegmentFields, similar to existing CustomTags for metadata. The relevant files are the protobuf definitions in xray.pb.go and http connection manager.pb.go. First, examine the X Ray segment document fields documentation to understand the Annotations field. Then, extend the protobuf definitions to allow setting Annotations, and update the corresponding C++ configuration parsing and segment field population. The existing CustomTags implementation can serve as a reference. There is no linked PR or assignee, so this is open for contribution.