[receiver/oracledb] Add service.instance.id resource attribute to metrics and logs

.chloggen/service_instance_id_for_oracledbreceiver.yaml

@@ -0,0 +1,29 @@
+# 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: oracledbreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: service.instance.id attribute is added in resourceAttributes of all metrics and logs in oracledbreceiver
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [42402]
+
+# (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 `service.instance.id` attribute is added in the format `<host>:<port>` to uniquely identify 
+  Oracle db hosts.
+
+# 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/oracledbreceiver/documentation.md

@@ -470,3 +470,4 @@ Collection of event metrics for top N queries, filtered based on the highest CPU
 | ---- | ----------- | ------ | ------- |
 | host.name | The host name of Oracle Server | Any Str | true |
 | oracledb.instance.name | The name of the instance that data is coming from. | Any Str | true |
+| service.instance.id | A unique identifier of the Oracle db instance in the format host:port | Any Str | true |

receiver/oracledbreceiver/internal/metadata/testdata/config.yaml

@@ -95,6 +95,8 @@ all_set:
       enabled: true
     oracledb.instance.name:
       enabled: true
+    service.instance.id:
+      enabled: true
 none_set:
   metrics:
     oracledb.consistent_gets:
@@ -191,6 +193,8 @@ none_set:
       enabled: false
     oracledb.instance.name:
       enabled: false
+    service.instance.id:
+      enabled: false
 filter_set_include:
   resource_attributes:
     host.name:
@@ -205,6 +209,12 @@ filter_set_include:
         - regexp: ".*"
       events_include:
         - regexp: ".*"
+    service.instance.id:
+      enabled: true
+      metrics_include:
+        - regexp: ".*"
+      events_include:
+        - regexp: ".*"
 filter_set_exclude:
   resource_attributes:
     host.name:
@@ -219,3 +229,9 @@ filter_set_exclude:
         - strict: "oracledb.instance.name-val"
       events_exclude:
         - strict: "oracledb.instance.name-val"
+    service.instance.id:
+      enabled: true
+      metrics_exclude:
+        - strict: "service.instance.id-val"
+      events_exclude:
+        - strict: "service.instance.id-val"

receiver/oracledbreceiver/metadata.yaml

@@ -18,6 +18,10 @@ resource_attributes:
     description: The host name of Oracle Server
     enabled: true
     type: string
+  service.instance.id:
+    description: A unique identifier of the Oracle db instance in the format host:port
+    enabled: true
+    type: string
 
 attributes:
   session_status:

receiver/oracledbreceiver/scraper.go

@@ -11,6 +11,8 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"net"
+	"os"
 	"sort"
 	"strconv"
 	"strings"
@@ -131,6 +133,7 @@ type oracleScraper struct {
 	topQueryCollectCfg         TopQueryCollection
 	obfuscator                 *obfuscator
 	querySampleCfg             QuerySample
+	serviceInstanceID          string
 }
 
 func newScraper(metricsBuilder *metadata.MetricsBuilder, metricsBuilderConfig metadata.MetricsBuilderConfig, scrapeCfg scraperhelper.ControllerConfig, logger *zap.Logger, providerFunc dbProviderFunc, clientProviderFunc clientProviderFunc, instanceName, hostName string) (scraper.Metrics, error) {
@@ -164,6 +167,7 @@ func newLogsScraper(logsBuilder *metadata.LogsBuilder, logsBuilderConfig metadat
 		querySampleCfg:     querySampleCfg,
 		hostName:           hostName,
 		obfuscator:         newObfuscator(),
+		serviceInstanceID:  getInstanceID(hostName, logger),
 	}
 	return scraper.NewLogs(s.scrapeLogs, scraper.WithShutdown(s.shutdown), scraper.WithStart(s.start))
 }
@@ -502,9 +506,8 @@ func (s *oracleScraper) scrape(ctx context.Context) (pmetric.Metrics, error) {
 		}
 	}
 
-	rb := s.mb.NewResourceBuilder()
-	rb.SetOracledbInstanceName(s.instanceName)
-	rb.SetHostName(s.hostName)
+	rb := s.setupResourceBuilder(s.mb.NewResourceBuilder())
+
 	out := s.mb.Emit(metadata.WithResource(rb.Emit()))
 	s.logger.Debug("Done scraping")
 	if len(scrapeErrors) > 0 {
@@ -634,9 +637,7 @@ func (s *oracleScraper) collectTopNMetricData(ctx context.Context, logs plog.Log
 	hits = s.obfuscateCacheHits(hits)
 	childAddressToPlanMap := s.getChildAddressToPlanMap(ctx, hits)
 
-	rb := s.lb.NewResourceBuilder()
-	rb.SetOracledbInstanceName(s.instanceName)
-	rb.SetHostName(s.hostName)
+	rb := s.setupResourceBuilder(s.lb.NewResourceBuilder())
 
 	for _, hit := range hits {
 		planBytes, err := json.Marshal(childAddressToPlanMap[hit.childAddress])
@@ -717,9 +718,7 @@ func (s *oracleScraper) collectQuerySamples(ctx context.Context, logs plog.Logs)
 		scrapeErrors = append(scrapeErrors, fmt.Errorf("error executing %s: %w", samplesQuery, err))
 	}
 
-	rb := s.lb.NewResourceBuilder()
-	rb.SetOracledbInstanceName(s.instanceName)
-	rb.SetHostName(s.hostName)
+	rb := s.setupResourceBuilder(s.lb.NewResourceBuilder())
 
 	for _, row := range rows {
 		if row[sqlText] == "" {
@@ -828,3 +827,24 @@ func (s *oracleScraper) shutdown(_ context.Context) error {
 	}
 	return s.db.Close()
 }
+
+func (s *oracleScraper) setupResourceBuilder(rb *metadata.ResourceBuilder) *metadata.ResourceBuilder {
+	rb.SetOracledbInstanceName(s.instanceName)
+	rb.SetHostName(s.hostName)
+	rb.SetServiceInstanceID(s.serviceInstanceID)
+	return rb
+}
+
+func getInstanceID(hostString string, logger *zap.Logger) string {
+	host, port, err := net.SplitHostPort(hostString)
+	if err == nil && (strings.EqualFold(host, "localhost") || net.ParseIP(host).IsLoopback()) {
+		host, err = os.Hostname()
+	}
+
+	if err != nil {
+		logger.Warn("Failed to compute service.instance.id", zap.Error(err))
+		return "unknown:1521"
+	}
+
+	return host + ":" + port
+}

receiver/oracledbreceiver/scraper_test.go

@@ -390,6 +390,29 @@ func TestSamplesQuery(t *testing.T) {
 	}
 }
 
+func TestGetInstanceId(t *testing.T) {
+	localhostName, _ := os.Hostname()
+
+	hostString := "example.com:1521"
+	instanceID := getInstanceID(hostString, zap.NewNop())
+	assert.Equal(t, "example.com:1521", instanceID)
+
+	localHostStringUppercase := "Localhost:1521"
+	localInstanceID := getInstanceID(localHostStringUppercase, zap.NewNop())
+	assert.NotNil(t, localInstanceID)
+	assert.Equal(t, localhostName+":1521", localInstanceID)
+
+	localHostString := "127.0.0.1:1521"
+	localInstanceID = getInstanceID(localHostString, zap.NewNop())
+	assert.NotNil(t, localInstanceID)
+	assert.Equal(t, localhostName+":1521", localInstanceID)
+
+	localHostStringIPV6 := "[::1]:1521"
+	localInstanceID = getInstanceID(localHostStringIPV6, zap.NewNop())
+	assert.NotNil(t, localInstanceID)
+	assert.Equal(t, localhostName+":1521", localInstanceID)
+}
+
 func readFile(fname string) []byte {
 	file, err := os.ReadFile(filepath.Join("testdata", fname))
 	if err != nil {

receiver/oracledbreceiver/testdata/expectedQueryTextAndPlanQuery.yaml

@@ -7,6 +7,9 @@ resourceLogs:
         - key: host.name
           value:
             stringValue: oracle-host-sample-1
+        - key: service.instance.id
+          value:
+            stringValue: ""
     scopeLogs:
       - logRecords:
           - attributes:
@@ -81,9 +84,7 @@ resourceLogs:
                   doubleValue: 2e-05
             body: {}
             eventName: db.server.top_query
-            spanId: ""
-            timeUnixNano: "1752581882636677000"
-            traceId: ""
+            timeUnixNano: "1756763669220332000"
         scope:
           name: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/oracledbreceiver
           version: latest

receiver/oracledbreceiver/testdata/expectedSamplesFile.yaml

@@ -7,6 +7,9 @@ resourceLogs:
         - key: host.name
           value:
             stringValue: ""
+        - key: service.instance.id
+          value:
+            stringValue: ""
     scopeLogs:
       - logRecords:
           - attributes:
@@ -45,7 +48,7 @@ resourceLogs:
                   stringValue: "0"
               - key: oracledb.child_address
                 value:
-                  stringValue: "SDF3SDF1234D"
+                  stringValue: SDF3SDF1234D
               - key: oracledb.sid
                 value:
                   stringValue: "675"
@@ -91,7 +94,7 @@ resourceLogs:
             body: {}
             eventName: db.server.query_sample
             spanId: a7ad6b7169203331
-            timeUnixNano: "1754828794690056000"
+            timeUnixNano: "1756763648441865000"
             traceId: 0af7651916cd43dd8448eb211c80319c
         scope:
           name: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/oracledbreceiver