[AzureMonitorExporter] Add Truncation to ContextTags (Azure#37843)

Timothy Mothra · web-flow · commit e57442623d86 · 2023-07-26T17:24:15.000-07:00
* truncate Tags

* fix typo

* remove usused consts

* remove some Truncates
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/Models/TelemetryItem.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/Models/TelemetryItem.cs
@@ -27,15 +27,15 @@ public TelemetryItem(Activity activity, ref ActivityTagsProcessor activityTagsPr
             {
                 if (activityTagsProcessor.activityType.HasFlag(OperationType.V2))
                 {
-                    Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationNameV2(activity, ref activityTagsProcessor.MappedTags);
+                    Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationNameV2(activity, ref activityTagsProcessor.MappedTags).Truncate(SchemaConstants.Tags_AiOperationName_MaxLength);
                 }
                 else if (activityTagsProcessor.activityType.HasFlag(OperationType.Http))
                 {
-                    Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationName(activity, ref activityTagsProcessor.MappedTags);
+                    Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationName(activity, ref activityTagsProcessor.MappedTags).Truncate(SchemaConstants.Tags_AiOperationName_MaxLength);
                 }
                 else
                 {
-                    Tags[ContextTagKeys.AiOperationName.ToString()] = activity.DisplayName;
+                    Tags[ContextTagKeys.AiOperationName.ToString()] = activity.DisplayName.Truncate(SchemaConstants.Tags_AiOperationName_MaxLength);
                 }
 
                 // Set ip in case of server spans only.
@@ -79,8 +79,8 @@ public TelemetryItem(string name, TelemetryItem telemetryItem, ActivitySpanId ac
                 Tags["ai.user.userAgent"] = userAgent;
             }
 
-            Tags[ContextTagKeys.AiCloudRole.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRole.ToString()];
-            Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRoleInstance.ToString()];
+            Tags[ContextTagKeys.AiCloudRole.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRole.ToString()].Truncate(SchemaConstants.Tags_AiCloudRole_MaxLength);
+            Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRoleInstance.ToString()].Truncate(SchemaConstants.Tags_AiCloudRoleInstance_MaxLength);
             Tags[ContextTagKeys.AiInternalSdkVersion.ToString()] = SdkVersionUtils.s_sdkVersion.Truncate(SchemaConstants.Tags_AiInternalSdkVersion_MaxLength);
             InstrumentationKey = telemetryItem.InstrumentationKey;
 
@@ -116,8 +116,8 @@ public TelemetryItem(DateTime time, AzureMonitorResource? resource, string instr
         private void SetResourceSdkVersionAndIkey(AzureMonitorResource? resource, string instrumentationKey)
         {
             InstrumentationKey = instrumentationKey;
-            Tags[ContextTagKeys.AiCloudRole.ToString()] = resource?.RoleName;
-            Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = resource?.RoleInstance;
+            Tags[ContextTagKeys.AiCloudRole.ToString()] = resource?.RoleName.Truncate(SchemaConstants.Tags_AiCloudRole_MaxLength);
+            Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = resource?.RoleInstance.Truncate(SchemaConstants.Tags_AiCloudRoleInstance_MaxLength);
             Tags[ContextTagKeys.AiInternalSdkVersion.ToString()] = SdkVersionUtils.s_sdkVersion.Truncate(SchemaConstants.Tags_AiInternalSdkVersion_MaxLength);
         }
 
@@ -131,7 +131,7 @@ private void SetAuthenticatedUserId(ref ActivityTagsProcessor activityTagsProces
         {
             if (activityTagsProcessor.EndUserId != null)
             {
-                Tags[ContextTagKeys.AiUserAuthUserId.ToString()] = activityTagsProcessor.EndUserId;
+                Tags[ContextTagKeys.AiUserAuthUserId.ToString()] = activityTagsProcessor.EndUserId.Truncate(SchemaConstants.Tags_AiUserAuthUserId_MaxLength);
             }
         }
     }
diff --git a/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/SchemaConstants.cs b/sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/SchemaConstants.cs
@@ -116,6 +116,12 @@ internal static class SchemaConstants
         public const int TelemetryEnvelope_Time_MaxLength = 64;
         public const int TelemetryEnvelope_InstrumentationKey_MaxLength = 40;
 
+        public const int Tags_AiOperationId_MaxLength = 128;
+        public const int Tags_AiOperationName_MaxLength = 1024;
+        public const int Tags_AiOperationParentId_MaxLength = 512;
+        public const int Tags_AiUserAuthUserId_MaxLength = 1024;
+        public const int Tags_AiCloudRole_MaxLength = 256;
+        public const int Tags_AiCloudRoleInstance_MaxLength = 256;
         public const int Tags_AiInternalSdkVersion_MaxLength = 64;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -27,15 +27,15 @@ public TelemetryItem(Activity activity, ref ActivityTagsProcessor activityTagsPr`
`27`	`27`	`{`
`28`	`28`	`if (activityTagsProcessor.activityType.HasFlag(OperationType.V2))`
`29`	`29`	`{`
`30`		`- Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationNameV2(activity, ref activityTagsProcessor.MappedTags);`
	`30`	`+ Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationNameV2(activity, ref activityTagsProcessor.MappedTags).Truncate(SchemaConstants.Tags_AiOperationName_MaxLength);`
`31`	`31`	`}`
`32`	`32`	`else if (activityTagsProcessor.activityType.HasFlag(OperationType.Http))`
`33`	`33`	`{`
`34`		`- Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationName(activity, ref activityTagsProcessor.MappedTags);`
	`34`	`+ Tags[ContextTagKeys.AiOperationName.ToString()] = TraceHelper.GetOperationName(activity, ref activityTagsProcessor.MappedTags).Truncate(SchemaConstants.Tags_AiOperationName_MaxLength);`
`35`	`35`	`}`
`36`	`36`	`else`
`37`	`37`	`{`
`38`		`- Tags[ContextTagKeys.AiOperationName.ToString()] = activity.DisplayName;`
	`38`	`+ Tags[ContextTagKeys.AiOperationName.ToString()] = activity.DisplayName.Truncate(SchemaConstants.Tags_AiOperationName_MaxLength);`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`// Set ip in case of server spans only.`
`@@ -79,8 +79,8 @@ public TelemetryItem(string name, TelemetryItem telemetryItem, ActivitySpanId ac`
`79`	`79`	`Tags["ai.user.userAgent"] = userAgent;`
`80`	`80`	`}`
`81`	`81`
`82`		`- Tags[ContextTagKeys.AiCloudRole.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRole.ToString()];`
`83`		`- Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRoleInstance.ToString()];`
	`82`	`+ Tags[ContextTagKeys.AiCloudRole.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRole.ToString()].Truncate(SchemaConstants.Tags_AiCloudRole_MaxLength);`
	`83`	`+ Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = telemetryItem.Tags[ContextTagKeys.AiCloudRoleInstance.ToString()].Truncate(SchemaConstants.Tags_AiCloudRoleInstance_MaxLength);`
`84`	`84`	`Tags[ContextTagKeys.AiInternalSdkVersion.ToString()] = SdkVersionUtils.s_sdkVersion.Truncate(SchemaConstants.Tags_AiInternalSdkVersion_MaxLength);`
`85`	`85`	`InstrumentationKey = telemetryItem.InstrumentationKey;`
`86`	`86`
`@@ -116,8 +116,8 @@ public TelemetryItem(DateTime time, AzureMonitorResource? resource, string instr`
`116`	`116`	`private void SetResourceSdkVersionAndIkey(AzureMonitorResource? resource, string instrumentationKey)`
`117`	`117`	`{`
`118`	`118`	`InstrumentationKey = instrumentationKey;`
`119`		`- Tags[ContextTagKeys.AiCloudRole.ToString()] = resource?.RoleName;`
`120`		`- Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = resource?.RoleInstance;`
	`119`	`+ Tags[ContextTagKeys.AiCloudRole.ToString()] = resource?.RoleName.Truncate(SchemaConstants.Tags_AiCloudRole_MaxLength);`
	`120`	`+ Tags[ContextTagKeys.AiCloudRoleInstance.ToString()] = resource?.RoleInstance.Truncate(SchemaConstants.Tags_AiCloudRoleInstance_MaxLength);`
`121`	`121`	`Tags[ContextTagKeys.AiInternalSdkVersion.ToString()] = SdkVersionUtils.s_sdkVersion.Truncate(SchemaConstants.Tags_AiInternalSdkVersion_MaxLength);`
`122`	`122`	`}`
`123`	`123`
`@@ -131,7 +131,7 @@ private void SetAuthenticatedUserId(ref ActivityTagsProcessor activityTagsProces`
`131`	`131`	`{`
`132`	`132`	`if (activityTagsProcessor.EndUserId != null)`
`133`	`133`	`{`
`134`		`- Tags[ContextTagKeys.AiUserAuthUserId.ToString()] = activityTagsProcessor.EndUserId;`
	`134`	`+ Tags[ContextTagKeys.AiUserAuthUserId.ToString()] = activityTagsProcessor.EndUserId.Truncate(SchemaConstants.Tags_AiUserAuthUserId_MaxLength);`
`135`	`135`	`}`
`136`	`136`	`}`
`137`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,12 @@ internal static class SchemaConstants`
`116`	`116`	`public const int TelemetryEnvelope_Time_MaxLength = 64;`
`117`	`117`	`public const int TelemetryEnvelope_InstrumentationKey_MaxLength = 40;`
`118`	`118`
	`119`	`+ public const int Tags_AiOperationId_MaxLength = 128;`
	`120`	`+ public const int Tags_AiOperationName_MaxLength = 1024;`
	`121`	`+ public const int Tags_AiOperationParentId_MaxLength = 512;`
	`122`	`+ public const int Tags_AiUserAuthUserId_MaxLength = 1024;`
	`123`	`+ public const int Tags_AiCloudRole_MaxLength = 256;`
	`124`	`+ public const int Tags_AiCloudRoleInstance_MaxLength = 256;`
`119`	`125`	`public const int Tags_AiInternalSdkVersion_MaxLength = 64;`
`120`	`126`	`}`
`121`	`127`	`}`