Merge pull request #342 from aws/srprash-patch-1

srprash · web-flow · commit b12f8cb2dd67 · 2021-12-17T14:46:49.000-08:00
Add Note to not use the BeginFacadeSegment API
diff --git a/xray/segment.go b/xray/segment.go
@@ -54,6 +54,7 @@ func noOpSegmentID() string {
 }
 
 // BeginFacadeSegment creates a Segment for a given name and context.
+// NOTE: This is an internal API only to be used in Lambda context within the SDK. Consider using BeginSegment instead.
 func BeginFacadeSegment(ctx context.Context, name string, h *header.Header) (context.Context, *Segment) {
 	seg := basicSegment(name, h)
 

Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@ func noOpSegmentID() string {`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`// BeginFacadeSegment creates a Segment for a given name and context.`
	`57`	`+// NOTE: This is an internal API only to be used in Lambda context within the SDK. Consider using BeginSegment instead.`
`57`	`58`	`func BeginFacadeSegment(ctx context.Context, name string, h header.Header) (context.Context, Segment) {`
`58`	`59`	`seg := basicSegment(name, h)`
`59`	`60`