public async Task CreateAndGetAlertConfigurationWithSeriesGroupScope()
{
MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
await using DisposableDataFeed disposableDataFeed = await CreateTempDataFeedAsync(adminClient);
string metricId = disposableDataFeed.DataFeed.MetricIds[TempDataFeedMetricName];
await using DisposableDetectionConfiguration disposableDetectionConfig = await CreateTempDetectionConfigurationAsync(adminClient, metricId);
var dimensions = new Dictionary <string, string>()
{
{ TempDataFeedDimensionNameA, "Delhi" }
};
DimensionKey groupKey = new DimensionKey(dimensions);
var detectionConfigId = disposableDetectionConfig.Configuration.Id;
var scope = MetricAnomalyAlertScope.CreateScopeForSeriesGroup(groupKey);
var metricAlertConfig = new MetricAlertConfiguration(detectionConfigId, scope);
string configName = Recording.GenerateAlphaNumericId("config");
var configToCreate = new AnomalyAlertConfiguration()
{
Name = configName,
MetricAlertConfigurations = { metricAlertConfig }
};
await using var disposableConfig = await DisposableAlertConfiguration.CreateAlertConfigurationAsync(adminClient, configToCreate);
AnomalyAlertConfiguration createdConfig = disposableConfig.Configuration;
Assert.That(createdConfig.Id, Is.Not.Null.And.Not.Empty);
Assert.That(createdConfig.Name, Is.EqualTo(configName));
Assert.That(createdConfig.Description, Is.Empty);
Assert.That(createdConfig.CrossMetricsOperator, Is.Null);
Assert.That(createdConfig.IdsOfHooksToAlert, Is.Not.Null.And.Empty);
Assert.That(createdConfig.DimensionsToSplitAlert, Is.Not.Null.And.Empty);
Assert.That(createdConfig.MetricAlertConfigurations, Is.Not.Null);
MetricAlertConfiguration createdMetricAlertConfig = createdConfig.MetricAlertConfigurations.Single();
Assert.That(createdMetricAlertConfig.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(createdMetricAlertConfig.AlertScope, Is.Not.Null);
Assert.That(createdMetricAlertConfig.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.SeriesGroup));
Assert.That(createdMetricAlertConfig.AlertScope.TopNGroupInScope, Is.Null);
ValidateTempDataFeedDimensionKey(createdMetricAlertConfig.AlertScope.SeriesGroupInScope, "Delhi");
Assert.That(createdMetricAlertConfig.AlertConditions, Is.Not.Null);
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition, Is.Null);
Assert.That(createdMetricAlertConfig.AlertConditions.SeverityCondition, Is.Null);
Assert.That(createdMetricAlertConfig.AlertSnoozeCondition, Is.Null);
Assert.That(createdMetricAlertConfig.UseDetectionResultToFilterAnomalies, Is.False);
}
public async Task CreateAndDeleteAlertConfigurationAsync()
{
string endpoint = MetricsAdvisorUri;
string subscriptionKey = MetricsAdvisorSubscriptionKey;
string apiKey = MetricsAdvisorApiKey;
var credential = new MetricsAdvisorKeyCredential(subscriptionKey, apiKey);
var adminClient = new MetricsAdvisorAdministrationClient(new Uri(endpoint), credential);
#region Snippet:CreateAlertConfigurationAsync
#if SNIPPET
string hookId = "<hookId>";
string anomalyDetectionConfigurationId = "<anomalyDetectionConfigurationId>";
string configurationName = "<configurationName>";
#else
string hookId = HookId;
string anomalyDetectionConfigurationId = DetectionConfigurationId;
string configurationName = GetUniqueName();
#endif
AnomalyAlertConfiguration alertConfiguration = new AnomalyAlertConfiguration()
{
Name = configurationName
};
alertConfiguration.IdsOfHooksToAlert.Add(hookId);
var scope = MetricAnomalyAlertScope.CreateScopeForWholeSeries();
var metricAlertConfiguration = new MetricAlertConfiguration(anomalyDetectionConfigurationId, scope);
alertConfiguration.MetricAlertConfigurations.Add(metricAlertConfiguration);
Response <AnomalyAlertConfiguration> response = await adminClient.CreateAlertConfigurationAsync(alertConfiguration);
AnomalyAlertConfiguration createdAlertConfiguration = response.Value;
Console.WriteLine($"Alert configuration ID: {createdAlertConfiguration.Id}");
#endregion
// Delete the anomaly alert configuration to clean up the Metrics Advisor resource. Do not
// perform this step if you intend to keep using the configuration.
await adminClient.DeleteAlertConfigurationAsync(createdAlertConfiguration.Id);
}
private void ValidateMetricAlertConfiguration(MetricAlertConfiguration configuration)
{
Assert.That(configuration.DetectionConfigurationId, Is.Not.Null.And.Not.Empty);
Assert.That(configuration.AlertScope, Is.Not.Null);
if (configuration.AlertScope.ScopeType == MetricAnomalyAlertScopeType.WholeSeries)
{
Assert.That(configuration.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(configuration.AlertScope.TopNGroupInScope, Is.Null);
}
else if (configuration.AlertScope.ScopeType == MetricAnomalyAlertScopeType.SeriesGroup)
{
Assert.That(configuration.AlertScope.TopNGroupInScope, Is.Null);
ValidateGroupKey(configuration.AlertScope.SeriesGroupInScope);
}
else if (configuration.AlertScope.ScopeType == MetricAnomalyAlertScopeType.TopN)
{
Assert.That(configuration.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(configuration.AlertScope.TopNGroupInScope, Is.Not.Null);
}
else
{
throw new ArgumentOutOfRangeException("Invalid ScopeType value!");
}
Assert.That(configuration.AlertConditions, Is.Not.Null);
MetricBoundaryCondition boundaryCondition = configuration.AlertConditions.MetricBoundaryCondition;
SeverityCondition severityCondition = configuration.AlertConditions.SeverityCondition;
if (boundaryCondition != null)
{
if (boundaryCondition.Direction == BoundaryDirection.Up)
{
Assert.That(boundaryCondition.UpperBound, Is.Not.Null);
Assert.That(boundaryCondition.LowerBound, Is.Null);
}
else if (boundaryCondition.Direction == BoundaryDirection.Down)
{
Assert.That(boundaryCondition.UpperBound, Is.Null);
Assert.That(boundaryCondition.LowerBound, Is.Not.Null);
}
else if (boundaryCondition.Direction == BoundaryDirection.Both)
{
Assert.That(boundaryCondition.UpperBound, Is.Not.Null);
Assert.That(boundaryCondition.LowerBound, Is.Not.Null);
}
else
{
throw new ArgumentOutOfRangeException("Invalid BoundaryDirection value!");
}
if (boundaryCondition.CompanionMetricId != null)
{
Assert.That(boundaryCondition.CompanionMetricId, Is.Not.Empty);
}
Assert.That(boundaryCondition.ShouldAlertIfDataPointMissing, Is.Not.Null);
}
if (severityCondition != null)
{
Assert.That(severityCondition.MinimumAlertSeverity, Is.Not.EqualTo(default(AnomalySeverity)));
Assert.That(severityCondition.MaximumAlertSeverity, Is.Not.EqualTo(default(AnomalySeverity)));
}
if (configuration.AlertSnoozeCondition != null)
{
Assert.That(configuration.AlertSnoozeCondition.SnoozeScope, Is.Not.EqualTo(default(SnoozeScope)));
}
Assert.That(configuration.UseDetectionResultToFilterAnomalies, Is.Not.Null);
}
public async Task UpdateAlertConfigurationWithEveryMember()
{
MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
await using DisposableDataFeed disposableDataFeed = await CreateTempDataFeedAsync(adminClient);
string metricId = disposableDataFeed.DataFeed.MetricIds[TempDataFeedMetricName];
await using DisposableDetectionConfiguration disposableDetectionConfig = await CreateTempDetectionConfigurationAsync(adminClient, metricId);
// Configure the Metric Alert Configurations to be used.
string hookName = Recording.GenerateAlphaNumericId("hook");
var hookToCreate = new EmailNotificationHook(hookName)
{
EmailsToAlert = { "*****@*****.**" }
};
await using var disposableHook = await DisposableNotificationHook.CreateHookAsync(adminClient, hookToCreate);
var detectionConfigId = disposableDetectionConfig.Configuration.Id;
var scope = MetricAnomalyAlertScope.CreateScopeForWholeSeries();
var metricAlertConfig0 = new MetricAlertConfiguration(detectionConfigId, scope)
{
AlertSnoozeCondition = new MetricAnomalyAlertSnoozeCondition(12, SnoozeScope.Series, true),
AlertConditions = new MetricAnomalyAlertConditions()
{
MetricBoundaryCondition = new MetricBoundaryCondition(BoundaryDirection.Both)
{
UpperBound = 20.0,
LowerBound = 10.0,
CompanionMetricId = metricId,
ShouldAlertIfDataPointMissing = true
},
SeverityCondition = new SeverityCondition(AnomalySeverity.Low, AnomalySeverity.Medium)
}
};
var metricAlertConfig1 = new MetricAlertConfiguration(detectionConfigId, scope)
{
UseDetectionResultToFilterAnomalies = true
};
// Create the Anomaly Alert Configuration.
string configName = Recording.GenerateAlphaNumericId("config");
var description = "This hook was created to test the .NET client.";
var hookIds = new List <string>()
{
disposableHook.Hook.Id
};
var metricAlertConfigs = new List <MetricAlertConfiguration>()
{
metricAlertConfig0, metricAlertConfig1
};
var configToCreate = new AnomalyAlertConfiguration()
{
Name = configName,
IdsOfHooksToAlert = { disposableHook.Hook.Id },
MetricAlertConfigurations = { metricAlertConfig0, metricAlertConfig1 },
CrossMetricsOperator = MetricAlertConfigurationsOperator.Xor
};
await using var disposableConfig = await DisposableAlertConfiguration.CreateAlertConfigurationAsync(adminClient, configToCreate);
// Update the created configuration.
AnomalyAlertConfiguration configToUpdate = disposableConfig.Configuration;
configToUpdate.Description = description;
configToUpdate.IdsOfHooksToAlert.Clear();
configToUpdate.DimensionsToSplitAlert.Add(TempDataFeedDimensionNameA);
configToUpdate.CrossMetricsOperator = MetricAlertConfigurationsOperator.And;
configToUpdate.MetricAlertConfigurations.RemoveAt(1);
var newScope = MetricAnomalyAlertScope.CreateScopeForTopNGroup(50, 40, 30);
var newMetricAlertConfig = new MetricAlertConfiguration(detectionConfigId, newScope)
{
AlertSnoozeCondition = new MetricAnomalyAlertSnoozeCondition(4, SnoozeScope.Metric, true),
UseDetectionResultToFilterAnomalies = true
};
configToUpdate.MetricAlertConfigurations.Add(newMetricAlertConfig);
MetricAlertConfiguration metricAlertConfigToUpdate = configToUpdate.MetricAlertConfigurations[0];
metricAlertConfigToUpdate.AlertConditions.MetricBoundaryCondition.UpperBound = 15.0;
metricAlertConfigToUpdate.AlertConditions.MetricBoundaryCondition.LowerBound = 5.0;
metricAlertConfigToUpdate.AlertConditions.MetricBoundaryCondition.CompanionMetricId = null;
metricAlertConfigToUpdate.AlertConditions.MetricBoundaryCondition.ShouldAlertIfDataPointMissing = false;
metricAlertConfigToUpdate.AlertConditions.MetricBoundaryCondition.MeasureType = BoundaryMeasureType.Mean;
metricAlertConfigToUpdate.AlertConditions.SeverityCondition = new SeverityCondition(AnomalySeverity.Medium, AnomalySeverity.High);
metricAlertConfigToUpdate.AlertSnoozeCondition = null;
AnomalyAlertConfiguration updatedConfig = await adminClient.UpdateAlertConfigurationAsync(configToUpdate);
// Validate top-level members.
Assert.That(updatedConfig.Id, Is.EqualTo(configToUpdate.Id));
Assert.That(updatedConfig.Name, Is.EqualTo(configName));
Assert.That(updatedConfig.Description, Is.EqualTo(description));
Assert.That(updatedConfig.CrossMetricsOperator, Is.EqualTo(MetricAlertConfigurationsOperator.And));
Assert.That(updatedConfig.IdsOfHooksToAlert, Is.Not.Null.And.Empty);
Assert.That(updatedConfig.DimensionsToSplitAlert.Single(), Is.EqualTo(TempDataFeedDimensionNameA));
Assert.That(updatedConfig.MetricAlertConfigurations, Is.Not.Null);
// Validate the first Metric Alert Configuration.
MetricAlertConfiguration updatedMetricAlertConfig0 = updatedConfig.MetricAlertConfigurations[0];
Assert.That(updatedMetricAlertConfig0.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(updatedMetricAlertConfig0.AlertScope, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.WholeSeries));
Assert.That(updatedMetricAlertConfig0.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(updatedMetricAlertConfig0.AlertScope.TopNGroupInScope, Is.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.Direction, Is.EqualTo(BoundaryDirection.Both));
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.UpperBound, Is.EqualTo(15.0));
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.LowerBound, Is.EqualTo(5.0));
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.CompanionMetricId, Is.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.ShouldAlertIfDataPointMissing, Is.False);
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.MeasureType, Is.EqualTo(BoundaryMeasureType.Mean));
Assert.That(updatedMetricAlertConfig0.AlertConditions.SeverityCondition, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions.SeverityCondition.MinimumAlertSeverity, Is.EqualTo(AnomalySeverity.Medium));
Assert.That(updatedMetricAlertConfig0.AlertConditions.SeverityCondition.MaximumAlertSeverity, Is.EqualTo(AnomalySeverity.High));
Assert.That(updatedMetricAlertConfig0.AlertSnoozeCondition, Is.Null);
Assert.That(updatedMetricAlertConfig0.UseDetectionResultToFilterAnomalies, Is.False);
// Validate the second Metric Alert Configuration.
MetricAlertConfiguration updatedMetricAlertConfig1 = updatedConfig.MetricAlertConfigurations[1];
Assert.That(updatedMetricAlertConfig1.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(updatedMetricAlertConfig1.AlertScope, Is.Not.Null);
Assert.That(updatedMetricAlertConfig1.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.TopN));
Assert.That(updatedMetricAlertConfig1.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(updatedMetricAlertConfig1.AlertScope.TopNGroupInScope, Is.Not.Null);
Assert.That(updatedMetricAlertConfig1.AlertScope.TopNGroupInScope.Top, Is.EqualTo(50));
Assert.That(updatedMetricAlertConfig1.AlertScope.TopNGroupInScope.Period, Is.EqualTo(40));
Assert.That(updatedMetricAlertConfig1.AlertScope.TopNGroupInScope.MinimumTopCount, Is.EqualTo(30));
Assert.That(updatedMetricAlertConfig1.AlertConditions, Is.Not.Null);
Assert.That(updatedMetricAlertConfig1.AlertConditions.MetricBoundaryCondition, Is.Null);
Assert.That(updatedMetricAlertConfig1.AlertConditions.SeverityCondition, Is.Null);
Assert.That(updatedMetricAlertConfig1.AlertSnoozeCondition, Is.Not.Null);
Assert.That(updatedMetricAlertConfig1.AlertSnoozeCondition.AutoSnooze, Is.EqualTo(4));
Assert.That(updatedMetricAlertConfig1.AlertSnoozeCondition.SnoozeScope, Is.EqualTo(SnoozeScope.Metric));
Assert.That(updatedMetricAlertConfig1.AlertSnoozeCondition.IsOnlyForSuccessive, Is.True);
Assert.That(updatedMetricAlertConfig1.UseDetectionResultToFilterAnomalies, Is.True);
}
public async Task UpdateAlertConfigurationWithMinimumSetup(bool useTokenCrendential)
{
MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient(useTokenCrendential);
await using DisposableDataFeed disposableDataFeed = await CreateTempDataFeedAsync(adminClient);
string metricId = disposableDataFeed.DataFeed.MetricIds[TempDataFeedMetricName];
await using DisposableDetectionConfiguration disposableDetectionConfig = await CreateTempDetectionConfigurationAsync(adminClient, metricId);
// Configure the Metric Alert Configurations to be used.
string hookName = Recording.GenerateAlphaNumericId("hook");
var hookToCreate = new EmailNotificationHook(hookName)
{
EmailsToAlert = { "*****@*****.**" }
};
await using var disposableHook = await DisposableNotificationHook.CreateHookAsync(adminClient, hookToCreate);
var detectionConfigId = disposableDetectionConfig.Configuration.Id;
var scope = MetricAnomalyAlertScope.CreateScopeForWholeSeries();
var metricAlertConfig0 = new MetricAlertConfiguration(detectionConfigId, scope)
{
AlertSnoozeCondition = new MetricAnomalyAlertSnoozeCondition(12, SnoozeScope.Series, true),
AlertConditions = new MetricAnomalyAlertConditions()
{
MetricBoundaryCondition = new MetricBoundaryCondition(BoundaryDirection.Both)
{
UpperBound = 20.0,
LowerBound = 10.0,
CompanionMetricId = metricId,
ShouldAlertIfDataPointMissing = true
},
SeverityCondition = new SeverityCondition(AnomalySeverity.Low, AnomalySeverity.Medium)
}
};
var metricAlertConfig1 = new MetricAlertConfiguration(detectionConfigId, scope)
{
UseDetectionResultToFilterAnomalies = true
};
// Create the Anomaly Alert Configuration.
string configName = Recording.GenerateAlphaNumericId("config");
var hookIds = new List <string>()
{
disposableHook.Hook.Id
};
var configToCreate = new AnomalyAlertConfiguration()
{
Name = configName,
IdsOfHooksToAlert = { disposableHook.Hook.Id },
MetricAlertConfigurations = { metricAlertConfig0, metricAlertConfig1 },
CrossMetricsOperator = MetricAlertConfigurationsOperator.Xor
};
await using var disposableConfig = await DisposableAlertConfiguration.CreateAlertConfigurationAsync(adminClient, configToCreate);
// Update the created configuration.
AnomalyAlertConfiguration configToUpdate = disposableConfig.Configuration;
configToUpdate.CrossMetricsOperator = MetricAlertConfigurationsOperator.Or;
AnomalyAlertConfiguration updatedConfig = await adminClient.UpdateAlertConfigurationAsync(configToUpdate);
// Validate top-level members.
Assert.That(updatedConfig.Id, Is.EqualTo(configToUpdate.Id));
Assert.That(updatedConfig.Name, Is.EqualTo(configName));
Assert.That(updatedConfig.Description, Is.Empty);
Assert.That(updatedConfig.CrossMetricsOperator, Is.EqualTo(MetricAlertConfigurationsOperator.Or));
Assert.That(updatedConfig.IdsOfHooksToAlert, Is.EqualTo(hookIds));
Assert.That(updatedConfig.DimensionsToSplitAlert, Is.Not.Null.And.Empty);
Assert.That(updatedConfig.MetricAlertConfigurations, Is.Not.Null);
Assert.That(updatedConfig.MetricAlertConfigurations.Count, Is.EqualTo(2));
// Validate the first Metric Alert Configuration.
MetricAlertConfiguration updatedMetricAlertConfig0 = updatedConfig.MetricAlertConfigurations[0];
Assert.That(updatedMetricAlertConfig0.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(updatedMetricAlertConfig0.AlertScope, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.WholeSeries));
Assert.That(updatedMetricAlertConfig0.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(updatedMetricAlertConfig0.AlertScope.TopNGroupInScope, Is.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.Direction, Is.EqualTo(BoundaryDirection.Both));
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.UpperBound, Is.EqualTo(20.0));
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.LowerBound, Is.EqualTo(10.0));
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.CompanionMetricId, Is.EqualTo(metricId));
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.ShouldAlertIfDataPointMissing, Is.True);
Assert.That(updatedMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.MeasureType, Is.EqualTo(BoundaryMeasureType.Value));
Assert.That(updatedMetricAlertConfig0.AlertConditions.SeverityCondition, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertConditions.SeverityCondition.MinimumAlertSeverity, Is.EqualTo(AnomalySeverity.Low));
Assert.That(updatedMetricAlertConfig0.AlertConditions.SeverityCondition.MaximumAlertSeverity, Is.EqualTo(AnomalySeverity.Medium));
Assert.That(updatedMetricAlertConfig0.AlertSnoozeCondition, Is.Not.Null);
Assert.That(updatedMetricAlertConfig0.AlertSnoozeCondition.AutoSnooze, Is.EqualTo(12));
Assert.That(updatedMetricAlertConfig0.AlertSnoozeCondition.SnoozeScope, Is.EqualTo(SnoozeScope.Series));
Assert.That(updatedMetricAlertConfig0.AlertSnoozeCondition.IsOnlyForSuccessive, Is.True);
Assert.That(updatedMetricAlertConfig0.UseDetectionResultToFilterAnomalies, Is.False);
// Validate the second Metric Alert Configuration.
MetricAlertConfiguration updatedMetricAlertConfig1 = updatedConfig.MetricAlertConfigurations[1];
Assert.That(updatedMetricAlertConfig1.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(updatedMetricAlertConfig1.AlertScope, Is.Not.Null);
Assert.That(updatedMetricAlertConfig1.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.WholeSeries));
Assert.That(updatedMetricAlertConfig1.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(updatedMetricAlertConfig1.AlertScope.TopNGroupInScope, Is.Null);
Assert.That(updatedMetricAlertConfig1.AlertConditions, Is.Not.Null);
Assert.That(updatedMetricAlertConfig1.AlertConditions.MetricBoundaryCondition, Is.Null);
Assert.That(updatedMetricAlertConfig1.AlertConditions.SeverityCondition, Is.Null);
Assert.That(updatedMetricAlertConfig1.AlertSnoozeCondition, Is.Null);
Assert.That(updatedMetricAlertConfig1.UseDetectionResultToFilterAnomalies, Is.True);
}
public async Task CreateAndGetAlertConfigurationWithMultipleMetricConfigurations()
{
MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
await using DisposableDataFeed disposableDataFeed = await CreateTempDataFeedAsync(adminClient);
string metricId = disposableDataFeed.DataFeed.MetricIds[TempDataFeedMetricName];
await using DisposableDetectionConfiguration disposableDetectionConfig = await CreateTempDetectionConfigurationAsync(adminClient, metricId);
// Configure the Metric Alert Configurations to be used.
var detectionConfigId = disposableDetectionConfig.Configuration.Id;
var scope = MetricAnomalyAlertScope.CreateScopeForWholeSeries();
var metricAlertConfig0 = new MetricAlertConfiguration(detectionConfigId, scope)
{
AlertConditions = new MetricAnomalyAlertConditions()
{
MetricBoundaryCondition = new MetricBoundaryCondition(BoundaryDirection.Up)
{
UpperBound = 20.0
}
},
UseDetectionResultToFilterAnomalies = true
};
var metricAlertConfig1 = new MetricAlertConfiguration(detectionConfigId, scope)
{
AlertConditions = new MetricAnomalyAlertConditions()
{
MetricBoundaryCondition = new MetricBoundaryCondition(BoundaryDirection.Down)
{
LowerBound = 10.0
}
}
};
// Create the Anomaly Alert Configuration.
string configName = Recording.GenerateAlphaNumericId("config");
var configToCreate = new AnomalyAlertConfiguration()
{
Name = configName,
MetricAlertConfigurations = { metricAlertConfig0, metricAlertConfig1 },
CrossMetricsOperator = MetricAlertConfigurationsOperator.Xor
};
await using var disposableConfig = await DisposableAlertConfiguration.CreateAlertConfigurationAsync(adminClient, configToCreate);
// Get the created configuration and validate top-level members.
AnomalyAlertConfiguration createdConfig = disposableConfig.Configuration;
Assert.That(createdConfig.Id, Is.Not.Null.And.Not.Empty);
Assert.That(createdConfig.Name, Is.EqualTo(configName));
Assert.That(createdConfig.Description, Is.Empty);
Assert.That(createdConfig.CrossMetricsOperator, Is.EqualTo(MetricAlertConfigurationsOperator.Xor));
Assert.That(createdConfig.IdsOfHooksToAlert, Is.Not.Null.And.Empty);
Assert.That(createdConfig.DimensionsToSplitAlert, Is.Not.Null.And.Empty);
Assert.That(createdConfig.MetricAlertConfigurations, Is.Not.Null);
Assert.That(createdConfig.MetricAlertConfigurations.Count, Is.EqualTo(2));
// Validate the first Metric Alert Configuration.
MetricAlertConfiguration createdMetricAlertConfig0 = createdConfig.MetricAlertConfigurations[0];
Assert.That(createdMetricAlertConfig0.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(createdMetricAlertConfig0.AlertScope, Is.Not.Null);
Assert.That(createdMetricAlertConfig0.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.WholeSeries));
Assert.That(createdMetricAlertConfig0.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(createdMetricAlertConfig0.AlertScope.TopNGroupInScope, Is.Null);
Assert.That(createdMetricAlertConfig0.AlertConditions, Is.Not.Null);
Assert.That(createdMetricAlertConfig0.AlertConditions.MetricBoundaryCondition, Is.Not.Null);
Assert.That(createdMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.Direction, Is.EqualTo(BoundaryDirection.Up));
Assert.That(createdMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.UpperBound, Is.EqualTo(20.0));
Assert.That(createdMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.LowerBound, Is.Null);
Assert.That(createdMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.CompanionMetricId, Is.Null);
Assert.That(createdMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.ShouldAlertIfDataPointMissing, Is.False);
Assert.That(createdMetricAlertConfig0.AlertConditions.MetricBoundaryCondition.MeasureType, Is.EqualTo(BoundaryMeasureType.Value));
Assert.That(createdMetricAlertConfig0.AlertConditions.SeverityCondition, Is.Null);
Assert.That(createdMetricAlertConfig0.AlertSnoozeCondition, Is.Null);
Assert.That(createdMetricAlertConfig0.UseDetectionResultToFilterAnomalies, Is.True);
// Validate the second Metric Alert Configuration.
MetricAlertConfiguration createdMetricAlertConfig1 = createdConfig.MetricAlertConfigurations[1];
Assert.That(createdMetricAlertConfig1.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(createdMetricAlertConfig1.AlertScope, Is.Not.Null);
Assert.That(createdMetricAlertConfig1.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.WholeSeries));
Assert.That(createdMetricAlertConfig1.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(createdMetricAlertConfig1.AlertScope.TopNGroupInScope, Is.Null);
Assert.That(createdMetricAlertConfig1.AlertConditions, Is.Not.Null);
Assert.That(createdMetricAlertConfig1.AlertConditions.MetricBoundaryCondition, Is.Not.Null);
Assert.That(createdMetricAlertConfig1.AlertConditions.MetricBoundaryCondition.Direction, Is.EqualTo(BoundaryDirection.Down));
Assert.That(createdMetricAlertConfig1.AlertConditions.MetricBoundaryCondition.UpperBound, Is.Null);
Assert.That(createdMetricAlertConfig1.AlertConditions.MetricBoundaryCondition.LowerBound, Is.EqualTo(10.0));
Assert.That(createdMetricAlertConfig1.AlertConditions.MetricBoundaryCondition.CompanionMetricId, Is.Null);
Assert.That(createdMetricAlertConfig1.AlertConditions.MetricBoundaryCondition.ShouldAlertIfDataPointMissing, Is.False);
Assert.That(createdMetricAlertConfig1.AlertConditions.MetricBoundaryCondition.MeasureType, Is.EqualTo(BoundaryMeasureType.Value));
Assert.That(createdMetricAlertConfig1.AlertConditions.SeverityCondition, Is.Null);
Assert.That(createdMetricAlertConfig1.AlertSnoozeCondition, Is.Null);
Assert.That(createdMetricAlertConfig1.UseDetectionResultToFilterAnomalies, Is.False);
}
public async Task CreateAndGetAlertConfigurationWithOptionalSingleMetricConfigurationMembers()
{
MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
await using DisposableDataFeed disposableDataFeed = await CreateTempDataFeedAsync(adminClient);
string metricId = disposableDataFeed.DataFeed.MetricIds[TempDataFeedMetricName];
await using DisposableDetectionConfiguration disposableDetectionConfig = await CreateTempDetectionConfigurationAsync(adminClient, metricId);
string hookName0 = Recording.GenerateAlphaNumericId("hook");
string hookName1 = Recording.GenerateAlphaNumericId("hook");
var hookToCreate0 = new EmailNotificationHook(hookName0);
var hookToCreate1 = new EmailNotificationHook(hookName1);
hookToCreate0.EmailsToAlert.Add("*****@*****.**");
hookToCreate1.EmailsToAlert.Add("*****@*****.**");
await using var disposableHook0 = await DisposableNotificationHook.CreateHookAsync(adminClient, hookToCreate0);
await using var disposableHook1 = await DisposableNotificationHook.CreateHookAsync(adminClient, hookToCreate1);
var detectionConfigId = disposableDetectionConfig.Configuration.Id;
var scope = MetricAnomalyAlertScope.CreateScopeForWholeSeries();
var metricAlertConfig = new MetricAlertConfiguration(detectionConfigId, scope)
{
AlertSnoozeCondition = new MetricAnomalyAlertSnoozeCondition(12, SnoozeScope.Series, true),
AlertConditions = new MetricAnomalyAlertConditions()
{
MetricBoundaryCondition = new MetricBoundaryCondition(BoundaryDirection.Both)
{
UpperBound = 20.0,
LowerBound = 10.0,
CompanionMetricId = metricId,
ShouldAlertIfDataPointMissing = true,
MeasureType = BoundaryMeasureType.Mean
},
SeverityCondition = new SeverityCondition(AnomalySeverity.Low, AnomalySeverity.Medium)
}
};
string configName = Recording.GenerateAlphaNumericId("config");
var description = "This hook was created to test the .NET client.";
var configToCreate = new AnomalyAlertConfiguration()
{
Name = configName,
IdsOfHooksToAlert = { disposableHook0.Hook.Id, disposableHook1.Hook.Id },
MetricAlertConfigurations = { metricAlertConfig },
Description = description
};
await using var disposableConfig = await DisposableAlertConfiguration.CreateAlertConfigurationAsync(adminClient, configToCreate);
AnomalyAlertConfiguration createdConfig = disposableConfig.Configuration;
Assert.That(createdConfig.Id, Is.Not.Null.And.Not.Empty);
Assert.That(createdConfig.Name, Is.EqualTo(configName));
Assert.That(createdConfig.Description, Is.EqualTo(description));
Assert.That(createdConfig.CrossMetricsOperator, Is.Null);
Assert.That(createdConfig.IdsOfHooksToAlert.Count, Is.EqualTo(2));
Assert.That(createdConfig.IdsOfHooksToAlert.Contains(disposableHook0.Hook.Id));
Assert.That(createdConfig.IdsOfHooksToAlert.Contains(disposableHook1.Hook.Id));
Assert.That(createdConfig.DimensionsToSplitAlert, Is.Not.Null.And.Empty);
Assert.That(createdConfig.MetricAlertConfigurations, Is.Not.Null);
MetricAlertConfiguration createdMetricAlertConfig = createdConfig.MetricAlertConfigurations.Single();
Assert.That(createdMetricAlertConfig.DetectionConfigurationId, Is.EqualTo(detectionConfigId));
Assert.That(createdMetricAlertConfig.AlertScope, Is.Not.Null);
Assert.That(createdMetricAlertConfig.AlertScope.ScopeType, Is.EqualTo(MetricAnomalyAlertScopeType.WholeSeries));
Assert.That(createdMetricAlertConfig.AlertScope.SeriesGroupInScope, Is.Null);
Assert.That(createdMetricAlertConfig.AlertScope.TopNGroupInScope, Is.Null);
Assert.That(createdMetricAlertConfig.AlertConditions, Is.Not.Null);
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition, Is.Not.Null);
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition.Direction, Is.EqualTo(BoundaryDirection.Both));
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition.UpperBound, Is.EqualTo(20.0));
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition.LowerBound, Is.EqualTo(10.0));
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition.CompanionMetricId, Is.EqualTo(metricId));
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition.ShouldAlertIfDataPointMissing, Is.True);
Assert.That(createdMetricAlertConfig.AlertConditions.MetricBoundaryCondition.MeasureType, Is.EqualTo(BoundaryMeasureType.Mean));
Assert.That(createdMetricAlertConfig.AlertConditions.SeverityCondition, Is.Not.Null);
Assert.That(createdMetricAlertConfig.AlertConditions.SeverityCondition.MinimumAlertSeverity, Is.EqualTo(AnomalySeverity.Low));
Assert.That(createdMetricAlertConfig.AlertConditions.SeverityCondition.MaximumAlertSeverity, Is.EqualTo(AnomalySeverity.Medium));
Assert.That(createdMetricAlertConfig.AlertSnoozeCondition, Is.Not.Null);
Assert.That(createdMetricAlertConfig.AlertSnoozeCondition.AutoSnooze, Is.EqualTo(12));
Assert.That(createdMetricAlertConfig.AlertSnoozeCondition.SnoozeScope, Is.EqualTo(SnoozeScope.Series));
Assert.That(createdMetricAlertConfig.AlertSnoozeCondition.IsOnlyForSuccessive, Is.True);
Assert.That(createdMetricAlertConfig.UseDetectionResultToFilterAnomalies, Is.False);
}
