[receiver/azuremonitorreceiver] feat: add subscription name resource attribute

Signed-off-by: Célian Garcia <[email protected]>

Author: celian-garcia

.chloggen/azuremonitorreceiver_add-subscription-name.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: azuremonitorreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add subscription name resource attribute
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [39029]
+
+# (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]

receiver/azuremonitorreceiver/documentation.md

@@ -6,5 +6,6 @@
 
 | Name | Description | Values | Enabled |
 | ---- | ----------- | ------ | ------- |
+| azuremonitor.subscription | Azure subscription name | Any Str | false |
 | azuremonitor.subscription_id | Azure subscription ID | Any Str | false |
 | azuremonitor.tenant_id | Azure tenant ID | Any Str | false |

receiver/azuremonitorreceiver/internal/metadata/generated_config.go

@@ -1,12 +1,16 @@
 default:
 all_set:
   resource_attributes:
+    azuremonitor.subscription:
+      enabled: true
     azuremonitor.subscription_id:
       enabled: true
     azuremonitor.tenant_id:
       enabled: true
 none_set:
   resource_attributes:
+    azuremonitor.subscription:
+      enabled: false
     azuremonitor.subscription_id:
       enabled: false
     azuremonitor.tenant_id:

receiver/azuremonitorreceiver/internal/metadata/generated_config_test.go

@@ -15,6 +15,9 @@ resource_attributes:
   azuremonitor.subscription_id:
     description: Azure subscription ID
     type: string
+  azuremonitor.subscription:
+    description: Azure subscription name
+    type: string
 
 tests:
   config:

receiver/azuremonitorreceiver/internal/metadata/generated_resource.go

@@ -87,12 +87,14 @@ type mockClientOptionsResolver struct {
 // Indeed, the way to mock Azure API is to provide a fake server that will return the expected data.
 // The fake server is built with "fake" package from Azure SDK for Go, and is set in the client options, via the transport.
 // This ctor takes the mock data in that order:
-// - subscriptions
+// - subscriptions get responses stored by ID
+// - subscriptions list response
 // - resources stored by subscription ID
 // - metrics definitions stored by resource URI
 // - metrics values stored by resource URI and metric name
 func newMockClientOptionsResolver(
-	subscriptions []armsubscriptions.ClientListResponse,
+	subscriptionsGetResponsesByID map[string]armsubscriptions.ClientGetResponse,
+	subscriptionsListResponse []armsubscriptions.ClientListResponse,
 	resources map[string][]armresources.ClientListResponse,
 	metricsDefinitions map[string][]armmonitor.MetricDefinitionsClientListResponse,
 	metrics map[string]map[string]armmonitor.MetricsClientListResponse,
@@ -112,7 +114,8 @@ func newMockClientOptionsResolver(
 
 	// Init subscriptions client options from subscriptions mock data
 	subscriptionsServer := armsubscriptionsfake.Server{
-		NewListPager: newMockSubscriptionsListPager(subscriptions),
+		NewListPager: newMockSubscriptionsListPager(subscriptionsListResponse),
+		Get:          newMockSubscriptionGet(subscriptionsGetResponsesByID),
 	}
 	armSubscriptionsClientOptions := &arm.ClientOptions{
 		ClientOptions: azcore.ClientOptions{

receiver/azuremonitorreceiver/internal/metadata/generated_resource_test.go

@@ -63,7 +63,7 @@ const (
 // and simple subscriptions ids that you can find in config.
 type azureSubscription struct {
 	SubscriptionID   string
-	DisplayName      *string
+	DisplayName      string
 	resourcesUpdated time.Time
 }
 
@@ -142,18 +142,14 @@ func (s *azureScraper) start(_ context.Context, _ component.Host) (err error) {
 	s.subscriptions = map[string]*azureSubscription{}
 	s.resources = map[string]map[string]*azureResource{}
 
-	// Initialize subscription ids from the config. Will be overridden if discovery is enabled anyway.
-	for _, id := range s.cfg.SubscriptionIDs {
-		s.loadSubscription(id)
-	}
-
 	return
 }
 
-func (s *azureScraper) loadSubscription(id string) {
-	s.resources[id] = make(map[string]*azureResource)
-	s.subscriptions[id] = &azureSubscription{
-		SubscriptionID: id,
+func (s *azureScraper) loadSubscription(sub armsubscriptions.Subscription) {
+	s.resources[*sub.SubscriptionID] = make(map[string]*azureResource)
+	s.subscriptions[*sub.SubscriptionID] = &azureSubscription{
+		SubscriptionID: *sub.SubscriptionID,
+		DisplayName:    *sub.DisplayName,
 	}
 }
 
@@ -195,7 +191,7 @@ func (s *azureScraper) loadCredentials() (err error) {
 func (s *azureScraper) scrape(ctx context.Context) (pmetric.Metrics, error) {
 	s.getSubscriptions(ctx)
 
-	for subscriptionID := range s.subscriptions {
+	for subscriptionID, subscription := range s.subscriptions {
 		s.getResources(ctx, subscriptionID)
 
 		resourcesIDsWithDefinitions := make(chan string)
@@ -224,13 +220,14 @@ func (s *azureScraper) scrape(ctx context.Context) (pmetric.Metrics, error) {
 		rb := s.mb.NewResourceBuilder()
 		rb.SetAzuremonitorTenantID(s.cfg.TenantID)
 		rb.SetAzuremonitorSubscriptionID(subscriptionID)
+		rb.SetAzuremonitorSubscription(subscription.DisplayName)
 		s.mb.EmitForResource(metadata.WithResource(rb.Emit()))
 	}
 	return s.mb.Emit(), nil
 }
 
 func (s *azureScraper) getSubscriptions(ctx context.Context) {
-	if !s.cfg.DiscoverSubscriptions || !(time.Since(s.subscriptionsUpdated).Seconds() < s.cfg.CacheResources) {
+	if time.Since(s.subscriptionsUpdated).Seconds() < s.cfg.CacheResources {
 		return
 	}
 
@@ -241,6 +238,20 @@ func (s *azureScraper) getSubscriptions(ctx context.Context) {
 		return
 	}
 
+	if !s.cfg.DiscoverSubscriptions {
+		// if there's only subscription ids configured, we need to get additional info
+		for _, subID := range s.cfg.SubscriptionIDs {
+			resp, err := armSubscriptionClient.Get(ctx, subID, &armsubscriptions.ClientGetOptions{})
+			if err != nil {
+				s.settings.Logger.Error("failed to get Azure Subscription", zap.String("subscription_id", subID), zap.Error(err))
+				return
+			}
+			s.loadSubscription(resp.Subscription)
+		}
+		s.subscriptionsUpdated = time.Now()
+		return
+	}
+
 	opts := &armsubscriptions.ClientListOptions{}
 	pager := armSubscriptionClient.NewListPager(opts)
 
@@ -257,7 +268,7 @@ func (s *azureScraper) getSubscriptions(ctx context.Context) {
 		}
 
 		for _, subscription := range nextResult.Value {
-			s.loadSubscription(*subscription.SubscriptionID)
+			s.loadSubscription(*subscription)
 			delete(existingSubscriptions, *subscription.SubscriptionID)
 		}
 	}