Fixed normalization for metric tag values (#3281)

getsentry · Apr 12, 2024 · 025d60c · 025d60c
1 parent a1d388f
commit 025d60c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- Fixed normalization for metric tag values for carriage return, line feed and tab characters ([#3281](https://github.com/getsentry/sentry-dotnet/pull/3281))
+
 ### Dependencies
 
 - Bump Java SDK from v7.7.0 to v7.8.0 ([#3275](https://github.com/getsentry/sentry-dotnet/pull/3275))

diff --git a/src/Sentry/MetricHelper.cs b/src/Sentry/MetricHelper.cs
@@ -68,16 +68,17 @@ internal static DateTimeOffset GetCutoff() => DateTimeOffset.UtcNow
 
     private static readonly Lazy<KeyValuePair<string, string>[]> LazyTagValueReplacements = new(() =>
     [
-        new KeyValuePair<string, string>("\n", "<LF>"),
-        new KeyValuePair<string, string>("\r", "<CR>"),
-        new KeyValuePair<string, string>("\t", "<HT>"),
-        new KeyValuePair<string, string>(@"\", @"\\"),
+        new KeyValuePair<string, string>("\n", @"\n"),
+        new KeyValuePair<string, string>("\r", @"\r"),
+        new KeyValuePair<string, string>("\t", @"\t"),
         new KeyValuePair<string, string>("|", "\u007c"),
         new KeyValuePair<string, string>(",", "\u002c")
     ]);
     private static KeyValuePair<string, string>[] TagValueReplacements => LazyTagValueReplacements.Value;
     internal static string SanitizeTagValue(string input)
     {
+        // Replace back slashes before we add any of these ourselves when substituting "\n" for other control characters
+        input = input.Replace(@"\", @"\\");
         foreach (var (reservedCharacter, replacementValue) in TagValueReplacements)
         {
             input = input.Replace(reservedCharacter, replacementValue);

diff --git a/test/Sentry.Tests/MetricHelperTests.cs b/test/Sentry.Tests/MetricHelperTests.cs
@@ -128,13 +128,13 @@ public void SanitizeMetricKeyOrName_ReplacesInvalidCharactersWithUnderscore(stri
 
     [Theory]
     [InlineData("Test123_:/@.{}[]$-", "Test123_:/@.{}[]$-")] // Valid characters
-    [InlineData("test\nvalue", "test<LF>value")]
-    [InlineData("test\rvalue", "test<CR>value")]
-    [InlineData("test\tvalue", "test<HT>value")]
+    [InlineData("test\nvalue", @"test\nvalue")]
+    [InlineData("test\rvalue", @"test\rvalue")]
+    [InlineData("test\tvalue", @"test\tvalue")]
     [InlineData(@"test\value", @"test\\value")]
     [InlineData("test|value", "test\u007cvalue")]
     [InlineData("test,value", "test\u002cvalue")]
-    public void SanitizeValue_ShouldReplaceReservedCharacters(string input, string expected)
+    public void SanitizeTagValue_ShouldReplaceReservedCharacters(string input, string expected)
     {
         // Act
         var result = MetricHelper.SanitizeTagValue(input);