feat: optionally add human-readable labels. (#5)

OxQL provides uuid labels for silos, projects, etc., but these aren't very
useful for metrics queries: the user has to look up the uuid for each
silo/project of interest. This patch adds the option to fetch silo and project
metadata from the api and enrich labels where appropriate. We should support
this in the api instead eventually, but it's quicker to add here for now.

Author: jmcarp

config.go

@@ -14,6 +14,9 @@ type Config struct {
 	Token             string   `mapstructure:"token"`
 	MetricPatterns    []string `mapstructure:"metric_patterns"`
 	ScrapeConcurrency int      `mapstructure:"scrape_concurrency"`
+
+	// AddLabels configures the receiver to add human-readable labels to metrics using the Oxide API.
+	AddLabels bool `mapstructure:"add_labels"`
 }
 
 func (cfg *Config) Validate() error {

scraper.go

@@ -159,6 +159,37 @@ func (s *oxideScraper) Scrape(ctx context.Context) (pmetric.Metrics, error) {
 	s.scrapeDuration.Record(ctx, elapsed.Seconds())
 	s.scrapeCount.Add(ctx, 1, metric.WithAttributes(attribute.String("status", "success")))
 
+	// Cache mappings from resource UUIDs to human-readable names. Note: we
+	// can also add mappings for higher-cardinality resources like
+	// instances and disks, but this would add more latency to the 0th
+	// query on the page.
+	//
+	// TODO: add human-readable labels to metrics in oximeter so that we
+	// don't have to enrich them here. Tracked in
+	// https://github.com/oxidecomputer/omicron/issues/9119.
+	siloToName := map[string]string{}
+	projectToName := map[string]string{}
+	if s.cfg.AddLabels {
+		silos, err := s.client.SiloListAllPages(ctx, oxide.SiloListParams{})
+		if err != nil {
+			return metrics, fmt.Errorf("listing silos: %w", err)
+		}
+		for _, silo := range silos {
+			siloToName[silo.Id] = string(silo.Name)
+		}
+		// Note: this only lists projects in the silo corresponding to
+		// the client's authentication token. In the future, we can
+		// either add a system endpoint listing all projects for the
+		// rack, or enrich metrics with project labels in nexus.
+		projects, err := s.client.ProjectListAllPages(ctx, oxide.ProjectListParams{})
+		if err != nil {
+			return metrics, fmt.Errorf("listing projects: %w", err)
+		}
+		for _, project := range projects {
+			projectToName[project.Id] = string(project.Name)
+		}
+	}
+
 	for _, result := range results {
 		for _, table := range result.Tables {
 			for _, series := range table.Timeseries {
@@ -180,6 +211,8 @@ func (s *oxideScraper) Scrape(ctx context.Context) (pmetric.Metrics, error) {
 					))
 				}
 
+				enrichLabels(resource, siloToName, projectToName)
+
 				var sm pmetric.ScopeMetrics
 				if rm.ScopeMetrics().Len() == 0 {
 					sm = rm.ScopeMetrics().AppendEmpty()
@@ -292,6 +325,19 @@ func addLabels(series oxide.Timeseries, table oxide.OxqlTable, resource pcommon.
 	return nil
 }
 
+func enrichLabels(resource pcommon.Resource, silos map[string]string, projects map[string]string) {
+	if siloID, ok := resource.Attributes().Get("silo_id"); ok {
+		if siloName, ok := silos[siloID.Str()]; ok {
+			resource.Attributes().PutStr("silo_name", siloName)
+		}
+	}
+	if projectID, ok := resource.Attributes().Get("project_id"); ok {
+		if projectName, ok := projects[projectID.Str()]; ok {
+			resource.Attributes().PutStr("project_name", projectName)
+		}
+	}
+}
+
 func addHistogram(dataPoints pmetric.HistogramDataPointSlice, quantileGauge pmetric.Gauge, table oxide.OxqlTable, series oxide.Timeseries) error {
 	timestamps := series.Points.Timestamps
 	for idx, point := range series.Points.Values {

scraper_test.go

@@ -109,6 +109,58 @@ func TestAddLabels(t *testing.T) {
 	}
 }
 
+func TestEnrichLabels(t *testing.T) {
+	for _, tc := range []struct {
+		name         string
+		resource     pcommon.Resource
+		silos        map[string]string
+		projects     map[string]string
+		wantResource pcommon.Resource
+	}{
+		{
+			name: "silo",
+			resource: func() pcommon.Resource {
+				r := pcommon.NewResource()
+				r.Attributes().PutStr("silo_id", "123e4567-e89b-12d3-a456-426614174000")
+				return r
+			}(),
+			silos: map[string]string{
+				"123e4567-e89b-12d3-a456-426614174000": "default",
+			},
+			projects: map[string]string{},
+			wantResource: func() pcommon.Resource {
+				r := pcommon.NewResource()
+				r.Attributes().PutStr("silo_id", "123e4567-e89b-12d3-a456-426614174000")
+				r.Attributes().PutStr("silo_name", "default")
+				return r
+			}(),
+		},
+		{
+			name: "project",
+			resource: func() pcommon.Resource {
+				r := pcommon.NewResource()
+				r.Attributes().PutStr("project_id", "987fcdeb-51a2-43f7-b890-123456789abc")
+				return r
+			}(),
+			silos: map[string]string{},
+			projects: map[string]string{
+				"987fcdeb-51a2-43f7-b890-123456789abc": "my-project",
+			},
+			wantResource: func() pcommon.Resource {
+				r := pcommon.NewResource()
+				r.Attributes().PutStr("project_id", "987fcdeb-51a2-43f7-b890-123456789abc")
+				r.Attributes().PutStr("project_name", "my-project")
+				return r
+			}(),
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			enrichLabels(tc.resource, tc.silos, tc.projects)
+			require.Equal(t, tc.wantResource.Attributes().AsRaw(), tc.resource.Attributes().AsRaw())
+		})
+	}
+}
+
 func TestAddPoint(t *testing.T) {
 	now := time.Now()
 	table := oxide.OxqlTable{Name: "test_metric"}