Added AWS SDK Changes to support Bedrock spans and Application Signals #2458

AsakerMohd · 2025-01-08T18:33:27Z

Changes

Added changes to detect bedrock spans and populate attributes accordingly. Also added logic to populate aws specific attributes used by AWS Application Signals like "aws.region", "aws.service", "aws.operation", "aws.requestId", etc. We are currently using our own fork of Opentelemetry-Instrumentation-AWS here: https://github.com/aws-observability/aws-otel-dotnet-instrumentation/tree/main/src/OpenTelemetry.Instrumentation.AWS. This change syncs our local fork so that we can stop relying on it and instead reference this directly instead.

I did some manual testing and was able to verify that the spans created contain the required information.

Pushing this PR for now to get some review going while we add some unit tests for the Bedrock related changes. Will add changes to CHANGELOG.md. No changes to public API.

Merge requirement checklist

CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

codecov · 2025-01-08T18:47:15Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.20%. Comparing base (71655ce) to head (8f09005).
Report is 678 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #2458       +/-   ##
===========================================
+ Coverage   73.91%   84.20%   +10.28%     
===========================================
  Files         267       34      -233     
  Lines        9615      747     -8868     
===========================================
- Hits         7107      629     -6478     
+ Misses       2508      118     -2390

Files with missing lines	Coverage Δ
...rumentation.AWS/Implementation/AWSServiceHelper.cs	`93.33% <ø> (-6.67%)`	⬇️
...strumentation.AWS/Implementation/AWSServiceType.cs	`71.42% <ø> (+4.76%)`	⬆️
...on.AWS/Implementation/AWSTracingPipelineHandler.cs	`87.17% <ø> (-0.58%)`	⬇️

... and 271 files with indirect coverage changes

muhammad-othman · 2025-01-08T22:07:51Z

src/Shared/AWS/AWSSemanticConventions.Legacy.cs

+        public override string AttributeAWSRegion => "aws.region";
+        public override string AttributeAWSServiceName => "aws.service";
+        public override string AttributeAWSOperationName => "aws.operation";
+        public override string AttributeAWSRequestId => "aws.requestId";


We already added these attributes from the SDK side using different names (rpc.method & rpc.service)
https://github.com/aws/aws-sdk-net-staging/blob/main-staging/sdk/src/Core/Amazon.Runtime/Telemetry/TelemetryConstants.cs#L37

And for aws.requestId we use aws.request_id to be aligned with the semantic conventions aws.request_id schema

I'll change it to request_id. For the aws.region, i don't see it being added anywhere in the sdk side. I guess I don't need to use aws.service and aws.operation anymore and can just read the needed info from the rpc.* tags. I'll remove them.

AsakerMohd · 2025-01-08T23:00:52Z

Not sure why the bedrock sem cov test is failing for v1.28. I didn't change how the sem covs are set there.

ppittle · 2025-01-09T00:57:50Z

src/OpenTelemetry.Instrumentation.AWS/Implementation/AWSLlmModelProcessor.cs

+                {
+                    var results = resultsArray[0];
+                    if (results.TryGetProperty("tokenCount", out var outputTokens))
+                    {


what's the point of these empty if statements?

should this just be:

resutls.TryGetProperty("tokenCount", out var outputTokens);

ppittle · 2025-01-09T01:00:29Z

src/OpenTelemetry.Instrumentation.AWS/Implementation/AWSLlmModelProcessor.cs

+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine("Exception: " + ex.Message);


catch (Exception ex) { Console.WriteLine("Exception: " + ex.Message);

I forget, is this standard practice for exception handling within this library? I'm fine swallowing parsing exceptions - but I don't recall if there is a preferred channel to let the user know there was a problem.

ppittle · 2025-01-09T01:02:01Z

src/Shared/AWS/AWSSemanticConventions.Base.cs

+        /// <summary>
+        /// Not yet incorporated in Semantic Conventions repository.
+        /// </summary>
+        public virtual string AttributeAWSRegion => string.Empty;


The Semantic Convention has AttributeCloudRegion - can we use that instead?

ppittle · 2025-01-09T01:05:37Z

src/Shared/AWS/AWSSemanticConventions.Base.cs

+        /// <summary>
+        /// Not yet incorporated in Semantic Conventions repository. Check if more details need to be added
+        /// </summary>
+        public virtual string AttributeGenAiTopP => string.Empty;


This is defined in the semantic convention here: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-spans.md?plain=1#L60

ppittle · 2025-01-09T01:06:15Z

src/Shared/AWS/AWSSemanticConventions.Base.cs

+        /// <summary>
+        /// Not yet incorporated in Semantic Conventions repository. Check if more details need to be added
+        /// </summary>
+        public virtual string AttributeGenAiTemperature => string.Empty;


This is defined in the semantic convention here: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-spans.md?plain=1#L58

ppittle · 2025-01-09T01:12:21Z

src/Shared/AWS/AWSSemanticConventions.Legacy.cs

@@ -74,6 +84,12 @@ private abstract class AWSSemanticConventionsLegacy : AWSSemanticConventionsBase
        // GEN AI Attributes


Looking at the GenAI documentation page, it looks like the new GenAI attributes all existed prior to v1.27: https://github.com/open-telemetry/semantic-conventions/blob/v1.27.0/docs/gen-ai/gen-ai-spans.md

Is that correct?

ppittle · 2025-01-09T01:16:48Z

src/Shared/AWS/AWSSemanticConventions.Legacy.cs

@@ -89,6 +105,7 @@ private abstract class AWSSemanticConventionsLegacy : AWSSemanticConventionsBase
        public override string AttributeHttpTarget => "http.target";
        [Obsolete("Replaced by <c>http.request.method</c>.")]
        public override string AttributeHttpMethod => "http.method";
+        public override string AttributeHttpResponseContentLength => "http.response_content_length";


This attribute is deprecated in v1.27 and newer: https://github.com/open-telemetry/semantic-conventions/blob/v1.27.0/docs/attributes-registry/http.md?plain=1#L93:

Deprecated, use `http.response.header.<key>` instead.

Can you update this to use http.response.header.` attribute instead.

ppittle · 2025-01-09T01:19:24Z

src/Shared/AWS/AWSSemanticConventions.Base.cs

+        public virtual string AttributeAWSSQSQueueName => string.Empty;
+
+        /// <summary>
+        /// Not yet incorporated in Semantic Conventions repository.


bucket name is defined here: https://github.com/open-telemetry/semantic-conventions/blob/v1.27.0/docs/attributes-registry/aws.md?plain=1#L116

ppittle · 2025-01-09T01:20:00Z

src/Shared/AWS/AWSSemanticConventions.Base.cs

+        public virtual string AttributeAWSRegion => string.Empty;
+
+        /// <summary>
+        /// Not yet incorporated in Semantic Conventions repository.


request Id is defined here: https://github.com/open-telemetry/semantic-conventions/blob/v1.27.0/docs/attributes-registry/aws.md?plain=1#L23

ppittle · 2025-01-09T03:34:17Z

src/Shared/AWS/AWSSemanticConventions.Legacy.cs

+        public override string AttributeAWSSQSQueueName => "aws.sqs.queue_name";
+        public override string AttributeAWSS3BucketName => "aws.s3.bucket";
+        public override string AttributeAWSKinesisStreamName => "aws.kinesis.stream_name";
+        public override string AttributeAWSLambdaResourceMappingId => "aws.lambda.resource_mapping.id";


for the attributes that are not yet part of the Semantic Convention - I'm not sure if they should be added as "Legacy".

I'm also not sure if they should be added to an existing code page - ie it feels odd to add them to say v.1.29.0 when they aren't actually part of that spec either.

Any thoughts on this?

OR - it might be better to first send a PR to the Semantic Convention repo and get the attributes added - then they'll be part of a SemConv release and we wont have this problem. Given they're attributes are all in the AWS namespace I would expect the PR to be accepted rather quickly.

AsakerMohd added 9 commits December 4, 2024 20:55

Added changes to AWSXRayPropagator

b76ad39

added net462 support

9d415df

Merge branch 'main' into main

c78563f

Syncing local fork with upstream

9f3e819

Merge branch 'main' into awsSDKChanges

c0327d1

Adding changes from forked Instrumentation pkg

d3c11c8

Merge branch 'main' into awsSDKChanges

b64c314

added more changes

a04685a

added more changes

8f09005

AsakerMohd requested a review from a team as a code owner January 8, 2025 18:33

AsakerMohd requested a deployment to external January 8, 2025 18:33 — with GitHub Actions Waiting

github-actions bot assigned muhammad-othman, ppittle and srprash Jan 8, 2025

github-actions bot requested a review from muhammad-othman January 8, 2025 18:33

github-actions bot added the comp:instrumentation.aws Things related to OpenTelemetry.Instrumentation.AWS label Jan 8, 2025

github-actions bot requested review from ppittle and srprash January 8, 2025 18:33

AsakerMohd changed the title ~~Aws sdk changes~~ Added AWS SDK Changes to support Bedrock and Application Signals Jan 8, 2025

AsakerMohd changed the title ~~Added AWS SDK Changes to support Bedrock and Application Signals~~ Added AWS SDK Changes to support Bedrock spans and Application Signals Jan 8, 2025

muhammad-othman reviewed Jan 8, 2025

View reviewed changes

removed aws.operation and aws.service from attribute list

42feed1

AsakerMohd requested a deployment to external January 8, 2025 22:43 — with GitHub Actions Waiting

removed warnings

5d370d4

AsakerMohd requested a deployment to external January 8, 2025 22:48 — with GitHub Actions Waiting

ppittle suggested changes Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added AWS SDK Changes to support Bedrock spans and Application Signals #2458

Added AWS SDK Changes to support Bedrock spans and Application Signals #2458

AsakerMohd commented Jan 8, 2025

codecov bot commented Jan 8, 2025 •

edited

Loading

muhammad-othman Jan 8, 2025 •

edited

Loading

AsakerMohd Jan 8, 2025

AsakerMohd commented Jan 8, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

ppittle Jan 9, 2025

		@@ -74,6 +84,12 @@ private abstract class AWSSemanticConventionsLegacy : AWSSemanticConventionsBase
		// GEN AI Attributes

Added AWS SDK Changes to support Bedrock spans and Application Signals #2458

Are you sure you want to change the base?

Added AWS SDK Changes to support Bedrock spans and Application Signals #2458

Conversation

AsakerMohd commented Jan 8, 2025

Changes

Merge requirement checklist

codecov bot commented Jan 8, 2025 • edited Loading

Codecov Report

muhammad-othman Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AsakerMohd commented Jan 8, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 8, 2025 •

edited

Loading

muhammad-othman Jan 8, 2025 •

edited

Loading