feat: POC of adding subscription_name to metric labels

src/Promitor.Agents.ResourceDiscovery/Controllers/v2/SubscriptionsV2Controller.cs

@@ -0,0 +1,55 @@
+using System.Collections.Generic;
+using System.Net;
+using System.Threading.Tasks;
+using GuardNet;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+using Promitor.Agents.ResourceDiscovery.Graph.Exceptions;
+using Promitor.Agents.ResourceDiscovery.Graph.Repositories.Interfaces;
+using Promitor.Agents.ResourceDiscovery.Scheduling;
+using Promitor.Core.Contracts;
+
+namespace Promitor.Agents.ResourceDiscovery.Controllers.v2
+{
+ /// <summary>
+ /// API endpoint to list Azure subscriptions
+ /// </summary>
+ [ApiController]
+ [Route("api/v2/subscriptions")]
+ public class SubscriptionsV2Controller : ControllerBase
+ {
+ private readonly JsonSerializerSettings _serializerSettings;
+
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SubscriptionsV2Controller"/> class.
+ /// </summary>
+ public SubscriptionsV2Controller(IAzureResourceRepository azureResourceRepository)
+ {
+ Guard.NotNull(azureResourceRepository, nameof(azureResourceRepository));
+
+ _serializerSettings = new JsonSerializerSettings
+ {
+ NullValueHandling = NullValueHandling.Ignore,
+ TypeNameHandling = TypeNameHandling.Objects
+ };
+ _serializerSettings.Converters.Add(new StringEnumConverter());
+ }
+
+ /// <summary>
+ /// List subscriptions
+ /// </summary>
+ [HttpGet(Name = "SubscriptionsV2_Get")]
+ [ProducesResponseType(typeof(List<AzureSubscription>), StatusCodes.Status200OK)]
+ public IActionResult Get()
+ {
+ var serializedResources = JsonConvert.SerializeObject(AzureSubscriptionDiscoveryBackgroundJob.CurrentSubscriptions, _serializerSettings);
+
+ var response = Content(serializedResources, "application/json");
+ response.StatusCode = (int) HttpStatusCode.OK;
+
+ return response;
+ }
+ }
+}

src/Promitor.Agents.ResourceDiscovery/Scheduling/AzureSubscriptionDiscoveryBackgroundJob.cs

@@ -15,7 +15,9 @@ public class AzureSubscriptionDiscoveryBackgroundJob : DiscoveryBackgroundJob, I
  {
  public const string MetricName = "promitor_azure_landscape_subscription_info";
  public const string MetricDescription = "Provides information concerning the Azure subscriptions in the landscape that Promitor has access to.";
-
+
+ public static List<AzureSubscription> CurrentSubscriptions { get; private set; } = new List<AzureSubscription>();
+
  public AzureSubscriptionDiscoveryBackgroundJob(string jobName, IAzureResourceRepository azureResourceRepository, ISystemMetricsPublisher systemMetricsPublisher, ILogger<AzureSubscriptionDiscoveryBackgroundJob> logger)
  : base(azureResourceRepository, systemMetricsPublisher, logger)
  {
@@ -32,6 +34,8 @@ public async Task ExecuteAsync(CancellationToken cancellationToken)
 
  // Discover Azure subscriptions
 
+ var newList = new List<AzureSubscription>();
+
  PagedPayload<AzureSubscriptionInformation> discoveredLandscape;
  var currentPage = 1;
  do
@@ -42,12 +46,14 @@ public async Task ExecuteAsync(CancellationToken cancellationToken)
  foreach (var discoveredLandscapeItem in discoveredLandscape.Result)
  {
  ReportDiscoveredAzureInfo(discoveredLandscapeItem);
+ newList.Add(new AzureSubscription { Id = discoveredLandscapeItem.Id, Name = discoveredLandscapeItem.Name });
  }
 
  currentPage++;
  }
  while (discoveredLandscape.HasMore);
 
+ CurrentSubscriptions = newList;
  Logger.LogTrace("Azure subscriptions discovered...");
  }
 

src/Promitor.Agents.Scraper/Discovery/Interfaces/IResourceDiscoveryRepository.cs

@@ -9,5 +9,6 @@ public interface IResourceDiscoveryRepository
  {
  Task<List<AzureResourceDefinition>> GetResourceDiscoveryGroupAsync(string resourceDiscoveryGroupName);
  Task<AgentHealthReport> GetHealthAsync();
+ Task<List<AzureSubscription>> GetSubscriptionsAsync();
  }
 }

src/Promitor.Agents.Scraper/Discovery/ResourceDiscoveryClient.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
@@ -49,6 +50,15 @@ public async Task<AgentHealthReport> GetHealthAsync()
  return healthReport;
  }
 
+ public async Task<List<AzureSubscription>> GetSubscriptionsAsync()
+ {
+ var uri = $"api/v2/subscriptions";
+ var rawResponse = await SendGetRequestAsync(uri);
+
+ var foundSubscriptions = JsonConvert.DeserializeObject<List<AzureSubscription>>(rawResponse, _serializerSettings);
+ return foundSubscriptions;
+ }
+
  private async Task<string> SendGetRequestAsync(string uriPath)
  {
  var url = ComposeUrl(uriPath);

src/Promitor.Agents.Scraper/Discovery/ResourceDiscoveryRepository.cs

@@ -41,5 +41,10 @@ public async Task<AgentHealthReport> GetHealthAsync()
  {
  return await _resourceDiscoveryClient.GetHealthAsync();
  }
+
+ public async Task<List<AzureSubscription>> GetSubscriptionsAsync()
+ {
+ return await _resourceDiscoveryClient.GetSubscriptionsAsync();
+ }
  }
 }

src/Promitor.Agents.Scraper/Discovery/StubResourceDiscoveryRepository.cs

@@ -10,6 +10,7 @@ public class StubResourceDiscoveryRepository : IResourceDiscoveryRepository
  {
  private static readonly List<AzureResourceDefinition> emptyResourceDefinitions = new List<AzureResourceDefinition>();
  private static readonly AgentHealthReport healthReport = new AgentHealthReport();
+ private static readonly List<AzureSubscription> emptySubscriptions = new List<AzureSubscription>();
 
  public Task<List<AzureResourceDefinition>> GetResourceDiscoveryGroupAsync(string resourceDiscoveryGroupName)
  {
@@ -20,5 +21,10 @@ public Task<AgentHealthReport> GetHealthAsync()
  {
  return Task.FromResult(healthReport);
  }
+
+ public Task<List<AzureSubscription>> GetSubscriptionsAsync()
+ {
+ return Task.FromResult(emptySubscriptions);
+ }
  }
 }

src/Promitor.Agents.Scraper/Scheduling/ResourcesScrapingJob.cs

@@ -132,6 +132,8 @@ public async Task ExecuteAsync(CancellationToken cancellationToken)
 
  try
  {
+ await UpdateSubscriptionMappings(cancellationToken);
+
  var scrapeDefinitions = await GetAllScrapeDefinitions(cancellationToken);
 
  await ScrapeMetrics(scrapeDefinitions, cancellationToken);
@@ -150,6 +152,16 @@ public async Task ExecuteAsync(CancellationToken cancellationToken)
  }
  }
 
+ private async Task UpdateSubscriptionMappings(CancellationToken cancellationToken)
+ {
+ var list = await _resourceDiscoveryRepository.GetSubscriptionsAsync();
+ foreach (var sub in list)
+ {
+ _azureScrapingSystemMetricsPublisher.RegisterSubscriptionMapping(sub.Id, sub.Name);
+ _metricSinkWriter.RegisterSubscriptionMapping(sub.Id, sub.Name);
+ }
+ }
+
  private async Task<IReadOnlyCollection<ScrapeDefinition<IAzureResourceDefinition>>> GetAllScrapeDefinitions(CancellationToken cancellationToken)
  {
  var scrapeDefinitions = new ConcurrentBag<ScrapeDefinition<IAzureResourceDefinition>>();

src/Promitor.Core.Contracts/AzureSubscription.cs

@@ -0,0 +1,8 @@
+namespace Promitor.Core.Contracts
+{
+ public class AzureSubscription
+ {
+ public string Name { get; set; }
+ public string Id { get; set; }
+ }
+}

src/Promitor.Core/Metrics/Interfaces/IAzureScrapingSystemMetricsPublisher.cs

@@ -1,10 +1,18 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace Promitor.Core.Metrics.Interfaces
 {
  public interface IAzureScrapingSystemMetricsPublisher : ISystemMetricsPublisher
  {
+ /// <summary>
+ /// Registers or updates a subscription ID to name mapping
+ /// </summary>
+ /// <param name="id">Subscription ID.</param>
+ /// <param name="name">Subscription name.</param>
+ void RegisterSubscriptionMapping(string id, string name);
+
  /// <summary>
  /// Sets a new value for a measurement on a gauge
  /// </summary>

src/Promitor.Core/Metrics/Sinks/MetricSinkWriter.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
@@ -10,6 +11,8 @@ namespace Promitor.Core.Metrics.Sinks
  public class MetricSinkWriter
  {
  private readonly List<IMetricSink> _configuredSinks;
+ private readonly ConcurrentDictionary<string, string> _subscriptionMappings = new ConcurrentDictionary<string, string>();
+
  private ILogger Logger { get; }
 
  public List<MetricSinkType> EnabledMetricSinks { get; }
@@ -26,10 +29,16 @@ public MetricSinkWriter(IEnumerable<IMetricSink> configuredSinks, ILogger<Metric
  this.EnabledMetricSinks = metricSinks.Select(x => x.Type).Distinct().ToList();
  }
 
+ public void RegisterSubscriptionMapping(string id, string name)
+ {
+ _subscriptionMappings[id] = name;
+ }
+
  public async Task ReportMetricAsync(string metricName, string metricDescription, ScrapeResult scrapedMetricResult)
  {
  Guard.NotNullOrWhitespace(metricName, nameof(metricName));
  Guard.NotNull(scrapedMetricResult, nameof(scrapedMetricResult));
+ addSubscriptionNameLabel(scrapedMetricResult.Labels);
 
  var reportTasks = new List<Task>();
  foreach (var sink in _configuredSinks)
@@ -62,6 +71,7 @@ public async Task ReportMetricAsync(string metricName, string metricDescription,
  {
  Guard.NotNullOrWhitespace(metricName, nameof(metricName));
  Guard.NotNull(metricLabels, nameof(metricLabels));
+ addSubscriptionNameLabel(metricLabels);
 
  var reportTasks = new List<Task>();
  foreach (var sink in _configuredSinks)
@@ -72,5 +82,20 @@ public async Task ReportMetricAsync(string metricName, string metricDescription,
 
  await Task.WhenAll(reportTasks);
  }
+
+ private void addSubscriptionNameLabel(Dictionary<string, string> labels)
+ {
+ if (!labels.ContainsKey("subscription_id")) return;
+
+ string nameValue;
+ if (_subscriptionMappings.TryGetValue(labels["subscription_id"], out nameValue))
+ {
+ labels["subscription_name"] = nameValue;
+ }
+ else
+ {
+ labels["subscription_name"] = "";
+ }
+ }
  }
 }

src/Promitor.Integrations.Sinks.Prometheus/Collectors/AzureScrapingSystemMetricsPublisher.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 using GuardNet;
@@ -14,6 +15,7 @@ public class AzureScrapingSystemMetricsPublisher : IAzureScrapingSystemMetricsPu
  private readonly ISystemMetricsPublisher _systemMetricsPublisher;
  private readonly IMetricsDeclarationProvider _metricsDeclarationProvider;
  private readonly IOptionsMonitor<PrometheusScrapingEndpointSinkConfiguration> _prometheusConfiguration;
+ private readonly ConcurrentDictionary<string, string> _subscriptionMappings = new ConcurrentDictionary<string, string>();
 
  public AzureScrapingSystemMetricsPublisher(IMetricsDeclarationProvider metricsDeclarationProvider, ISystemMetricsPublisher systemMetricsPublisher, IOptionsMonitor<PrometheusScrapingEndpointSinkConfiguration> prometheusConfiguration)
  {
@@ -25,6 +27,16 @@ public AzureScrapingSystemMetricsPublisher(IMetricsDeclarationProvider metricsDe
  _metricsDeclarationProvider = metricsDeclarationProvider;
  }
 
+ /// <summary>
+ /// Registers or updates a subscription ID to name mapping
+ /// </summary>
+ /// <param name="id">Subscription ID.</param>
+ /// <param name="name">Subscription name.</param>
+ public void RegisterSubscriptionMapping(string id, string name)
+ {
+ _subscriptionMappings[id] = name;
+ }
+
  /// <summary>
  /// Sets a new value for a measurement on a gauge
  /// </summary>
@@ -42,14 +54,33 @@ public async Task WriteGaugeMeasurementAsync(string name, string description, do
  labels.Add("tenant_id", metricsDeclaration.AzureMetadata.TenantId);
  }
 
+ addSubscriptionNameLabel(labels);
+
  var orderedLabels = labels.OrderByDescending(kvp => kvp.Key).ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
 
  await _systemMetricsPublisher.WriteGaugeMeasurementAsync(name, description, value, orderedLabels, enableMetricTimestamps);
  }
 
  public async Task WriteGaugeMeasurementAsync(string name, string description, double value, Dictionary<string, string> labels, bool includeTimestamp)
  {
+ addSubscriptionNameLabel(labels);
+
  await _systemMetricsPublisher.WriteGaugeMeasurementAsync(name, description, value, labels, includeTimestamp);
  }
+
+ private void addSubscriptionNameLabel(Dictionary<string, string> labels)
+ {
+ if (!labels.ContainsKey("subscription_id")) return;
+
+ string nameValue;
+ if (_subscriptionMappings.TryGetValue(labels["subscription_id"], out nameValue))
+ {
+ labels["subscription_name"] = nameValue;
+ }
+ else
+ {
+ labels["subscription_name"] = "";
+ }
+ }
  }
 }