awsdocs / aws-xray-developer-guide

The open source version of the AWS X-Ray User Guide

NOTICE

This repository is archived, read-only, and no longer updated. For more information, read the announcement on the AWS News Blog.

You can find up-to-date AWS technical documentation on the AWS Documentation website, where you can also submit feedback and suggestions for improvement.

aws-xray-developer-guide's Issues

ECS Task Definition missing closing brace

The Task Definition in doc-source/xray-daemon-ecs.md is missing a closing brace between Lines 111 and 112.

aws-xray-developer-guide/doc-source/xray-daemon-ecs.md

Lines 77 to 112 in 432d45d

	**Example VPC task definition**
	```
	{
	"family": "scorekeep",
	"networkMode":"awsvpc",
	"containerDefinitions": [
	{
	"name": "xray-daemon",
	"image": "123456789012.dkr.ecr.us-east-2.amazonaws.com/xray-daemon",
	"cpu": 32,
	"memoryReservation": 256,
	"portMappings" : [
	{
	"containerPort": 2000,
	"protocol": "udp"
	}
	]
	}
	{
	"name": "scorekeep-api",
	"image": "123456789012.dkr.ecr.us-east-2.amazonaws.com/scorekeep-api",
	"cpu": 192,
	"memoryReservation": 512,
	"environment": [
	{ "name" : "AWS_REGION", "value" : "us-east-2" },
	{ "name" : "NOTIFICATION_TOPIC", "value" : "arn:aws:sns:us-east-2:123456789012:scorekeep-notifications" }
	],
	"portMappings" : [
	{
	"containerPort": 5000
	}
	]
	}
	]
	```

Invalid Method Signature in Configuring the X-Ray SDK for .NET Page

The Configuring the X-Ray SDK for .NET page has an invalid signature in the example labeled "Example .NET global.asax – Local sampling rules".

The InitializeRecorder method of the AWSXRayRecorder class in the AWSXRayRecorder.Core assembly only has these overloads:

public static void InitializeInstance(IConfiguration configuration)
public static void InitializeInstance(IConfiguration configuration = null, AWSXRayRecorder recorder = null)

The example makes the call as:

var recorder = new AWSXRayRecorderBuilder().WithSamplingStrategy(new LocalizedSamplingStrategy(samplingrules.json)).Build();
AWSXRayRecorder.InitializeInstance(recorder);

Because recorder is the second parameter in the overload, this example does not compile.

Please clarify behavior of subsegment `http.request.traced` property, meaning of "broken" trace

Hello, the segment documents :: HTTP request data documentation says:

traced – (subsegments only) boolean indicating that the downstream call is to another traced service. If this field is set to true, X-Ray considers the trace to be broken until the downstream service uploads a segment with a parent_id that matches the id of the subsegment that contains this block.

1. Can you please clarify what "broken" means? What affect does it have on behavior? How would it be observable in the console or raw trace data?

2. What would be the effect of setting that on a subsegment for a request to a non-instrumented service that will never upload a segment?

See also:

aws/aws-xray-sdk-node#493

Sending segment batch failed with: NoCredentialProviders: no valid provider

I am running daemon locally for my Django project to get traces.
I have configured the credentials in environment variables and ~/.aws/credentials file as well. But still facing that issue. Can anybody please help me in figuring out issue.
The error which I am facing is

Sending segment batch failed with: NoCredentialProviders: no valid provider

Code example has SQL injection

https://github.com/awsdocs/aws-xray-developer-guide/blob/main/doc-source/xray-sdk-dotnet-sqlqueries.md?plain=1#L21

xray-services-sns document line 189

The capture eventname should be publish and the event source should be SNS instead of SQS