-
-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for multiple resource groups (#442)
* Initial support for multiple resource groups And support in testing. * Brandon saves the space * Moving resourcegroup to new scraper * space merging * Merging index * Adding clarity to explanation before multi rg sample * Everyone having fun... but me :( * Adding XML tags for Scraper.cs * Update comments Co-Authored-By: brusMX <[email protected]> * Typo Scraper Co-Authored-By: brusMX <[email protected]> * Changing resourceGroupName definition on documentation Co-Authored-By: brusMX <[email protected]> * XML fix
- Loading branch information
Showing
14 changed files
with
253 additions
and
271 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,123 +1,127 @@ | ||
| using System; | ||
| using System.Threading.Tasks; | ||
| using GuardNet; | ||
| using Microsoft.Azure.Management.Monitor.Fluent.Models; | ||
| using Microsoft.Extensions.Logging; | ||
| using Newtonsoft.Json; | ||
| using Prometheus.Client; | ||
| using Promitor.Core.Infrastructure; | ||
| using Promitor.Core.Scraping.Configuration.Model; | ||
| using Promitor.Core.Scraping.Interfaces; | ||
| using Promitor.Core.Telemetry.Interfaces; | ||
| using Promitor.Integrations.AzureMonitor; | ||
| using MetricDefinition = Promitor.Core.Scraping.Configuration.Model.Metrics.MetricDefinition; | ||
| // ReSharper disable All | ||
|
|
||
| namespace Promitor.Core.Scraping | ||
| { | ||
| /// <summary> | ||
| /// Azure Monitor Scrape | ||
| /// </summary> | ||
| /// <typeparam name="TMetricDefinition">Type of metric definition that is being used</typeparam> | ||
| public abstract class Scraper<TMetricDefinition> : IScraper<MetricDefinition> | ||
| where TMetricDefinition : MetricDefinition, new() | ||
| { | ||
| private readonly IExceptionTracker _exceptionTracker; | ||
| private readonly ILogger _logger; | ||
|
|
||
| /// <summary> | ||
| /// Constructor | ||
| /// </summary> | ||
| /// <param name="azureMetadata">Metadata concerning the Azure resources</param> | ||
| /// <param name="azureMonitorClient">Client to communicate with Azure Monitor</param> | ||
| /// <param name="metricDefaults">Default configuration for metrics</param> | ||
| /// <param name="logger">General logger</param> | ||
| /// <param name="exceptionTracker">Exception tracker</param> | ||
| protected Scraper(AzureMetadata azureMetadata, MetricDefaults metricDefaults, AzureMonitorClient azureMonitorClient, | ||
| ILogger logger, IExceptionTracker exceptionTracker) | ||
| { | ||
| Guard.NotNull(exceptionTracker, nameof(exceptionTracker)); | ||
| Guard.NotNull(azureMetadata, nameof(azureMetadata)); | ||
| Guard.NotNull(metricDefaults, nameof(metricDefaults)); | ||
| Guard.NotNull(azureMonitorClient, nameof(azureMonitorClient)); | ||
|
|
||
| _logger = logger; | ||
| _exceptionTracker = exceptionTracker; | ||
|
|
||
| AzureMetadata = azureMetadata; | ||
| MetricDefaults = metricDefaults; | ||
| AzureMonitorClient = azureMonitorClient; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Metadata concerning the Azure resources | ||
| /// </summary> | ||
| protected AzureMetadata AzureMetadata { get; } | ||
|
|
||
| /// <summary> | ||
| /// Default configuration for metrics | ||
| /// </summary> | ||
| protected MetricDefaults MetricDefaults { get; } | ||
|
|
||
| /// <summary> | ||
| /// Client to interact with Azure Monitor | ||
| /// </summary> | ||
| protected AzureMonitorClient AzureMonitorClient { get; } | ||
|
|
||
| public async Task ScrapeAsync(MetricDefinition metricDefinition) | ||
| { | ||
| try | ||
| { | ||
| if (metricDefinition == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(metricDefinition)); | ||
| } | ||
|
|
||
| if (!(metricDefinition is TMetricDefinition castedMetricDefinition)) | ||
| { | ||
| throw new ArgumentException($"Could not cast metric definition of type '{metricDefinition.ResourceType}' to {typeof(TMetricDefinition)}. Payload: {JsonConvert.SerializeObject(metricDefinition)}"); | ||
| } | ||
|
|
||
| var aggregationInterval = DetermineMetricAggregationInterval(metricDefinition); | ||
| var aggregationType = metricDefinition.AzureMetricConfiguration.Aggregation.Type; | ||
| var foundMetricValue = await ScrapeResourceAsync(castedMetricDefinition, aggregationType, aggregationInterval); | ||
|
|
||
| _logger.LogInformation("Found value '{MetricValue}' for metric '{MetricName}' with aggregation interval '{AggregationInterval}'", foundMetricValue, metricDefinition.Name, aggregationInterval); | ||
|
|
||
| var metricsTimestampFeatureFlag = FeatureFlag.IsActive("METRICSTIMESTAMP", defaultFlagState: true); | ||
|
|
||
| var gauge = Metrics.CreateGauge(metricDefinition.Name, metricDefinition.Description, includeTimestamp: metricsTimestampFeatureFlag); | ||
| gauge.Set(foundMetricValue); | ||
| } | ||
| catch (Exception exception) | ||
| { | ||
| _exceptionTracker.Track(exception); | ||
| } | ||
| } | ||
|
|
||
| private TimeSpan DetermineMetricAggregationInterval(MetricDefinition metricDefinition) | ||
| { | ||
| Guard.NotNull(metricDefinition, nameof(metricDefinition)); | ||
|
|
||
| if (metricDefinition?.AzureMetricConfiguration?.Aggregation?.Interval != null) | ||
| { | ||
| return metricDefinition.AzureMetricConfiguration.Aggregation.Interval.Value; | ||
| } | ||
|
|
||
| if (MetricDefaults.Aggregation.Interval == null) | ||
| { | ||
| throw new Exception($"No default aggregation interval is configured nor on the metric configuration for '{metricDefinition?.Name}'"); | ||
| } | ||
|
|
||
| return MetricDefaults.Aggregation.Interval.Value; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Scrapes the configured resource | ||
| /// </summary> | ||
| /// <param name="metricDefinition">Definition of the metric to scrape</param> | ||
| /// <param name="aggregationType">Aggregation for the metric to use</param> | ||
| /// <param name="aggregationInterval">Interval that is used to aggregate metrics</param> | ||
| protected abstract Task<double> ScrapeResourceAsync(TMetricDefinition metricDefinition, AggregationType aggregationType, TimeSpan aggregationInterval); | ||
| } | ||
| } | ||
| using System; | ||
| using System.Threading.Tasks; | ||
| using GuardNet; | ||
| using Microsoft.Azure.Management.Monitor.Fluent.Models; | ||
| using Microsoft.Extensions.Logging; | ||
| using Newtonsoft.Json; | ||
| using Prometheus.Client; | ||
| using Promitor.Core.Infrastructure; | ||
| using Promitor.Core.Scraping.Configuration.Model; | ||
| using Promitor.Core.Scraping.Interfaces; | ||
| using Promitor.Core.Telemetry.Interfaces; | ||
| using Promitor.Integrations.AzureMonitor; | ||
| using MetricDefinition = Promitor.Core.Scraping.Configuration.Model.Metrics.MetricDefinition; | ||
| // ReSharper disable All | ||
|
|
||
| namespace Promitor.Core.Scraping | ||
| { | ||
| /// <summary> | ||
| /// Azure Monitor Scraper | ||
| /// </summary> | ||
| /// <typeparam name="TMetricDefinition">Type of metric definition that is being used</typeparam> | ||
| public abstract class Scraper<TMetricDefinition> : IScraper<MetricDefinition> | ||
| where TMetricDefinition : MetricDefinition, new() | ||
| { | ||
| private readonly IExceptionTracker _exceptionTracker; | ||
| private readonly ILogger _logger; | ||
|
|
||
| /// <summary> | ||
| /// Constructor | ||
| /// </summary> | ||
| /// <param name="azureMetadata">Metadata concerning the Azure resources</param> | ||
| /// <param name="azureMonitorClient">Client to communicate with Azure Monitor</param> | ||
| /// <param name="metricDefaults">Default configuration for metrics</param> | ||
| /// <param name="logger">General logger</param> | ||
| /// <param name="exceptionTracker">Exception tracker</param> | ||
| protected Scraper(AzureMetadata azureMetadata, MetricDefaults metricDefaults, AzureMonitorClient azureMonitorClient, | ||
| ILogger logger, IExceptionTracker exceptionTracker) | ||
| { | ||
| Guard.NotNull(exceptionTracker, nameof(exceptionTracker)); | ||
| Guard.NotNull(azureMetadata, nameof(azureMetadata)); | ||
| Guard.NotNull(metricDefaults, nameof(metricDefaults)); | ||
| Guard.NotNull(azureMonitorClient, nameof(azureMonitorClient)); | ||
|
|
||
| _logger = logger; | ||
| _exceptionTracker = exceptionTracker; | ||
|
|
||
| AzureMetadata = azureMetadata; | ||
| MetricDefaults = metricDefaults; | ||
| AzureMonitorClient = azureMonitorClient; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Metadata concerning the Azure resources | ||
| /// </summary> | ||
| protected AzureMetadata AzureMetadata { get; } | ||
|
|
||
| /// <summary> | ||
| /// Default configuration for metrics | ||
| /// </summary> | ||
| protected MetricDefaults MetricDefaults { get; } | ||
|
|
||
| /// <summary> | ||
| /// Client to interact with Azure Monitor | ||
| /// </summary> | ||
| protected AzureMonitorClient AzureMonitorClient { get; } | ||
|
|
||
| public async Task ScrapeAsync(MetricDefinition metricDefinition) | ||
| { | ||
| try | ||
| { | ||
| if (metricDefinition == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(metricDefinition)); | ||
| } | ||
|
|
||
| if (!(metricDefinition is TMetricDefinition castedMetricDefinition)) | ||
| { | ||
| throw new ArgumentException($"Could not cast metric definition of type '{metricDefinition.ResourceType}' to {typeof(TMetricDefinition)}. Payload: {JsonConvert.SerializeObject(metricDefinition)}"); | ||
| } | ||
|
|
||
| var aggregationInterval = DetermineMetricAggregationInterval(metricDefinition); | ||
| var aggregationType = metricDefinition.AzureMetricConfiguration.Aggregation.Type; | ||
| var resourceGroupName = string.IsNullOrEmpty(metricDefinition.ResourceGroupName) ? AzureMetadata.ResourceGroupName : metricDefinition.ResourceGroupName; | ||
| var foundMetricValue = await ScrapeResourceAsync(AzureMetadata.SubscriptionId, resourceGroupName, castedMetricDefinition, aggregationType, aggregationInterval); | ||
|
|
||
| _logger.LogInformation("Found value '{MetricValue}' for metric '{MetricName}' with aggregation interval '{AggregationInterval}'", foundMetricValue, metricDefinition.Name, aggregationInterval); | ||
|
|
||
| var metricsTimestampFeatureFlag = FeatureFlag.IsActive("METRICSTIMESTAMP", defaultFlagState: true); | ||
|
|
||
| var gauge = Metrics.CreateGauge(metricDefinition.Name, metricDefinition.Description, includeTimestamp: metricsTimestampFeatureFlag); | ||
| gauge.Set(foundMetricValue); | ||
| } | ||
| catch (Exception exception) | ||
| { | ||
| _exceptionTracker.Track(exception); | ||
| } | ||
| } | ||
|
|
||
| private TimeSpan DetermineMetricAggregationInterval(MetricDefinition metricDefinition) | ||
| { | ||
| Guard.NotNull(metricDefinition, nameof(metricDefinition)); | ||
|
|
||
| if (metricDefinition?.AzureMetricConfiguration?.Aggregation?.Interval != null) | ||
| { | ||
| return metricDefinition.AzureMetricConfiguration.Aggregation.Interval.Value; | ||
| } | ||
|
|
||
| if (MetricDefaults.Aggregation.Interval == null) | ||
| { | ||
| throw new Exception($"No default aggregation interval is configured nor on the metric configuration for '{metricDefinition?.Name}'"); | ||
| } | ||
|
|
||
| return MetricDefaults.Aggregation.Interval.Value; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Scrapes the configured resource | ||
| /// </summary> | ||
| /// <param name="subscriptionId">Metric subscription Id</param> | ||
| /// <param name="resourceGroupName">Metric Resource Group</param> | ||
| /// <param name="metricDefinition">Definition of the metric to scrape</param> | ||
| /// <param name="aggregationType">Aggregation for the metric to use</param> | ||
| /// <param name="aggregationInterval">Interval that is used to aggregate metrics</param> | ||
| /// | ||
| protected abstract Task<double> ScrapeResourceAsync(string subscriptionId, string resourceGroupName, TMetricDefinition metricDefinition, AggregationType aggregationType, TimeSpan aggregationInterval); | ||
| } | ||
| } |
Oops, something went wrong.