[receiver/redis] include server.address and server.port resource attributes

.chloggen/redis-receiver-server-address-and-port.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: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: redisreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: include server.address and server.port resource attributes
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [22044]
+
+# (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:
+
+# 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]

cmd/otelcontribcol/receivers_test.go

@@ -35,6 +35,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/mongodbatlasreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/otlpjsonfilereceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/prometheusreceiver"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redisreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snmpreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/syslogreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver"
@@ -348,6 +349,11 @@ func TestDefaultReceivers(t *testing.T) {
 		},
 		{
 			receiver: "redis",
+			getConfigFn: func() component.Config {
+				cfg := rcvrFactories["redis"].CreateDefaultConfig().(*redisreceiver.Config)
+				cfg.Endpoint = "localhost:6379"
+				return cfg
+			},
 		},
 		{
 			receiver: "riak",

receiver/redisreceiver/config.go

@@ -4,6 +4,9 @@
 package redisreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redisreceiver"
 
 import (
+	"fmt"
+	"net"
+
 	"go.opentelemetry.io/collector/config/confignet"
 	"go.opentelemetry.io/collector/config/configopaque"
 	"go.opentelemetry.io/collector/config/configtls"
@@ -34,3 +37,17 @@ type Config struct {
 
 	MetricsBuilderConfig metadata.MetricsBuilderConfig `mapstructure:",squash"`
 }
+
+// configInfo holds configuration information to be used as resource/metrics attributes.
+type configInfo struct {
+	Address string
+	Port    string
+}
+
+func newConfigInfo(cfg *Config) (configInfo, error) {
+	address, port, err := net.SplitHostPort(cfg.Endpoint)
+	if err != nil {
+		return configInfo{}, fmt.Errorf("invalid endpoint %q: %w", cfg.Endpoint, err)
+	}
+	return configInfo{Address: address, Port: port}, nil
+}

receiver/redisreceiver/documentation.md

@@ -348,3 +348,5 @@ Redis node's role
 | Name | Description | Values | Enabled |
 | ---- | ----------- | ------ | ------- |
 | redis.version | Redis server's version. | Any Str | true |
+| server.address | Redis server's address | Any Str | true |
+| server.port | Redis server's port | Any Str | true |

receiver/redisreceiver/integration_test.go

@@ -39,6 +39,12 @@ func TestIntegration(t *testing.T) {
 			pmetrictest.IgnoreMetricDataPointsOrder(),
 			pmetrictest.IgnoreStartTimestamp(),
 			pmetrictest.IgnoreTimestamp(),
+			pmetrictest.ChangeResourceAttributeValue("server.address", func(_ string) string {
+				return "localhost"
+			}),
+			pmetrictest.ChangeResourceAttributeValue("server.port", func(_ string) string {
+				return redisPort
+			}),
 		),
 	).Run(t)
 }

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

@@ -72,6 +72,10 @@ all_set:
   resource_attributes:
     redis.version:
       enabled: true
+    server.address:
+      enabled: true
+    server.port:
+      enabled: true
 none_set:
   metrics:
     redis.clients.blocked:
@@ -145,3 +149,7 @@ none_set:
   resource_attributes:
     redis.version:
       enabled: false
+    server.address:
+      enabled: false
+    server.port:
+      enabled: false

receiver/redisreceiver/metadata.yaml

@@ -13,6 +13,14 @@ resource_attributes:
     description: Redis server's version.
     enabled: true
     type: string
+  server.address:
+    description: Redis server's address
+    enabled: true
+    type: string
+  server.port:
+    description: Redis server's port
+    enabled: true
+    type: string
 
 attributes:
   state:

receiver/redisreceiver/redis_scraper.go

@@ -5,6 +5,7 @@ package redisreceiver // import "github.com/open-telemetry/opentelemetry-collect
 
 import (
 	"context"
+	"fmt"
 	"strconv"
 	"strings"
 	"time"
@@ -23,11 +24,12 @@ import (
 // Runs intermittently, fetching info from Redis, creating metrics/datapoints,
 // and feeding them to a metricsConsumer.
 type redisScraper struct {
-	client   client
-	redisSvc *redisSvc
-	settings component.TelemetrySettings
-	mb       *metadata.MetricsBuilder
-	uptime   time.Duration
+	client     client
+	redisSvc   *redisSvc
+	settings   component.TelemetrySettings
+	mb         *metadata.MetricsBuilder
+	uptime     time.Duration
+	configInfo configInfo
 }
 
 const redisMaxDbs = 16 // Maximum possible number of redis databases
@@ -48,11 +50,16 @@ func newRedisScraper(cfg *Config, settings receiver.CreateSettings) (scraperhelp
 }
 
 func newRedisScraperWithClient(client client, settings receiver.CreateSettings, cfg *Config) (scraperhelper.Scraper, error) {
+	configInfo, err := newConfigInfo(cfg)
+	if err != nil {
+		return nil, fmt.Errorf("invalid config %w", err)
+	}
 	rs := &redisScraper{
-		client:   client,
-		redisSvc: newRedisSvc(client),
-		settings: settings.TelemetrySettings,
-		mb:       metadata.NewMetricsBuilder(cfg.MetricsBuilderConfig, settings),
+		client:     client,
+		redisSvc:   newRedisSvc(client),
+		settings:   settings.TelemetrySettings,
+		mb:         metadata.NewMetricsBuilder(cfg.MetricsBuilderConfig, settings),
+		configInfo: configInfo,
 	}
 	return scraperhelper.NewScraper(
 		metadata.Type,
@@ -96,6 +103,8 @@ func (rs *redisScraper) Scrape(context.Context) (pmetric.Metrics, error) {
 	rs.recordCmdMetrics(now, inf)
 	rb := rs.mb.NewResourceBuilder()
 	rb.SetRedisVersion(rs.getRedisVersion(inf))
+	rb.SetServerAddress(rs.configInfo.Address)
+	rb.SetServerPort(rs.configInfo.Port)
 	return rs.mb.Emit(metadata.WithResource(rb.Emit())), nil
 }
 

receiver/redisreceiver/redis_scraper_test.go

@@ -21,6 +21,7 @@ func TestRedisRunnable(t *testing.T) {
 	settings := receivertest.NewNopCreateSettings()
 	settings.Logger = logger
 	cfg := createDefaultConfig().(*Config)
+	cfg.Endpoint = "localhost:6379"
 	rs := &redisScraper{mb: metadata.NewMetricsBuilder(cfg.MetricsBuilderConfig, settings)}
 	runner, err := newRedisScraperWithClient(newFakeClient(), settings, cfg)
 	require.NoError(t, err)
@@ -35,6 +36,13 @@ func TestRedisRunnable(t *testing.T) {
 	assert.Equal(t, "otelcol/redisreceiver", il.Name())
 }
 
+func TestNewReceiver_invalid_endpoint(t *testing.T) {
+	c := createDefaultConfig().(*Config)
+	_, err := createMetricsReceiver(context.Background(), receivertest.NewNopCreateSettings(), c, nil)
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "invalid endpoint")
+}
+
 func TestNewReceiver_invalid_auth_error(t *testing.T) {
 	c := createDefaultConfig().(*Config)
 	c.TLS = configtls.TLSClientSetting{

receiver/redisreceiver/testdata/integration/expected.yaml

@@ -4,6 +4,12 @@ resourceMetrics:
         - key: redis.version
           value:
             stringValue: 6.0.3
+        - key: server.address
+          value:
+            stringValue: localhost
+        - key: server.port
+          value:
+            stringValue: "6379"
     scopeMetrics:
       - metrics:
           - description: Number of clients pending on a blocking call