format variables.tf

update readme

Update Readme.md

Update README.md

Update README.md

Redesigned README.md

provide clarity regarding resourceIds and scaling dimensions

update README; remove comments

Update README.md and azure simple variables

added attributes section to README.md

Author: TechnicallyWilliams

infra/modules/providers/azure/app-monitoring/README.md

@@ -1,45 +1,71 @@
 # Azure Monitor
 
-This custom Terraform based `app-monitoring` module is recommended for monitoring Azure Resources externally servicing an App service (ex. App Service Plan, App Gateway, VM, etc.). For monitoring the `metrics` emitted at the App Service level, Azure Monitor relies on application insights. The `app-insights` module can be found here.
-
-This module can be used by Cobalt Templates in order to map configurable `alert criteria` to individual Azure Resources offered by the Azure Monitor Service for monitoring. Monitored `alert criteria` comes in two forms, `metrics` and `logs`. This module introduces monitoring for `metrics` only. As a result, this module offers configurable `metric alert criteria`. How `metric alert criteria` is configured depends on the type of predefined metrics offered by the particular Azure Resource being referenced for monitoring. (ex. The App Service Plan Resource offers 'CpuMonitoring' as a configurable `metric`.)
+This Terraform based `app-monitoring` module grants templates the ability to define and assign `alert criteria` to "Azure Resources" using Microsoft's _**Azure Monitor**_ service. `alert criteria` is conditional logic that targets a list of one or more "Azure Resources" for the purposes of monitoring their behavior. `alert criteria` comes in two forms, `metrics` and `logs`. This module introduces `metrics` based monitoring only. As a result, `alert criteria` in the context of this module is refered to as `metric alert criteria`. The way `metric alert criteria` is configured depends entirely on the `metrics` options offered by the "Azure Resources" selected for monitoring. (ex. The App Service Plan resource offers 'CpuMonitoring' as a configurable `metric`.)
 
 In addition to the `metric alert criteria`, this module introduces a configurable `action group` that when paired with `metric alert criteria` can be configured to trigger events like e-mail notifications.
 
-#### More on Azure Monitoring
+#### _More on Azure Monitoring_
 
-"Azure Monitor maximizes the availability and performance of your applications by delivering a comprehensive solution for collecting, analyzing, and acting on telemetry from your cloud and on-premises environments. ..All data collected by Azure Monitor fits into one of two fundamental types, metrics and logs. Metrics are numerical values that describe some aspect of a system at a particular point in time. They are lightweight and capable of supporting near real-time scenarios. Logs contain different kinds of data organized into records with different sets of properties for each type." - Source: [Azure Monitor Overview](https://docs.microsoft.com/en-us/azure/azure-monitor/overview)
+> "Azure Monitor maximizes the availability and performance of your applications by delivering a comprehensive solution for collecting, analyzing, and acting on telemetry from your cloud and on-premises environments.
+> All data collected by Azure Monitor fits into one of two fundamental types, metrics and logs. Metrics are numerical values that describe some aspect of a system at a particular point in time. They are lightweight and capable of supporting near real-time scenarios. Logs contain different kinds of data organized into records with different sets of properties for each type." - Source: Microsoft's [Azure Monitor Service Overview](https://docs.microsoft.com/en-us/azure/azure-monitor/overview)
 
-The list of `metrics` available for configuration entirely depends on the Azure Resource chosen to be monitored. Please visit [Supported Metrics](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported) for a complete list of metrics supported by the Azure Monitor service.
+This module deploys the _**Azure Monitor**_ service in order to offer visibility into the behavior of your deployed "Azure Resources". This module is recommended for `metrics` based monitoring of any "Azure Resource" deployed alongside App Services (ex. App Service Plan, App Gateway, VM, etc.). The list of `metrics` available for configuration depends entirely on the Azure Resource chosen to be monitored. For more information on how `metrics` work, please visit Microsoft's [alerts-metric-overview](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/alerts-metric-overview) documentation.
 
-#### More on Terraform Resources
+For monitoring of an App Service, the [app-insights](../app-insights) module is instead recommended. The [app-insights](../app-insights) module leverages an _**Azure Monitor**_ service called [application insights](https://www.terraform.io/docs/providers/azurerm/r/application_insights.html).
 
-Terraform resources used to define the `app-monitoring` module include the following:
+## Characteristics
 
-- `azurerm_monitor_metric_alert` - https://www.terraform.io/docs/providers/azurerm/r/monitor_metric_alert.html
+An instance of the `app-monitoring` module deploys the _**Azure Monitor**_ service in order to provide templates with the following:
 
-- `azurerm_monitor_action_group` - https://www.terraform.io/docs/providers/azurerm/r/monitor_action_group.html
+- Ability to deploy Azure Monitor within a single resource group.
 
-## Characteristics
+- Ability to deploy Azure Monitor with a single set of configurable `metric alert criteria` targeting one or more Azure resources.
 
-A Terraform module in Cobalt that leverages the "Azure Monitor Service" in order to provide Cobalt Templates with the following characteristics:
+- Ability to deploy Azure Monitor with a single set of configurable `metric alert criteria` tied to a single `action group`.
 
-- Ability to deploy Azure Monitor in the same resource group as the Service Plan.
+## Definition
 
-- Ability to deploy Azure Monitor with configurable `metric alert criteria` targeting Azure resources.
+App Monitoring definition example:
 
-- Ability to deploy Azure Monitor with configurable `metric alert criteria` tied to a single action group.
+```terraform
+resource "azurerm_monitor_action_group" "appmonitoring" {
+  count               = "${var.action_group_email_receiver == "" ? 0 : 1}"
+  name                = "${var.action_group_name}"
+  resource_group_name = "${var.resource_group_name}"
+  short_name          = "${var.action_group_short_name}"
+}
 
-## Default Behavior
+resource "azurerm_monitor_metric_alert" "appmonitoring" {
+  count               = "${var.action_group_email_receiver == "" ? 0 : 1}"
+  name                = "${var.metric_alert_name}"
+  resource_group_name = "${azurerm_monitor_action_group.appmonitoring.resource_group_name}"
+  scopes              = ["${var.resource_ids}"]
+
+  criteria {
+    metric_namespace = "${var.metric_alert_criteria_namespace}"
+    metric_name      = "${var.metric_alert_criteria_name}"
+    aggregation      = "${var.metric_alert_criteria_aggregation}"
+    operator         = "${var.metric_alert_criteria_operator}"
+    threshold        = "${var.metric_alert_criteria_threshold}"
+  }
+
+  action {
+    action_group_id = "${azurerm_monitor_action_group.appmonitoring.id}"
+  }
+}
+```
 
-The `metric alert criteria` is configured to deploy "CPU Resource Monitoring" for an App Service Plan Resource that emits alerts at configurable CPU thresholds. The `action group` is configured to send e-mails upon every alert. If a template does not provide an e-mail, this module deploys nothing.
+Terraform resources used to define the `app-monitoring` module include the following:
 
-### Module Usage
+- [azurerm_monitor_metric_alert](https://www.terraform.io/docs/providers/azurerm/r/monitor_metric_alert.html)
 
-- Service Plan Module : infra/modules/providers/azure/service-plan
-- App Monitoring Module :  infra/modules/providers/azure/app-monitoring
+- [azurerm_monitor_action_group](https://www.terraform.io/docs/providers/azurerm/r/monitor_action_group.html)
 
-```
+## Usage
+
+App Monitoring usage example:
+
+```terraform
 variable "resource_group_name" {
   value = "test-rg"
 }
@@ -56,7 +82,7 @@ module "service_plan" {
 
 module "app_monitoring" {
   source                            = "../../modules/providers/azure/app-monitoring"
-  resource_group_name               = "${azurerm_resource_group.svcplan.name}"
+  resource_group_name               = "${module.service_plan.resource_group_name}"
   resource_ids                      = ["${module.service_plan.app_service_plan_id}"]
   action_group_name                 = "${var.action_group_name}"
   action_group_email_receiver       = "${var.action_group_email_receiver}"
@@ -66,15 +92,39 @@ module "app_monitoring" {
   metric_alert_criteria_aggregation = "${var.metric_alert_criteria_aggregation}"
   metric_alert_criteria_operator    = "${var.metric_alert_criteria_operator}"
   metric_alert_criteria_threshold   = "${var.metric_alert_criteria_threshold}"
+  scaling_values                    = "${var.scaling_values}"
 }
 ```
 
-## Output
+#### Configuring `resource_ids`
 
-Once the deployments are completed successfully, the output for the current module will be in the format mentioned below:
+Please visit _**Azure Monitor's**_ [monitoring at scale](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/alerts-metric-overview#monitoring-at-scale-using-metric-alerts-in-azure-monitor.) page for more information on choosing multiple "Azure Resources".
 
-```
-Outputs:
+- Resource IDs can either be a list of VM IDs or a single Azure Resource ID.
+
+#### Configuring `metric alert criteria`
+
+Please visit _**Azure Monitor's**_ [Supported Metrics](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported) page for a complete list of supported metrics per "Azure Resource".
+
+1. View the list of 'metrics' offered by the namespace of your chosen "Azure Resource".
+2. Choose a metric.
+3. Define the metric's criteria (i.e. Conditional logic being applied to an "Azure Resource".)
+4. Apply that criteria to your chosen or newly created template.
+
+#### Configuring `action group`
+
+Please visit _**Azure Monitor's**_ [action-groups](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/action-groups) page for more information on e-mail action groups.
+
+1. Choose an appropriate e-mail address to receive alert notifications.
+2. Choose an appropriate name for the 'action group' that will hold the e-mail address. (ex. "E-mail Alert Group")
+3. Apply the e-mail address and name to your chosen or newly created template.
+
+## Argument Reference
+
+Supported arguments for this module are available in [variables.tf](variables.tf).
+
+## Attributes Reference
+
+The following attributes are exported:
 
-rule_resource_id = xxxx5ba9-f5xx-xx94-93xx-xxxx0d40xxxx
-```
+- `rule_resource_id`: The ID of the metric alert.

infra/modules/providers/azure/app-monitoring/main.tf

@@ -1,3 +1,8 @@
+locals {
+  scaling_name     = "Instance"
+  scaling_operator = "Include"
+}
+
 resource "azurerm_monitor_action_group" "appmonitoring" {
   count               = "${var.action_group_email_receiver == "" ? 0 : 1}"
   name                = "${var.action_group_name}"
@@ -11,7 +16,7 @@ resource "azurerm_monitor_action_group" "appmonitoring" {
 }
 
 resource "azurerm_monitor_metric_alert" "appmonitoring" {
-  count               = "${var.action_group_email_receiver  == "" ? 0 : 1}"
+  count               = "${var.action_group_email_receiver == "" ? 0 : 1}"
   name                = "${var.metric_alert_name}"
   resource_group_name = "${azurerm_monitor_action_group.appmonitoring.resource_group_name}"
   scopes              = ["${var.resource_ids}"]
@@ -24,9 +29,9 @@ resource "azurerm_monitor_metric_alert" "appmonitoring" {
     threshold        = "${var.metric_alert_criteria_threshold}"
 
     dimension {
-      name     = "Instance"
-      operator = "Include"
-      values   = ["*"]
+      name     = "${local.scaling_name}"
+      operator = "${local.scaling_operator}"
+      values   = "${var.scaling_values}"
     }
   }
 

infra/modules/providers/azure/app-monitoring/variables.tf

@@ -61,3 +61,8 @@ variable "metric_alert_criteria_threshold" {
   description = "The criteria threshold value that activates the metric alert."
   type        = "string"
 }
+
+variable "scaling_values" {
+  description = "App instance names made available from app service plan scaling options."
+  type        = "list"
+}

infra/templates/azure-simple/appdev.tf

@@ -53,4 +53,5 @@ module "app_monitoring" {
   metric_alert_criteria_aggregation = "${var.metric_alert_criteria_aggregation}"
   metric_alert_criteria_operator    = "${var.metric_alert_criteria_operator}"
   metric_alert_criteria_threshold   = "${var.metric_alert_criteria_threshold}"
+  scaling_values                    = "${var.scaling_values}"
 }

infra/templates/azure-simple/variables.tf

@@ -52,11 +52,11 @@ variable "action_group_name" {
   default     = "Simple Default Action Group"
 }
 
-variable "action_group_email_receiver" {	
-  description = "The e-mail receiver for an alert rule resource."	
-  type        = "string"	
-  default     = ""	
-}	
+variable "action_group_email_receiver" {
+  description = "The e-mail receiver for an alert rule resource."
+  type        = "string"
+  default     = ""
+}
 
 variable "metric_alert_criteria_namespace" {
   description = "A monitored resource namespace with configurable metric alert criteria."
@@ -91,7 +91,13 @@ variable "metric_alert_criteria_operator" {
 variable "metric_alert_criteria_threshold" {
   description = "The criteria threshold value that activates the metric alert."
   type        = "string"
-  default     = "10"
+  default     = "50"
+}
+
+variable "scaling_values" {
+  description = "Targets app instances made available from app service plan scaling options."
+  type        = "list"
+  default     = ["*"]
 }
 
 # App Service