[receiver/sqlserver] Add SQL server host resource attributes (#37004)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
The new attribute are added to the SQL server receiver to distinguish
metrics coming from different SQL server instances.

- **server.address**: The address of the SQL server host, enabled by
default.
- **server.port**: The port of the SQL server host, disabled by default.

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

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

<!--Describe the documentation added.-->
#### Documentation
no need to update.

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

---------

Co-authored-by: Ziqi Zhao <[email protected]>
Co-authored-by: Tyler Helmuth <[email protected]>

Author: 3 people

.chloggen/sqlserver-add-address-resource-attr.yaml

@@ -0,0 +1,30 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: receiver/sqlserverreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add `server.address` and `server.port` resource attributes to SQL server receiver.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [35183]
+
+# (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: |
+  The new resource attributes are added to the SQL server receiver to distinguish metrics coming from different SQL server instances.
+    - `server.address`: The address of the SQL server host, disabled by default.
+    - `server.port`: The port of the SQL server host, disabled by default.
+
+# 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/config_test.go

@@ -112,6 +112,12 @@ func TestLoadConfig(t *testing.T) {
 				SqlserverComputerName: metadata.ResourceAttributeConfig{
 					Enabled: true,
 				},
+				ServerAddress: metadata.ResourceAttributeConfig{
+					Enabled: true,
+				},
+				ServerPort: metadata.ResourceAttributeConfig{
+					Enabled: true,
+				},
 			},
 		}
 		expected.ComputerName = "CustomServer"

receiver/sqlserverreceiver/documentation.md

@@ -323,6 +323,8 @@ This metric is only available when the receiver is configured to directly connec
 
 | Name | Description | Values | Enabled |
 | ---- | ----------- | ------ | ------- |
+| server.address | Name of the database host. | Any Str | false |
+| server.port | Server port number. | Any Int | false |
 | sqlserver.computer.name | The name of the SQL Server instance being monitored. | Any Str | false |
 | sqlserver.database.name | The name of the SQL Server database. | Any Str | true |
 | sqlserver.instance.name | The name of the SQL Server instance being monitored. | Any Str | false |

receiver/sqlserverreceiver/factory.go

@@ -98,13 +98,11 @@ func setupSQLServerScrapers(params receiver.Settings, cfg *Config) []*sqlServerS
 		id := component.NewIDWithName(metadata.Type, fmt.Sprintf("query-%d: %s", i, query))
 
 		sqlServerScraper := newSQLServerScraper(id, query,
-			cfg.InstanceName,
-			cfg.ControllerConfig,
-			params.Logger,
 			sqlquery.TelemetryConfig{},
 			dbProviderFunc,
 			sqlquery.NewDbClient,
-			metadata.NewMetricsBuilder(cfg.MetricsBuilderConfig, params))
+			params,
+			cfg)
 
 		scrapers = append(scrapers, sqlServerScraper)
 	}

receiver/sqlserverreceiver/internal/metadata/generated_config.go

@@ -56,6 +56,10 @@ all_set:
     sqlserver.user.connection.count:
       enabled: true
   resource_attributes:
+    server.address:
+      enabled: true
+    server.port:
+      enabled: true
     sqlserver.computer.name:
       enabled: true
     sqlserver.database.name:
@@ -119,6 +123,10 @@ none_set:
     sqlserver.user.connection.count:
       enabled: false
   resource_attributes:
+    server.address:
+      enabled: false
+    server.port:
+      enabled: false
     sqlserver.computer.name:
       enabled: false
     sqlserver.database.name:
@@ -127,6 +135,14 @@ none_set:
       enabled: false
 filter_set_include:
   resource_attributes:
+    server.address:
+      enabled: true
+      metrics_include:
+        - regexp: ".*"
+    server.port:
+      enabled: true
+      metrics_include:
+        - regexp: ".*"
     sqlserver.computer.name:
       enabled: true
       metrics_include:
@@ -141,6 +157,14 @@ filter_set_include:
         - regexp: ".*"
 filter_set_exclude:
   resource_attributes:
+    server.address:
+      enabled: true
+      metrics_exclude:
+        - strict: "server.address-val"
+    server.port:
+      enabled: true
+      metrics_exclude:
+        - regexp: ".*"
     sqlserver.computer.name:
       enabled: true
       metrics_exclude:

receiver/sqlserverreceiver/internal/metadata/generated_config_test.go

@@ -22,6 +22,18 @@ resource_attributes:
     description: The name of the SQL Server instance being monitored.
     enabled: false
     type: string
+  server.address:
+    description: Name of the database host.
+    enabled: false
+    type: string
+    warnings:
+      if_enabled_not_set: "This attribute will be enabled by default starting in release v0.121.0."
+  server.port:
+    description: Server port number.
+    enabled: false
+    type: int
+    warnings:
+      if_enabled_not_set: "This attribute will be enabled by default starting in release v0.121.0."
 
 attributes:
   page.operations: