Skip to content

Commit

Permalink
change SemenaticCvonentionVersion strategy to pin to v1.27 - the curr…
Browse files Browse the repository at this point in the history
…ent version used by the library. Users must opt-in to newer versions of semantic conventions.
  • Loading branch information
ppittle committed Dec 10, 2024
1 parent fa7419d commit 5ae6dbf
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
6 changes: 5 additions & 1 deletion src/Shared/AWS/AWSSemanticConventions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,11 @@ internal static partial class AWSSemanticConventions
/// ]]>
/// </code>
/// </summary>
internal const SemanticConventionVersion DefaultSemanticConventionVersion = SemanticConventionVersion.Latest;
/// <remarks>
/// Per <see cref="OpenTelemetry.AWS.SemanticConventionVersion"/>, default should stay as

Check warning on line 63 in src/Shared/AWS/AWSSemanticConventions.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 63 in src/Shared/AWS/AWSSemanticConventions.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 63 in src/Shared/AWS/AWSSemanticConventions.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 63 in src/Shared/AWS/AWSSemanticConventions.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 63 in src/Shared/AWS/AWSSemanticConventions.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified
/// <see cref="SemanticConventionVersion.v1_27_0_Experimental"/> until next major version bump.
/// </remarks>
internal const SemanticConventionVersion DefaultSemanticConventionVersion = SemanticConventionVersion.v1_27_0_Experimental;

#region Service Parameter Mapping

Expand Down
10 changes: 8 additions & 2 deletions src/Shared/AWS/SemanticConventionVersion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ namespace OpenTelemetry.AWS;
/// <para>
/// While these libraries are intended for production use, they rely on several
/// Semantic Conventions that are still considered Experimental, meaning they
/// may undergo additional changes before becoming Stable. This can impact
/// may undergo additional changes before becoming Stable. This can impact
/// the aggregation and analysis of telemetry signals in environments with
/// multiple applications or microservices. For example, a microservice using
/// an older version of the Semantic Conventions for Http Attributes may emit
Expand All @@ -27,8 +27,14 @@ namespace OpenTelemetry.AWS;
/// Future versions the OpenTelemetry.*.AWS libraries will include updates
/// to the Semantic Convention, which may break compatibility with a previous
/// version.
/// </para>
/// <para>
/// The default will remain as <see cref="v1_27_0_Experimental"/> until the next major version
/// bump.
/// </para>
/// <para>
/// To opt-out of automatic upgrades, you can pin to a specific version:
/// To opt in to automatic upgrades, you can use <see cref="SemanticConventionVersion.Latest"/>

Check warning on line 36 in src/Shared/AWS/SemanticConventionVersion.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 36 in src/Shared/AWS/SemanticConventionVersion.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 36 in src/Shared/AWS/SemanticConventionVersion.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 36 in src/Shared/AWS/SemanticConventionVersion.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified

Check warning on line 36 in src/Shared/AWS/SemanticConventionVersion.cs

View workflow job for this annotation

GitHub Actions / lint-dotnet-format / run-dotnet-format

Name can be simplified
/// or you can specify a specific version:
/// </para>
/// <code>
/// <![CDATA[
Expand Down

0 comments on commit 5ae6dbf

Please sign in to comment.