-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Azure monitor and log analytics integration (#22)
* Added diagnostic settings resource and related configuration. * Added end to end tests for diagnostic settings. * Added docs for diagnostic settings and log analytics integration. * Fixed compile error in e2e pgsql test.
- Loading branch information
1 parent
493d7f4
commit 3e9dd57
Showing
11 changed files
with
334 additions
and
13 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| package e2e_tests | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/Azure/azure-sdk-for-go/sdk/azidentity" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/operationalinsights/armoperationalinsights" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources" | ||
| "github.com/gruntwork-io/terratest/modules/random" | ||
| "github.com/gruntwork-io/terratest/modules/terraform" | ||
| test_structure "github.com/gruntwork-io/terratest/modules/test-structure" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| type TestDiagnosticSettingsExternalResources struct { | ||
| ResourceGroup armresources.ResourceGroup | ||
| LogAnalyticsWorkspace armoperationalinsights.Workspace | ||
| } | ||
|
|
||
| /* | ||
| * Creates resources which are "external" to the az-backup module, and models | ||
| * what would be backed up in a real scenario. | ||
| */ | ||
| func setupExternalResourcesForDiagnosticSettingsTest(t *testing.T, credential *azidentity.ClientSecretCredential, subscriptionID string, vault_name string, vault_location string) *TestDiagnosticSettingsExternalResources { | ||
| resourceGroupName := fmt.Sprintf("rg-nhsbackup-%s-external", vault_name) | ||
| resourceGroup := CreateResourceGroup(t, credential, subscriptionID, resourceGroupName, vault_location) | ||
|
|
||
| logAnalyticsWorkspaceName := fmt.Sprintf("law-%s-external", strings.ToLower(vault_name)) | ||
| logAnalyticsWorkspace := CreateLogAnalyticsWorkspace(t, credential, subscriptionID, resourceGroupName, logAnalyticsWorkspaceName, vault_location) | ||
|
|
||
| externalResources := &TestDiagnosticSettingsExternalResources{ | ||
| ResourceGroup: resourceGroup, | ||
| LogAnalyticsWorkspace: logAnalyticsWorkspace, | ||
| } | ||
|
|
||
| return externalResources | ||
| } | ||
|
|
||
| /* | ||
| * TestDiagnosticSettings tests the configuration of the backup vaults diagnostics settings and ensures they | ||
| * integrate with an external log analytics workspace. | ||
| */ | ||
| func TestDiagnosticSettings(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| environment := GetEnvironmentConfiguration(t) | ||
| credential := GetAzureCredential(t, environment) | ||
|
|
||
| vaultName := random.UniqueId() | ||
| vaultLocation := "uksouth" | ||
| vaultRedundancy := "LocallyRedundant" | ||
| resourceGroupName := fmt.Sprintf("rg-nhsbackup-%s", vaultName) | ||
| backupVaultName := fmt.Sprintf("bvault-%s", vaultName) | ||
|
|
||
| externalResources := setupExternalResourcesForDiagnosticSettingsTest(t, credential, environment.SubscriptionID, vaultName, vaultLocation) | ||
|
|
||
| // Teardown stage | ||
| // ... | ||
|
|
||
| defer test_structure.RunTestStage(t, "teardown", func() { | ||
| terraformOptions := test_structure.LoadTerraformOptions(t, environment.TerraformFolder) | ||
|
|
||
| terraform.Destroy(t, terraformOptions) | ||
|
|
||
| DeleteResourceGroup(t, credential, environment.SubscriptionID, *externalResources.ResourceGroup.Name) | ||
| }) | ||
|
|
||
| // Setup stage | ||
| // ... | ||
|
|
||
| test_structure.RunTestStage(t, "setup", func() { | ||
| terraformOptions := &terraform.Options{ | ||
| TerraformDir: environment.TerraformFolder, | ||
|
|
||
| Vars: map[string]interface{}{ | ||
| "vault_name": vaultName, | ||
| "vault_location": vaultLocation, | ||
| "vault_redundancy": vaultRedundancy, | ||
| "log_analytics_workspace_id": *externalResources.LogAnalyticsWorkspace.ID, | ||
| }, | ||
|
|
||
| BackendConfig: map[string]interface{}{ | ||
| "resource_group_name": environment.TerraformStateResourceGroup, | ||
| "storage_account_name": environment.TerraformStateStorageAccount, | ||
| "container_name": environment.TerraformStateContainer, | ||
| "key": vaultName + ".tfstate", | ||
| }, | ||
| } | ||
|
|
||
| // Save options for later test stages | ||
| test_structure.SaveTerraformOptions(t, environment.TerraformFolder, terraformOptions) | ||
|
|
||
| terraform.InitAndApply(t, terraformOptions) | ||
| }) | ||
|
|
||
| // Validate stage | ||
| // ... | ||
|
|
||
| test_structure.RunTestStage(t, "validate", func() { | ||
| // An array of log categories that we expect to be enabled for the diagnostic settings | ||
| expectedLogCategories := []string{ | ||
| "AddonAzureBackupJobs", | ||
| "AddonAzureBackupPolicy", | ||
| "AddonAzureBackupProtectedInstance", | ||
| "CoreAzureBackup", | ||
| } | ||
|
|
||
| // An array of metrics that we expect to be enabled for the diagnostic settings | ||
| expectedMetricCategories := []string{ | ||
| "Health", | ||
| } | ||
|
|
||
| backupVault := GetBackupVault(t, credential, environment.SubscriptionID, resourceGroupName, backupVaultName) | ||
| diagnosticSettings := GetDiagnosticSettings(t, credential, *backupVault.ID, *backupVault.Name) | ||
|
|
||
| assert.Equal(t, len(diagnosticSettings.Properties.Logs), len(expectedLogCategories), "Expected to find %2 log categories in diagnostic settings", len(expectedLogCategories)) | ||
| assert.Equal(t, len(diagnosticSettings.Properties.Metrics), len(expectedMetricCategories), "Expected to find %2 metric categories in diagnostic settings", len(expectedMetricCategories)) | ||
|
|
||
| for _, expectedCategory := range expectedLogCategories { | ||
| found := false | ||
| for _, log := range diagnosticSettings.Properties.Logs { | ||
| if *log.Category == expectedCategory { | ||
| found = true | ||
| break | ||
| } | ||
| } | ||
| assert.True(t, found, "Expected log category %s not found in diagnostic settings", expectedCategory) | ||
| } | ||
|
|
||
| for _, expectedCategory := range expectedMetricCategories { | ||
| found := false | ||
| for _, metric := range diagnosticSettings.Properties.Metrics { | ||
| if *metric.Category == expectedCategory { | ||
| found = true | ||
| break | ||
| } | ||
| } | ||
| assert.True(t, found, "Expected metric category %s not found in diagnostic settings", expectedCategory) | ||
| } | ||
| }) | ||
| } |
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
Oops, something went wrong.