[receiver/sqlserver] reports empty strings for query texts and query … (#40527)

…plans when obfuscation failed

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
This ensures the protection of customer privacy data in cases where
obfuscation fails.

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
n/a

<!--Describe what testing was performed and which tests were added.-->
#### Testing
Updated

<!--Describe the documentation added.-->
#### Documentation
Added

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Curtis Robert <[email protected]>

Author: sincejune

.chloggen/sqlserver-report-empty-when-fail.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: sqlserverreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Only empty strings for query texts and query plans when obfuscation failed.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [40527]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: This change applies only to top query collection and query sample collection.
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [user]

receiver/sqlserverreceiver/obfuscate.go

@@ -76,7 +76,7 @@ func obfuscateXMLPlan(rawPlan string) (string, error) {
 						val, err := obfuscateSQL(elem.Attr[i].Value)
 						if err != nil {
 							fmt.Println("Unable to obfuscate SQL statement in query plan, skipping: " + elem.Attr[i].Value)
-							continue
+							return "", nil
 						}
 						elem.Attr[i].Value = val
 					}

receiver/sqlserverreceiver/obfuscate_test.go

@@ -68,10 +68,10 @@ func TestInvalidQueryPlans(t *testing.T) {
 	assert.Empty(t, result)
 	assert.Error(t, err)
 
-	// obfuscate failure, but no error
+	// obfuscate failure, return empty string
 	plan = `<ShowPlanXML StatementText="[msdb].[dbo].[sysjobhistory].[run_duration] as [sjh].[run_duration]/(10000)*(3600)+[msdb].[dbo].[sysjobhistory].[run_duration] as [sjh].[run_duration]%(10000)/(100)*(60)+[msdb].[dbo].[sysjobhistory].[run_duration] as [sjh].[run_duration]%(100)"></ShowPlanXML>`
 	result, err = obfuscateXMLPlan(plan)
-	assert.Equal(t, plan, result)
+	assert.Empty(t, result)
 	assert.NoError(t, err)
 }
 

receiver/sqlserverreceiver/scraper.go

@@ -676,7 +676,7 @@ func (s *sqlServerScraperHelper) recordDatabaseQueryTextAndPlan(ctx context.Cont
 			obfuscated, err := obfuscateSQL(statement)
 			if err != nil {
 				s.logger.Error(fmt.Sprintf("failed to obfuscate SQL statement: %v", statement))
-				return statement, nil
+				return "", nil
 			}
 
 			return obfuscated, nil
@@ -972,7 +972,7 @@ func (s *sqlServerScraperHelper) recordDatabaseSampleQuery(ctx context.Context)
 			obfuscated, err := obfuscateSQL(statement)
 			if err != nil {
 				s.logger.Error(fmt.Sprintf("failed to obfuscate SQL statement: %v", statement))
-				return statement, nil
+				return "", nil
 			}
 			return obfuscated, nil
 		}).(string)

receiver/sqlserverreceiver/testdata/expectedQueryTextAndPlanQueryWithInvalidData.yaml

@@ -18,7 +18,7 @@ resourceLogs:
                   doubleValue: 0
               - key: db.query.text
                 value:
-                  stringValue: SELECT cpu_time AS [CPU Usage (time)]
+                  stringValue: ""
               - key: sqlserver.execution_count
                 value:
                   intValue: "0"

receiver/sqlserverreceiver/testdata/expectedRecordDatabaseSampleQueryWithInvalidData.yaml

@@ -24,7 +24,7 @@ resourceLogs:
                   stringValue: master
               - key: db.query.text
                 value:
-                  stringValue: SELECT cpu_time AS [CPU Usage (time)]
+                  stringValue: ""
               - key: db.system.name
                 value:
                   stringValue: microsoft.sql_server