Supported Storage size scale-up

Author: Yoichi Kawasaki

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+## 0.6.0 - 2018-05-13
+- Support Storage Size Scale Change
+- Restrict Alert Metric to Accept: only "cpu_percent" for vCore scale change, only "storage_percent"|"storage_used"|"storage_limit" for Storage size scale change
+- Change Webhook timeout to PT10M (10 minutes)
+
+## 0.5.0 - 2018-04-29
+- Initial Release
+- Support vCore Scale Change

README.md

@@ -1,23 +1,38 @@
 # azure-database-scaler
 Event driven Azure Logic App & Functions App that scale-up or scale-down the capacity of your Azure database service instance (Currently only vCore # is supported)
 
-Targets Azure Databases to scale in this project:
+### Targets Azure Databases to scale in this project:
 - [Azure Database for MySQL](https://azure.microsoft.com/en-us/services/mysql/)
 - [Azure Database for PostgreSQL](https://azure.microsoft.com/en-us/services/postgresql/)
 
-What to scale up/down?
+### What to scale up/down?
 - vCores ([What is vCore?](https://docs.microsoft.com/en-us/azure/mysql/concepts-pricing-tiers#compute-generations-vcores-and-memory))
+- Storage Size ([What is Storage size?](https://docs.microsoft.com/en-us/azure/mysql/concepts-pricing-tiers#storage))
 
-How to scale up/down?
-- azure-database-scaler starts scaling-up or scaling-down the number of vCore when it is triggered by Azure Monitor Metric Alerts (Alerts providers must be either `Microsoft.DBforMySQL` or `Microsoft.DBforPostgreSQL`)
+### How to scale up/down?
+- azure-database-scaler starts changing vCore capacity or Storage size when it was triggered by Azure Monitor Metric Alerts (Alerts providers must be either `Microsoft.DBforMySQL` or `Microsoft.DBforPostgreSQL`)
 - azure-database-scaler scale-up or scale-down the number of vCore within the same database tier & the same compute generations (Gen4 / Gen5) of your instance in the way like:
     - Basic Tier: 1 <-> 2
     - General Purpose Tier: 2 <-> 4 <-> 8 <-> 16 <-> 32
     - Memory Optimized Tier: 2 <-> 4 <-> 8 <-> 16 <-> 32
-- azure-database-scaler scale-up the number of vCore when Alert Operator of triggering Alerts is either `GreaterThan` or `GreaterThanOrEqual`
-- azure-database-scaler scale-down the number of vCore when Alert Operator of triggering Alerts is either `LessThan` or `LessThanOrEqual`
+- azure-database-scaler only scale-up the Storage size (Not scale-down supported). It can increase the Storage size by the amount of `StorageScaleupSize`(GB) parameter value to specify in [project config file](scripts/project.conf) for each scale-up action triggered by Azure Monitor Metric Alerts until the Storage size reaches `MaxStorageScaleLimit`(GB) parameter value to specify in [project config file](scripts/project.conf). `MaxStorageScaleLimit`(GB) should be within the follwoing storage size range:
+    - Basic Tier: 5 GB to 1 TB (1024 GB)
+    - General Purpose Tier: 5 GB to 2 TB (2048 GB)
+    - Memory Optimized Tier: 5 GB to 2 TB (2048 GB)
 
-Architecture:
+### Alert Metrics, Alert Operator, and Actions
+
+|Alert Metric|Metric display name | Operators to match | Action |
+|---|---|---|---|
+|`cpu_percent`|CPU percent| `GreaterThan` or `GreaterThanOrEqual` | scale-up vCore capacity|
+|`cpu_percent`|CPU percent| `LessThan` or `LessThanOrEqual` | scale-down vCore capacity|
+|`storage_percent`|Storage percent| `GreaterThan` or `GreaterThanOrEqual` | scale-up Storage size|
+|`storage_used`|Storage used| `GreaterThan` or `GreaterThanOrEqual` | scale-up Storage size|
+|`storage_limit`|Storage limit| `GreaterThan` or `GreaterThanOrEqual` | scale-up Storage size|
+
+For the detail on the supported metrics, please see [supported metrics for Azure Database for MySQL](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-supported-metrics#microsoftdbformysqlservers) or [supported metrics for Azure Database for PostgreSQL](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-supported-metrics#microsoftdbforpostgresqlservers)
+
+### Architecture:
 ![](images/architecture-overview.png)
 
 Relevant Services:
@@ -29,10 +44,7 @@ Relevant Services:
 - [Azure Monitor Alerts (New)](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-overview-unified-alerts)
 - [Slack (for notification)](https://slack.com)
 
-## How to deploy the scaler app
+## Documents
 - [How to deploy the database scaler app](./docs/HOW-TO-DEPLOY-APP.md)
-
-## How to setup Azure Metric Monitor for Autoscaling
-- [[Classic Metric Alert] How to setup Azure Monitor Metric Alerts](./docs/HOW-TO-SETUP-ALERTS.md)
-- \[New Metric Alert\] How to setup Azure Monitor Metric Alerts
+- [How to setup Azure Monitor Metric Alerts for Autoscaling(Classic Metric Alert)](./docs/HOW-TO-SETUP-ALERTS.md)
 

docs/HOW-TO-DEPLOY-APP.md

@@ -71,9 +71,16 @@ LogicAppName="<Logic App Name>"
 # Storage Account for the App
 StorageAccountName="<Storage Account Name>"
 
-# Database Admin/Login User in Azure Database Services (MySQL/PostgreSQL)
+# Azure Database Services (MySQL/PostgreSQL) Info
+DatabaseLocation="<Azure Region on which you deployed your MySQL/PostgreSQL>"
+DatabaseResourceGroup="<Resource Group Name of your Azure Database Services>"
+DatabaseAccountName="<Database Account Name of Azure Database Services>"
 DatabaseAdminUser="<Database Admin/Login User Name in your Azure Database service>"
 DatabaseAdminPassword="<Database Admin User Password in your Azure Database service>"
+
+# Threshold for Alert
+MaxStorageScaleLimit="<Max Storage Scale Limit Size in GB>"
+StorageScaleupSize="<Storage Scaleup Size for Each scaleup action in GB>"
 ```
 [NOTE] Your Functions App, LogicApp, and Storage Account names must be unique within Azure.
 

docs/HOW-TO-SETUP-ALERTS.md

@@ -2,3 +2,6 @@
 
 
 ![](../images/alert-configuration-steps.png)
+
+For more detail on the Azure Monitor Metric Alert setup, please see the following page:
+- [Use the Azure portal to set up alerts on metrics for Azure Database for MySQL](https://docs.microsoft.com/en-us/azure/mysql/howto-alert-on-metric)

functions/common/Define.csx

@@ -0,0 +1,19 @@
+public static class Define
+{
+	public const string resourceNamespace_MySQL = "Microsoft.DBforMySQL";
+	public const string resourceNamespace_PostgreSQL = "Microsoft.DBforPostgreSQL";
+	public const string metric_CPU_Percent = "cpu_percent";	
+	public const string metric_Storage_Percent = "storage_percent";
+	public const string metric_Storage_Used = "storage_used";
+	public const string metric_Storage_Limit = "storage_limit";	
+	public const string ApiVersion = "2017-12-01";
+	public const string dbTier_basic = "Basic";
+	public const string dbTier_generalPurpose = "GeneralPurpose";
+	public const string dbTier_memoryOptimized = "MemoryOptimized";
+	public static int[] vcore_scaleModel_basic = { 1, 2 };
+	public static int[] vcore_scaleModel_generalPurpose = { 2, 4, 8, 16, 32 };
+	public static int[] vcore_scaleModel_memoryOptimized = { 2, 4, 8, 16, 32 };
+	public static int[] storageRange_basic = { 5, 1024 };  //GB
+	public static int[] storageRange_generalPurpose = { 5, 2048 };  //GB
+	public static int[] storageRange_memoryOptimized = { 5, 2048 };  //GB
+}

functions/common/Model.csx

@@ -0,0 +1,10 @@
+public class InternalRequest
+{
+    public string CallbackUrl { get; set; }
+	public string Region { get; set; }
+	public string AlertMetric { get; set; }
+	public string AlertOperator { get; set; }
+	public string ResourceGroup { get; set; }
+	public string ResourceProviderNamespace { get; set; }
+	public string DbName {get;set;}
+ }