open-telemetry / opentelemetry-dotnet-contrib

This repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.
https://opentelemetry.io
Apache License 2.0
462 stars 276 forks source link

AWSSemanticConventions: "aws.region" should be renamed #1599

Open jordankay13 opened 7 months ago

jordankay13 commented 7 months ago

Issue with OpenTelemetry.Instrumentation.AWS

Is this a feature request or a bug?

What is the issue?

The AttributeAwsRegion in the AWSSemanticConventions is set to aws.region -- this name is dangerously close to cloud.region and is easy to misinterpret as a vendor-specific attribute not following the OpenTelemetry community norms about being vendor-agnostic.

The aws.region attribute is intended as "this is the region the resource you are interacting with lives in" The cloud.region attribute is intended as "this is the region you are executing your command from"

Can we please rename this to something more descriptive?

Thank you for your consideration

ppittle commented 7 months ago

Similar discussion on this point in the Specification repository: https://github.com/open-telemetry/semantic-conventions/issues/1113

We noticed that the AWS SDK instrumentation in various languages sets a (client) span attribute named aws.region which is currently not part of the spec.

In my opinion, the Specification repository is the correct place to decide on a solution, and then that solution should be implemented here, as well as the other language sdks.

Alternatively, we could consider dropping aws.region altogether as it is not in the spec and doesn't appear in all languages?

@jordankay13 - thoughts?

jordankay13 commented 7 months ago

100% agree the specification repo is the more appropriate location. I can add my voice to that linked issue.

I wouldn't want the attribute dropped. I think it's appropriate for some attribute to exist since cross region activity has a number of repercussions.

Thank you!