Add oxide.host to synthetic and self-metrics. (#42)

Author: jmcarp

collector/manifest.yaml

@@ -6,7 +6,7 @@ dist:
   module: github.com/oxidecomputer/otelcol-oxide
   name: otelcol-oxide
   description: OpenTelemetry Collector with Oxide receiver
-  version: 0.3.3
+  version: 0.3.4
   output_path: ./dist
   build_tags: "grpcnotrace"
 
@@ -40,9 +40,9 @@ receivers:
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/prometheusreceiver v0.145.0
 
   # Add the Oxide receivers.
-  - gomod: github.com/oxidecomputer/opentelemetry-collector-components v0.3.3
+  - gomod: github.com/oxidecomputer/opentelemetry-collector-components v0.3.4
     import: github.com/oxidecomputer/opentelemetry-collector-components/receiver/oxidemetricsreceiver
-  - gomod: github.com/oxidecomputer/opentelemetry-collector-components v0.3.3
+  - gomod: github.com/oxidecomputer/opentelemetry-collector-components v0.3.4
     import: github.com/oxidecomputer/opentelemetry-collector-components/receiver/oxideauditlogsreceiver
 
 connectors:

receiver/oxideauditlogsreceiver/scraper.go

@@ -52,6 +52,7 @@ type auditLogScraper struct {
 	cfg      *Config
 	settings component.TelemetrySettings
 	logger   *zap.Logger
+	host     string
 	metrics  scraperMetrics
 	cursor   cursor
 }
@@ -65,6 +66,7 @@ func newAuditLogScraper(
 		client:   client,
 		cfg:      cfg,
 		settings: settings,
+		host:     normalizeHost(client.Host()),
 		logger:   settings.Logger,
 	}
 }
@@ -127,11 +129,7 @@ func (s *auditLogScraper) Scrape(ctx context.Context) (plog.Logs, error) {
 	resource := logs.ResourceLogs().AppendEmpty()
 	attrs := resource.Resource().Attributes()
 	attrs.PutStr("service.name", "oxide")
-	host := s.client.Host()
-	if u, err := url.Parse(host); err == nil && u.Host != "" {
-		host = u.Host
-	}
-	attrs.PutStr("oxide.host", host)
+	attrs.PutStr("oxide.host", s.host)
 	scope := resource.ScopeLogs().AppendEmpty()
 	startTime := time.Now()
 
@@ -147,13 +145,20 @@ func (s *auditLogScraper) Scrape(ctx context.Context) (plog.Logs, error) {
 		pageStart := time.Now()
 		page, err := s.client.AuditLogList(ctx, params)
 		pageLatency := time.Since(pageStart).Seconds()
-		s.metrics.apiRequestDuration.Record(ctx, pageLatency)
+		s.metrics.apiRequestDuration.Record(
+			ctx,
+			pageLatency,
+			metric.WithAttributes(attribute.String("oxide.host", s.host)),
+		)
 		if err != nil {
 			s.logger.Warn("audit log list request failed", zap.Error(err))
 			s.metrics.scrapeCount.Add(
 				ctx,
 				1,
-				metric.WithAttributes(attribute.String("status", "failure")),
+				metric.WithAttributes(
+					attribute.String("status", "failure"),
+					attribute.String("oxide.host", s.host),
+				),
 			)
 			// Emit partial results on error.
 			if logs.LogRecordCount() > 0 {
@@ -195,8 +200,19 @@ func (s *auditLogScraper) Scrape(ctx context.Context) (plog.Logs, error) {
 	}
 
 	elapsed := time.Since(startTime)
-	s.metrics.scrapeDuration.Record(ctx, elapsed.Seconds())
-	s.metrics.scrapeCount.Add(ctx, 1, metric.WithAttributes(attribute.String("status", "success")))
+	s.metrics.scrapeDuration.Record(
+		ctx,
+		elapsed.Seconds(),
+		metric.WithAttributes(attribute.String("oxide.host", s.host)),
+	)
+	s.metrics.scrapeCount.Add(
+		ctx,
+		1,
+		metric.WithAttributes(
+			attribute.String("status", "success"),
+			attribute.String("oxide.host", s.host),
+		),
+	)
 
 	s.saveCursor()
 
@@ -271,6 +287,13 @@ func (s *auditLogScraper) saveCursor() {
 	}
 }
 
+func normalizeHost(raw string) string {
+	if u, err := url.Parse(raw); err == nil && u.Host != "" {
+		return u.Host
+	}
+	return raw
+}
+
 func addLogRecord(scope plog.ScopeLogs, entry oxide.AuditLogEntry, observedTime time.Time) error {
 	raw, err := json.Marshal(entry)
 	if err != nil {

receiver/oxidemetricsreceiver/scraper.go

@@ -24,6 +24,7 @@ type oxideScraper struct {
 	settings component.TelemetrySettings
 	cfg      *Config
 	logger   *zap.Logger
+	host     string
 
 	metricNames []string
 
@@ -32,6 +33,13 @@ type oxideScraper struct {
 	scrapeDuration     metric.Float64Gauge
 }
 
+func normalizeHost(raw string) string {
+	if u, err := url.Parse(raw); err == nil && u.Host != "" {
+		return u.Host
+	}
+	return raw
+}
+
 func newOxideScraper(
 	cfg *Config,
 	settings component.TelemetrySettings,
@@ -42,6 +50,7 @@ func newOxideScraper(
 		settings: settings,
 		cfg:      cfg,
 		logger:   settings.Logger,
+		host:     normalizeHost(client.Host()),
 	}
 }
 
@@ -163,7 +172,10 @@ func (s *oxideScraper) Scrape(ctx context.Context) (pmetric.Metrics, error) {
 				s.apiRequestDuration.Record(
 					ctx,
 					elapsed.Seconds(),
-					metric.WithAttributes(attribute.String("request_name", metricName)),
+					metric.WithAttributes(
+						attribute.String("request_name", metricName),
+						attribute.String("oxide.host", s.host),
+					),
 				)
 			}
 
@@ -178,8 +190,9 @@ func (s *oxideScraper) Scrape(ctx context.Context) (pmetric.Metrics, error) {
 	elapsed := time.Since(startTime)
 	s.logger.Info("scrape finished", zap.Float64("latency", elapsed.Seconds()))
 
-	s.scrapeDuration.Record(ctx, elapsed.Seconds())
-	s.scrapeCount.Add(ctx, 1)
+	hostAttr := attribute.String("oxide.host", s.host)
+	s.scrapeDuration.Record(ctx, elapsed.Seconds(), metric.WithAttributes(hostAttr))
+	s.scrapeCount.Add(ctx, 1, metric.WithAttributes(hostAttr))
 
 	var queryErrors int
 	for _, result := range results {
@@ -226,11 +239,7 @@ func (s *oxideScraper) Scrape(ctx context.Context) (pmetric.Metrics, error) {
 				rm := metrics.ResourceMetrics().AppendEmpty()
 				resource := rm.Resource()
 				resource.Attributes().PutStr("service.name", "oxide")
-				host := s.client.Host()
-				if u, err := url.Parse(host); err == nil && u.Host != "" {
-					host = u.Host
-				}
-				resource.Attributes().PutStr("oxide.host", host)
+				resource.Attributes().PutStr("oxide.host", s.host)
 
 				addLabels(series, resource)
 
@@ -344,7 +353,7 @@ func (s *oxideScraper) addSiloUtilization(ctx context.Context, metrics pmetric.M
 	if err != nil {
 		return err
 	}
-	addSiloUtilizationMetrics(metrics, resp, pcommon.NewTimestampFromTime(time.Now()))
+	addSiloUtilizationMetrics(metrics, resp, pcommon.NewTimestampFromTime(time.Now()), s.host)
 	return nil
 }
 
@@ -353,8 +362,11 @@ func addSiloUtilizationMetrics(
 	metrics pmetric.Metrics,
 	utilizations []oxide.SiloUtilization,
 	timestamp pcommon.Timestamp,
+	host string,
 ) {
 	rm := metrics.ResourceMetrics().AppendEmpty()
+	rm.Resource().Attributes().PutStr("service.name", "oxide")
+	rm.Resource().Attributes().PutStr("oxide.host", host)
 	sm := rm.ScopeMetrics().AppendEmpty()
 
 	addGauge := func(name string) pmetric.Gauge {

receiver/oxidemetricsreceiver/scraper_test.go

@@ -343,10 +343,13 @@ func TestAddSiloUtilizationMetrics(t *testing.T) {
 	}
 
 	metrics := pmetric.NewMetrics()
-	addSiloUtilizationMetrics(metrics, utilizations, timestamp)
+	addSiloUtilizationMetrics(metrics, utilizations, timestamp, "example.oxide.computer")
 
 	require.Equal(t, 1, metrics.ResourceMetrics().Len())
-	sm := metrics.ResourceMetrics().At(0).ScopeMetrics().At(0)
+	rm := metrics.ResourceMetrics().At(0)
+	require.Equal(t, "oxide", rm.Resource().Attributes().AsRaw()["service.name"])
+	require.Equal(t, "example.oxide.computer", rm.Resource().Attributes().AsRaw()["oxide.host"])
+	sm := rm.ScopeMetrics().At(0)
 	require.Equal(t, len(wantMetrics), sm.Metrics().Len())
 
 	for i := 0; i < sm.Metrics().Len(); i++ {