feat(resources): add Azure DocumentDB MongoCluster support (#2713)

Krishna-Chaitanya4 · Krishna Chaitanya Yadav Perugu · web-flow · commit 73995ba60d63 · 2025-12-11T11:47:48.000+05:30
Co-authored-by: Krishna Chaitanya Yadav Perugu &lt;perugukrishn8@gmail.com&gt;
diff --git a/changelog/content/experimental/unreleased.md b/changelog/content/experimental/unreleased.md
@@ -6,8 +6,8 @@ version:
 
 #### Scraper
 
-None.
+- {{% tag added %}} Provide support for DocumentDB MongoCluster ([docs](https://docs.promitor.io/scraping/providers/mongo-cluster/))
 
 #### Resource Discovery
 
-None.
+- {{% tag added %}} Provide support for DocumentDB MongoCluster ([docs](https://docs.promitor.io/scraping/providers/mongo-cluster/))
diff --git a/changelog/content/released/v2.15.0-scraper.md b/changelog/content/released/v2.15.0-scraper.md
@@ -10,4 +10,4 @@ version: Scraper - v2.15.0
 - {{% tag feature %}} Provide new health check based on data freshness
 - {{% tag fixed %}} Azure Monitor Scraper: batch based on aggregation in addition to existing criteria
 
-Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/Scraper-v2.15.0).
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/Scraper-v2.15.0).
diff --git a/src/Promitor.Agents.ResourceDiscovery/Graph/ResourceDiscoveryFactory.cs b/src/Promitor.Agents.ResourceDiscovery/Graph/ResourceDiscoveryFactory.cs
@@ -62,6 +62,8 @@ public static ResourceDiscoveryQuery UseResourceDiscoveryFor(ResourceType resour
                     return new LogicAppDiscoveryQuery();
                 case ResourceType.MariaDb:
                     return new MariaDbDiscoveryQuery();
+                case ResourceType.MongoCluster:
+                    return new MongoClusterDiscoveryQuery();
                 case ResourceType.MonitorAutoscale:
                     return new MonitorAutoscaleDiscoveryQuery();
                 case ResourceType.MySql:
diff --git a/src/Promitor.Agents.ResourceDiscovery/Graph/ResourceTypes/MongoClusterDiscoveryQuery.cs b/src/Promitor.Agents.ResourceDiscovery/Graph/ResourceTypes/MongoClusterDiscoveryQuery.cs
@@ -0,0 +1,21 @@
+using GuardNet;
+using Newtonsoft.Json.Linq;
+using Promitor.Core.Contracts;
+using Promitor.Core.Contracts.ResourceTypes;
+
+namespace Promitor.Agents.ResourceDiscovery.Graph.ResourceTypes
+{
+    public class MongoClusterDiscoveryQuery : ResourceDiscoveryQuery
+    {
+        public override string[] ResourceTypes => new[] { "microsoft.documentdb/mongoclusters" };
+        public override string[] ProjectedFieldNames => new[] { "subscriptionId", "resourceGroup", "type", "name" };
+
+        public override AzureResourceDefinition ParseResults(JToken resultRowEntry)
+        {
+            Guard.NotNull(resultRowEntry, nameof(resultRowEntry));
+            
+            var resource = new MongoClusterResourceDefinition(resultRowEntry[0]?.ToString(), resultRowEntry[1]?.ToString(), resultRowEntry[3]?.ToString());
+            return resource;
+        }
+    }
+}
diff --git a/src/Promitor.Agents.Scraper/Validation/Factories/MetricValidatorFactory.cs b/src/Promitor.Agents.Scraper/Validation/Factories/MetricValidatorFactory.cs
@@ -71,6 +71,8 @@ internal static IMetricValidator GetValidatorFor(ResourceType resourceType)
                     return new LogicAppMetricValidator();
                 case ResourceType.MariaDb:
                     return new MariaDbMetricValidator();
+                case ResourceType.MongoCluster:
+                    return new MongoClusterMetricValidator();
                 case ResourceType.MonitorAutoscale:
                     return new MonitorAutoscaleMetricValidator();
                 case ResourceType.MySql:
diff --git a/src/Promitor.Agents.Scraper/Validation/MetricDefinitions/ResourceTypes/MongoClusterMetricValidator.cs b/src/Promitor.Agents.Scraper/Validation/MetricDefinitions/ResourceTypes/MongoClusterMetricValidator.cs
@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.Linq;
+using GuardNet;
+using Promitor.Core.Scraping.Configuration.Model.Metrics;
+using Promitor.Agents.Scraper.Validation.MetricDefinitions.Interfaces;
+using Promitor.Core.Contracts.ResourceTypes;
+
+namespace Promitor.Agents.Scraper.Validation.MetricDefinitions.ResourceTypes
+{
+    internal class MongoClusterMetricValidator : IMetricValidator
+    {
+        public IEnumerable<string> Validate(MetricDefinition metricDefinition)
+        {
+            Guard.NotNull(metricDefinition, nameof(metricDefinition));
+
+            foreach (var resourceDefinition in metricDefinition.Resources.Cast<MongoClusterResourceDefinition>())
+            {
+                if (string.IsNullOrWhiteSpace(resourceDefinition.ClusterName))
+                {
+                    yield return "No Mongo cluster name is configured";
+                }
+            }
+        }
+    }
+}
diff --git a/src/Promitor.Core.Contracts/ResourceType.cs b/src/Promitor.Core.Contracts/ResourceType.cs
@@ -58,5 +58,6 @@ public enum ResourceType
         AzureFirewall = 53,
         CognitiveServicesAccount = 54,
         DnsZone = 55,
+        MongoCluster = 56,
     }
 }
diff --git a/src/Promitor.Core.Contracts/ResourceTypes/MongoClusterResourceDefinition.cs b/src/Promitor.Core.Contracts/ResourceTypes/MongoClusterResourceDefinition.cs
@@ -0,0 +1,13 @@
+namespace Promitor.Core.Contracts.ResourceTypes
+{
+    public class MongoClusterResourceDefinition : AzureResourceDefinition
+    {
+        public MongoClusterResourceDefinition(string subscriptionId, string resourceGroupName, string clusterName)
+            : base(ResourceType.MongoCluster, subscriptionId, resourceGroupName, clusterName)
+        {
+            ClusterName = clusterName;
+        }
+
+        public string ClusterName { get; }
+    }
+}
diff --git a/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Core/AzureResourceDeserializerFactory.cs b/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Core/AzureResourceDeserializerFactory.cs
@@ -111,6 +111,9 @@ public IDeserializer<AzureResourceDefinitionV1> GetDeserializerFor(ResourceType
                 case ResourceType.MariaDb:
                     var mariaDbLogger = _loggerFactory.CreateLogger<MariaDbDeserializer>();
                     return new MariaDbDeserializer(mariaDbLogger);
+                case ResourceType.MongoCluster:
+                    var mongoClusterLogger = _loggerFactory.CreateLogger<MongoClusterDeserializer>();
+                    return new MongoClusterDeserializer(mongoClusterLogger);
                 case ResourceType.MonitorAutoscale:
                     var monitorAutoscaleLogger = _loggerFactory.CreateLogger<MonitorAutoscaleDeserializer>();
                     return new MonitorAutoscaleDeserializer(monitorAutoscaleLogger);
diff --git a/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Mapping/V1MappingProfile.cs b/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Mapping/V1MappingProfile.cs
@@ -57,6 +57,7 @@ public V1MappingProfile()
             CreateMap<LogAnalyticsResourceV1, LogAnalyticsResourceDefinition>();
             CreateMap<LogicAppResourceV1, LogicAppResourceDefinition>();
             CreateMap<MariaDbResourceV1, MariaDbResourceDefinition>();
+            CreateMap<MongoClusterResourceV1, MongoClusterResourceDefinition>();
             CreateMap<MonitorAutoscaleResourceV1, MonitorAutoscaleResourceDefinition>();
             CreateMap<MySqlResourceV1, MySqlResourceDefinition>();
             CreateMap<NatGatewayResourceV1, NatGatewayResourceDefinition>();
@@ -119,6 +120,7 @@ public V1MappingProfile()
                 .Include<LogAnalyticsResourceV1, LogAnalyticsResourceDefinition>()
                 .Include<LogicAppResourceV1, LogicAppResourceDefinition>()
                 .Include<MariaDbResourceV1, MariaDbResourceDefinition>()
+                .Include<MongoClusterResourceV1, MongoClusterResourceDefinition>()
                 .Include<MonitorAutoscaleResourceV1, MonitorAutoscaleResourceDefinition>()
                 .Include<MySqlResourceV1, MySqlResourceDefinition>()
                 .Include<NatGatewayResourceV1, NatGatewayResourceDefinition>()
diff --git a/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Model/ResourceTypes/MongoClusterResourceV1.cs b/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Model/ResourceTypes/MongoClusterResourceV1.cs
@@ -0,0 +1,13 @@
+namespace Promitor.Core.Scraping.Configuration.Serialization.v1.Model.ResourceTypes
+{
+    /// <summary>
+    /// Contains the configuration required to scrape a Mongo cluster.
+    /// </summary>
+    public class MongoClusterResourceV1 : AzureResourceDefinitionV1
+    {
+        /// <summary>
+        /// The mongo cluster name.
+        /// </summary>
+        public string ClusterName { get; set; }
+    }
+}
diff --git a/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Providers/MongoClusterDeserializer.cs b/src/Promitor.Core.Scraping/Configuration/Serialization/v1/Providers/MongoClusterDeserializer.cs
@@ -0,0 +1,14 @@
+using Microsoft.Extensions.Logging;
+using Promitor.Core.Scraping.Configuration.Serialization.v1.Model.ResourceTypes;
+
+namespace Promitor.Core.Scraping.Configuration.Serialization.v1.Providers
+{
+    public class MongoClusterDeserializer : ResourceDeserializer<MongoClusterResourceV1>
+    {
+        public MongoClusterDeserializer(ILogger<MongoClusterDeserializer> logger) : base(logger)
+        {
+            Map(resource => resource.ClusterName)
+                .IsRequired();
+        }
+    }
+}
diff --git a/src/Promitor.Core.Scraping/Factories/MetricScraperFactory.cs b/src/Promitor.Core.Scraping/Factories/MetricScraperFactory.cs
@@ -97,6 +97,8 @@ public IScraper<IAzureResourceDefinition> CreateScraper(ResourceType metricDefin
                     return new LogicAppScraper(scraperConfiguration);
                 case ResourceType.MariaDb:
                     return new MariaDbScraper(scraperConfiguration);
+                case ResourceType.MongoCluster:
+                    return new MongoClusterScraper(scraperConfiguration);
                 case ResourceType.MonitorAutoscale:
                     return new MonitorAutoscaleScraper(scraperConfiguration);
                 case ResourceType.MySql:
diff --git a/src/Promitor.Core.Scraping/ResourceTypes/MongoClusterScraper.cs b/src/Promitor.Core.Scraping/ResourceTypes/MongoClusterScraper.cs
@@ -0,0 +1,21 @@
+using Promitor.Core.Contracts;
+using Promitor.Core.Contracts.ResourceTypes;
+using Promitor.Core.Scraping.Configuration.Model.Metrics;
+
+namespace Promitor.Core.Scraping.ResourceTypes
+{
+    public class MongoClusterScraper : AzureMonitorScraper<MongoClusterResourceDefinition>
+    {
+        private const string ResourceUriTemplate = "subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/mongoClusters/{2}";
+
+        public MongoClusterScraper(ScraperConfiguration scraperConfiguration)
+            : base(scraperConfiguration)
+        {
+        }
+
+        protected override string BuildResourceUri(string subscriptionId, ScrapeDefinition<IAzureResourceDefinition> scrapeDefinition, MongoClusterResourceDefinition resource)
+        {
+            return string.Format(ResourceUriTemplate, subscriptionId, scrapeDefinition.ResourceGroupName, resource.ClusterName);
+        }
+    }
+}
diff --git a/src/Promitor.Tests.Unit/Builders/Metrics/v1/MetricsDeclarationBuilder.cs b/src/Promitor.Tests.Unit/Builders/Metrics/v1/MetricsDeclarationBuilder.cs
@@ -658,6 +658,24 @@ public MetricsDeclarationBuilder WithMariaDbMetric(string metricName = "promitor
             return this;
         }
 
+        public MetricsDeclarationBuilder WithMongoClusterMetric(string metricName = "promitor-mongo-cluster",
+            string metricDescription = "Description for a metric",
+            string clusterName = "promitor-mongo-cluster-name",
+            string azureMetricName = "MongoRequestCharge",
+            string resourceDiscoveryGroupName = "",
+            int? azureMetricLimit = null,
+            bool omitResource = false)
+        {
+            var resource = new MongoClusterResourceV1
+            {
+                ClusterName = clusterName
+            };
+
+            CreateAndAddMetricDefinition(ResourceType.MongoCluster, metricName, metricDescription, resourceDiscoveryGroupName, omitResource, azureMetricName, azureMetricLimit, resource);
+
+            return this;
+        }
+
         public MetricsDeclarationBuilder WithMonitorAutoscaleMetric(string metricName = "promitor-autoscale",
             string metricDescription = "Description for a metric",
             string autoscaleSettingsName = "promitor-autoscale-rules",
diff --git a/src/Promitor.Tests.Unit/Validation/Scraper/Metrics/ResourceTypes/MongoClusterMetricsDeclarationValidationStepTests.cs b/src/Promitor.Tests.Unit/Validation/Scraper/Metrics/ResourceTypes/MongoClusterMetricsDeclarationValidationStepTests.cs
@@ -0,0 +1,64 @@
+using System.ComponentModel;
+using Microsoft.Extensions.Logging.Abstractions;
+using Promitor.Agents.Scraper.Validation.Steps;
+using Promitor.Tests.Unit.Builders.Metrics.v1;
+using Promitor.Tests.Unit.Stubs;
+using Xunit;
+
+namespace Promitor.Tests.Unit.Validation.Scraper.Metrics.ResourceTypes
+{
+    [Category("Unit")]
+    public class MongoClusterMetricsDeclarationValidationStepTests : MetricsDeclarationValidationStepsTests
+    {
+        [Fact]
+        public void MongoClusterMetricsDeclaration_DeclarationWithoutAzureMetricName_Fails()
+        {
+            // Arrange
+            var rawDeclaration = MetricsDeclarationBuilder.WithMetadata()
+                .WithMongoClusterMetric(azureMetricName: string.Empty)
+                .Build(Mapper);
+            var metricsDeclarationProvider = new MetricsDeclarationProviderStub(rawDeclaration, Mapper);
+
+            // Act
+            var scrapingScheduleValidationStep = new MetricsDeclarationValidationStep(metricsDeclarationProvider, NullLogger<MetricsDeclarationValidationStep>.Instance);
+            var validationResult = scrapingScheduleValidationStep.Run();
+
+            // Assert
+            PromitorAssert.ValidationFailed(validationResult);
+        }
+
+        [Fact]
+        public void MongoClusterMetricsDeclaration_DeclarationWithoutClusterName_Fails()
+        {
+            // Arrange
+            var rawDeclaration = MetricsDeclarationBuilder.WithMetadata()
+                .WithMongoClusterMetric(clusterName: string.Empty)
+                .Build(Mapper);
+            var metricsDeclarationProvider = new MetricsDeclarationProviderStub(rawDeclaration, Mapper);
+
+            // Act
+            var scrapingScheduleValidationStep = new MetricsDeclarationValidationStep(metricsDeclarationProvider, NullLogger<MetricsDeclarationValidationStep>.Instance);
+            var validationResult = scrapingScheduleValidationStep.Run();
+
+            // Assert
+            PromitorAssert.ValidationFailed(validationResult);
+        }
+
+        [Fact]
+        public void MongoClusterMetricsDeclaration_ValidDeclaration_Succeeds()
+        {
+            // Arrange
+            var rawDeclaration = MetricsDeclarationBuilder.WithMetadata()
+                .WithMongoClusterMetric()
+                .Build(Mapper);
+            var metricsDeclarationProvider = new MetricsDeclarationProviderStub(rawDeclaration, Mapper);
+
+            // Act
+            var scrapingScheduleValidationStep = new MetricsDeclarationValidationStep(metricsDeclarationProvider, NullLogger<MetricsDeclarationValidationStep>.Instance);
+            var validationResult = scrapingScheduleValidationStep.Run();
+
+            // Assert
+            PromitorAssert.ValidationIsSuccessful(validationResult);
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -58,5 +58,6 @@ public enum ResourceType`
`58`	`58`	`AzureFirewall = 53,`
`59`	`59`	`CognitiveServicesAccount = 54,`
`60`	`60`	`DnsZone = 55,`
	`61`	`+ MongoCluster = 56,`
`61`	`62`	`}`
`62`	`63`	`}`