Standardize unit interpretation of lookback_time in config for top_query_collection (open-telemetry#43618)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
As a standard, all type of interval values in collector config currently
requires an 's' suffix to interpret the unit. But the recently
introduced lookback_time in top_query_collection does not follow this
pattern. This needs to be fixed to maintain consistency and avoid
ambiguity in unit interpretation.

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes
open-telemetry#43573

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

Author: sv-splunk

.chloggen/fix_for_sqlserver_lookback_time_unit.yaml

@@ -0,0 +1,28 @@
+# 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: receiver/sqlserver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Standardizing the unit interpretation of lookback_time in config for top query collection
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [43573]
+
+# (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: |
+  Like other interval related config values, lookback_time also should suffix 's' to represent time in seconds.
+
+# 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/README.md

@@ -59,7 +59,7 @@ sqlserver:
     db.server.top_query:
       enabled: true
   top_query_collection:                        # this collection exports the most expensive queries as logs
-    lookback_time: 60                          # which time window should we look for the top queries
+    lookback_time: 60s                         # which time window should we look for the top queries
     max_query_sample_count: 1000               # maximum number query we store in cache for top queries.
     top_query_count: 200                       # The maximum number of active queries to report in a single run.
     collection_interval: 60s                   # collection interval for top query collection specifically
@@ -87,7 +87,7 @@ Windows-specific options:
   If specified, `instance_name` is also required to be defined. This option is ignored in non-Windows environments.
 
 Top-Query collection specific options (only useful when top-query collection are enabled):
-- `lookback_time` (optional, example = `60`, default = `2 * collection_interval`): The time window (in second) in which to query for top queries.
+- `lookback_time` (optional, example = `60s`, default = `2 * collection_interval`): The time window (in second) in which to query for top queries.
   - Queries that were finished execution outside the lookback window are not included in the collection. Increasing the lookback window (in seconds) will be useful for capturing long-running queries.
 - `max_query_sample_count` (optional, example = `5000`, default = `1000`): The maximum number of records to fetch in a single run.
 - `top_query_count`: (optional, example = `100`, default = `200`): The maximum number of active queries to report (to the next consumer) in a single run.
@@ -143,7 +143,7 @@ Top query collection enabled:
         server: 0.0.0.0
         port: 1433
         top_query_collection:
-          lookback_time: 60
+          lookback_time: 60s
           max_query_sample_count: 1000
           top_query_count: 200
         query_sample_collection:

receiver/sqlserverreceiver/config.go

@@ -26,7 +26,7 @@ type TopQueryCollection struct {
 	// The query statement will also be reported, hence, it is not ideal to send it as a metric. Hence
 	// we are reporting them as logs.
 	// The `N` is configured via `TopQueryCount`
-	LookbackTime        uint          `mapstructure:"lookback_time"`
+	LookbackTime        time.Duration `mapstructure:"lookback_time"`
 	MaxQuerySampleCount uint          `mapstructure:"max_query_sample_count"`
 	TopQueryCount       uint          `mapstructure:"top_query_count"`
 	CollectionInterval  time.Duration `mapstructure:"collection_interval"`

receiver/sqlserverreceiver/config_test.go

@@ -197,7 +197,7 @@ func TestLoadConfig(t *testing.T) {
 		}
 		expected.ComputerName = "CustomServer"
 		expected.InstanceName = "CustomInstance"
-		expected.LookbackTime = 60
+		expected.LookbackTime = 60 * time.Second
 		expected.TopQueryCount = 200
 		expected.MaxQuerySampleCount = 1000
 		expected.TopQueryCollection.CollectionInterval = 80 * time.Second

receiver/sqlserverreceiver/factory.go

@@ -56,7 +56,7 @@ func createDefaultConfig() component.Config {
 			MaxRowsPerQuery: 100,
 		},
 		TopQueryCollection: TopQueryCollection{
-			LookbackTime:        uint(2 * cfg.CollectionInterval / time.Second),
+			LookbackTime:        2 * cfg.CollectionInterval / time.Second,
 			MaxQuerySampleCount: 1000,
 			TopQueryCount:       200,
 			CollectionInterval:  time.Minute,

receiver/sqlserverreceiver/factory_test.go

@@ -43,7 +43,7 @@ func TestFactory(t *testing.T) {
 						InitialDelay:       time.Second,
 					},
 					TopQueryCollection: TopQueryCollection{
-						LookbackTime:        uint(2 * 10),
+						LookbackTime:        2 * 10,
 						MaxQuerySampleCount: 1000,
 						TopQueryCount:       200,
 						CollectionInterval:  time.Minute,

receiver/sqlserverreceiver/scraper.go

@@ -643,7 +643,7 @@ func (s *sqlServerScraperHelper) recordDatabaseQueryTextAndPlan(ctx context.Cont
 
 	rows, err := s.client.QueryRows(
 		ctx,
-		sql.Named("lookbackTime", -s.config.LookbackTime),
+		sql.Named("lookbackTime", -int(s.config.LookbackTime.Seconds())),
 		sql.Named("topNValue", s.config.TopQueryCount),
 	)
 	if err != nil {

receiver/sqlserverreceiver/testdata/config.yaml

@@ -17,7 +17,7 @@ sqlserver/named:
     service.instance.id:
       enabled: false
   top_query_collection:
-    lookback_time: 60
+    lookback_time: 60s
     max_query_sample_count: 1000
     top_query_count: 200
     collection_interval: 80s